*
* Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and * a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at * scale. *
** This reference is intended to be used with the Amazon Web Services Systems Manager User * Guide. To get started, see Setting up Amazon * Web Services Systems Manager. *
** Related resources *
** For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide. *
** For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the * Systems Manager Automation runbook reference . *
** For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference . *
** For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide * and the Systems Manager Incident * Manager API Reference . *
** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AWSSimpleSystemsManagementClientBuilder#defaultClient()} */ @Deprecated public AWSSimpleSystemsManagementClient() { this(DefaultAWSCredentialsProviderChain.getInstance(), configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on Amazon SSM. A credentials provider chain will be used that * searches for credentials in this order: *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientConfiguration * The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings, * retry counts, etc.). * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AWSSimpleSystemsManagementClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSSimpleSystemsManagementClient(ClientConfiguration clientConfiguration) { this(DefaultAWSCredentialsProviderChain.getInstance(), clientConfiguration); } /** * Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @deprecated use {@link AWSSimpleSystemsManagementClientBuilder#withCredentials(AWSCredentialsProvider)} for * example: * {@code AWSSimpleSystemsManagementClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();} */ @Deprecated public AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials) { this(awsCredentials, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials and * client configuration options. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings, * retry counts, etc.). * @deprecated use {@link AWSSimpleSystemsManagementClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSSimpleSystemsManagementClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) { super(clientConfiguration); this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials); this.advancedConfig = AdvancedConfig.EMPTY; init(); } /** * Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials * provider. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @deprecated use {@link AWSSimpleSystemsManagementClientBuilder#withCredentials(AWSCredentialsProvider)} */ @Deprecated public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials * provider and client configuration options. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings, * retry counts, etc.). * @deprecated use {@link AWSSimpleSystemsManagementClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSSimpleSystemsManagementClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, null); } /** * Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials * provider, client configuration options, and request metric collector. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings, * retry counts, etc.). * @param requestMetricCollector * optional request metric collector * @deprecated use {@link AWSSimpleSystemsManagementClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSSimpleSystemsManagementClientBuilder#withClientConfiguration(ClientConfiguration)} and * {@link AWSSimpleSystemsManagementClientBuilder#withMetricsCollector(RequestMetricCollector)} */ @Deprecated public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) { super(clientConfiguration, requestMetricCollector); this.awsCredentialsProvider = awsCredentialsProvider; this.advancedConfig = AdvancedConfig.EMPTY; init(); } public static AWSSimpleSystemsManagementClientBuilder builder() { return AWSSimpleSystemsManagementClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on Amazon SSM using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSSimpleSystemsManagementClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on Amazon SSM using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSSimpleSystemsManagementClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("https://ssm.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/simplesystemsmanagement/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/simplesystemsmanagement/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to * your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. * Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. * Each tag consists of a key and an optional value, both of which you define. For example, you could define a set * of tags for your account's managed nodes that helps you track each node's owner and stack level. For example: *
*
* Key=Owner,Value=DbAdmin
*
* Key=Owner,Value=SysAdmin
*
* Key=Owner,Value=Dev
*
* Key=Stack,Value=Production
*
* Key=Stack,Value=Pre-Production
*
* Key=Stack,Value=Test
*
* Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags. *
** We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent * set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based * on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of * characters. *
** For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources * in the Amazon EC2 User Guide. *
* * @param addTagsToResourceRequest * @return Result of the AddTagsToResource operation returned by the service. * @throws InvalidResourceTypeException * The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance * must be a registered managed node. * @throws InvalidResourceIdException * The resource ID isn't valid. Verify that you entered the correct ID and try again. * @throws InternalServerErrorException * An error occurred on the server side. * @throws TooManyTagsErrorException * TheTargets parameter includes too many tags. Remove one or more tags and try the command
* again.
* @throws TooManyUpdatesException
* There are concurrent updates for a resource that supports one update at a time.
* @sample AWSSimpleSystemsManagement.AddTagsToResource
* @see AWS API
* Documentation
*/
@Override
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request) {
request = beforeClientExecution(request);
return executeAddTagsToResource(request);
}
@SdkInternalApi
final AddTagsToResourceResult executeAddTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) {
ExecutionContext executionContext = createExecutionContext(addTagsToResourceRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident * Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web * Services Systems Manager. *
* * @param associateOpsItemRelatedItemRequest * @return Result of the AssociateOpsItemRelatedItem operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws OpsItemNotFoundException * The specified OpsItem ID doesn't exist. Verify the ID and try again. * @throws OpsItemLimitExceededException * The request caused OpsItems to exceed one or more quotas. * @throws OpsItemInvalidParameterException * A specified parameter argument isn't valid. Verify the available arguments and try again. * @throws OpsItemRelatedItemAlreadyExistsException * The Amazon Resource Name (ARN) is already associated with the OpsItem. * @sample AWSSimpleSystemsManagement.AssociateOpsItemRelatedItem * @see AWS API Documentation */ @Override public AssociateOpsItemRelatedItemResult associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest request) { request = beforeClientExecution(request); return executeAssociateOpsItemRelatedItem(request); } @SdkInternalApi final AssociateOpsItemRelatedItemResult executeAssociateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest) { ExecutionContext executionContext = createExecutionContext(associateOpsItemRelatedItemRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be * terminated and the underlying process stopped. *
* * @param cancelCommandRequest * @return Result of the CancelCommand operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidCommandIdException * The specified command ID isn't valid. Verify the ID and try again. * @throws InvalidInstanceIdException * The following problems can cause this exception: ** You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't * already starting running. Tasks already in progress will continue to completion. *
* * @param cancelMaintenanceWindowExecutionRequest * @return Result of the CancelMaintenanceWindowExecution operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws DoesNotExistException * Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, * doesn't exist. *
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @sample AWSSimpleSystemsManagement.CancelMaintenanceWindowExecution
* @see AWS API Documentation
*/
@Override
public CancelMaintenanceWindowExecutionResult cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest request) {
request = beforeClientExecution(request);
return executeCancelMaintenanceWindowExecution(request);
}
@SdkInternalApi
final CancelMaintenanceWindowExecutionResult executeCancelMaintenanceWindowExecution(
CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest) {
ExecutionContext executionContext = createExecutionContext(cancelMaintenanceWindowExecutionRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or
* virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager
* makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when
* installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing
* on-premises machines using Systems Manager, see Setting
* up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager
* User Guide.
*
* Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are
* configured for Systems Manager are all called managed nodes.
*
* A State Manager association defines the state that you want to maintain on your managed nodes. For example, an
* association can specify that anti-virus software must be installed and running on your managed nodes, or that
* certain ports must be closed. For static targets, the association specifies a schedule for when the configuration
* is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services
* autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration
* when new managed nodes are added to the group. The association also specifies actions to take when applying the
* configuration. For example, an association for anti-virus software might run once a day. If the software isn't
* installed, then State Manager installs it. If the software is installed, but the service isn't running, then the
* association might instruct State Manager to start the service.
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed * nodes or targets. *
** When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems * Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as * specified. *
** If you associate a document with a managed node that already has an associated document, the system returns the * AssociationAlreadyExists exception. *
* * @param createAssociationBatchRequest * @return Result of the CreateAssociationBatch operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @throws InvalidDocumentVersionException * The document version isn't valid or doesn't exist. * @throws InvalidInstanceIdException * The following problems can cause this exception: ** You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems * Manager performs on your managed nodes. For more information about SSM documents, including information about * supported schemas, features, and syntax, see Amazon Web Services * Systems Manager Documents in the Amazon Web Services Systems Manager User Guide. *
* * @param createDocumentRequest * @return Result of the CreateDocument operation returned by the service. * @throws DocumentAlreadyExistsException * The specified document already exists. * @throws MaxDocumentSizeExceededException * The size limit of a document is 64 KB. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDocumentContentException * The content for the document isn't valid. * @throws DocumentLimitExceededException * You can have at most 500 active SSM documents. * @throws InvalidDocumentSchemaVersionException * The version of the document schema isn't supported. * @sample AWSSimpleSystemsManagement.CreateDocument * @see AWS API * Documentation */ @Override public CreateDocumentResult createDocument(CreateDocumentRequest request) { request = beforeClientExecution(request); return executeCreateDocument(request); } @SdkInternalApi final CreateDocumentResult executeCreateDocument(CreateDocumentRequest createDocumentRequest) { ExecutionContext executionContext = createExecutionContext(createDocumentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Creates a new maintenance window. *
*
* The value you specify for Duration determines the specific end time for the maintenance window based
* on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
* number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the
* duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window
* tasks can start after 5 PM.
*
* For information about resource quotas in Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.CreateMaintenanceWindow
* @see AWS
* API Documentation
*/
@Override
public CreateMaintenanceWindowResult createMaintenanceWindow(CreateMaintenanceWindowRequest request) {
request = beforeClientExecution(request);
return executeCreateMaintenanceWindow(request);
}
@SdkInternalApi
final CreateMaintenanceWindowResult executeCreateMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest) {
ExecutionContext executionContext = createExecutionContext(createMaintenanceWindowRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem.
* For more information, see Set up OpsCenter in
* the Amazon Web Services Systems Manager User Guide.
*
* Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate,
* and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
* more information, see Amazon Web Services Systems
* Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
*
* If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API
* operation to specify information about the new application, including the application type.
*
* Creates a patch baseline.
*
* For information about valid key-value pairs in PatchFilters for each supported operating system
* type, see PatchFilter.
*
* For information about resource quotas in Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.CreatePatchBaseline
* @see AWS API
* Documentation
*/
@Override
public CreatePatchBaselineResult createPatchBaseline(CreatePatchBaselineRequest request) {
request = beforeClientExecution(request);
return executeCreatePatchBaseline(request);
}
@SdkInternalApi
final CreatePatchBaselineResult executeCreatePatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest) {
ExecutionContext executionContext = createExecutionContext(createPatchBaselineRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems
* Manager offers two types of resource data sync:
* You can configure Systems Manager Inventory to use the
* You can configure Systems Manager Explorer to use the
* A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is
* completed, the system continuously syncs data. To check the status of a sync, use the
* ListResourceDataSync.
*
* By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to
* ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a
* restrictive bucket policy.
*
* Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no
* longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You
* must manually de-register managed nodes.
*
* Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified
* managed node. If you created the association by using the
* When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change
* the configuration state of a managed node after you disassociate a document, you must create a new document with
* the desired configuration and associate it with the node.
* SyncToDestination and SyncFromSource.
* SyncToDestination type to synchronize
* Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3)
* bucket. For more information, see Configuring
* resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.
* SyncFromSource type to synchronize operational
* work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon
* S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon
* Web Services Regions or EntireOrganization by using Organizations. For more information, see Setting up
* Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services
* Systems Manager User Guide.
* Targets parameter, then you must delete
* the association by using the association ID.
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the * document. *
** Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed * nodes that are associated with the document. *
* * @param deleteDocumentRequest * @return Result of the DeleteDocument operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @throws InvalidDocumentOperationException * You attempted to delete a document while it is still shared. You must stop sharing the document before * you can delete it. * @throws AssociatedInstancesException * You must disassociate a document from all managed nodes before you can delete it. * @sample AWSSimpleSystemsManagement.DeleteDocument * @see AWS API * Documentation */ @Override public DeleteDocumentResult deleteDocument(DeleteDocumentRequest request) { request = beforeClientExecution(request); return executeDeleteDocument(request); } @SdkInternalApi final DeleteDocumentResult executeDeleteDocument(DeleteDocumentRequest deleteDocumentRequest) { ExecutionContext executionContext = createExecutionContext(deleteDocumentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory * type is also referred to as deleting a custom inventory schema. *
* * @param deleteInventoryRequest * @return Result of the DeleteInventory operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidTypeNameException * The parameter type name isn't valid. * @throws InvalidOptionException * The delete inventory option specified isn't valid. Verify the option and try again. * @throws InvalidDeleteInventoryParametersException * One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and * try again. * @throws InvalidInventoryRequestException * The request isn't valid. * @sample AWSSimpleSystemsManagement.DeleteInventory * @see AWS API * Documentation */ @Override public DeleteInventoryResult deleteInventory(DeleteInventoryRequest request) { request = beforeClientExecution(request); return executeDeleteInventory(request); } @SdkInternalApi final DeleteInventoryResult executeDeleteInventory(DeleteInventoryRequest deleteInventoryRequest) { ExecutionContext executionContext = createExecutionContext(deleteInventoryRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Deletes a maintenance window. *
* * @param deleteMaintenanceWindowRequest * @return Result of the DeleteMaintenanceWindow operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.DeleteMaintenanceWindow * @see AWS * API Documentation */ @Override public DeleteMaintenanceWindowResult deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request) { request = beforeClientExecution(request); return executeDeleteMaintenanceWindow(request); } @SdkInternalApi final DeleteMaintenanceWindowResult executeDeleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest) { ExecutionContext executionContext = createExecutionContext(deleteMaintenanceWindowRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Delete OpsMetadata related to an application. *
* * @param deleteOpsMetadataRequest * @return Result of the DeleteOpsMetadata operation returned by the service. * @throws OpsMetadataNotFoundException * The OpsMetadata object doesn't exist. * @throws OpsMetadataInvalidArgumentException * One of the arguments passed is invalid. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.DeleteOpsMetadata * @see AWS API * Documentation */ @Override public DeleteOpsMetadataResult deleteOpsMetadata(DeleteOpsMetadataRequest request) { request = beforeClientExecution(request); return executeDeleteOpsMetadata(request); } @SdkInternalApi final DeleteOpsMetadataResult executeDeleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest) { ExecutionContext executionContext = createExecutionContext(deleteOpsMetadataRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a * parameter with the same name. *
* * @param deleteParameterRequest * @return Result of the DeleteParameter operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws ParameterNotFoundException * The parameter couldn't be found. Verify the name and try again. * @sample AWSSimpleSystemsManagement.DeleteParameter * @see AWS API * Documentation */ @Override public DeleteParameterResult deleteParameter(DeleteParameterRequest request) { request = beforeClientExecution(request); return executeDeleteParameter(request); } @SdkInternalApi final DeleteParameterResult executeDeleteParameter(DeleteParameterRequest deleteParameterRequest) { ExecutionContext executionContext = createExecutionContext(deleteParameterRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with * the same name. *
* * @param deleteParametersRequest * @return Result of the DeleteParameters operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.DeleteParameters * @see AWS API * Documentation */ @Override public DeleteParametersResult deleteParameters(DeleteParametersRequest request) { request = beforeClientExecution(request); return executeDeleteParameters(request); } @SdkInternalApi final DeleteParametersResult executeDeleteParameters(DeleteParametersRequest deleteParametersRequest) { ExecutionContext executionContext = createExecutionContext(deleteParametersRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Deletes a patch baseline. *
* * @param deletePatchBaselineRequest * @return Result of the DeletePatchBaseline operation returned by the service. * @throws ResourceInUseException * Error returned if an attempt is made to delete a patch baseline that is registered for a patch group. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.DeletePatchBaseline * @see AWS API * Documentation */ @Override public DeletePatchBaselineResult deletePatchBaseline(DeletePatchBaselineRequest request) { request = beforeClientExecution(request); return executeDeletePatchBaseline(request); } @SdkInternalApi final DeletePatchBaselineResult executeDeletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest) { ExecutionContext executionContext = createExecutionContext(deletePatchBaselineRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes * are no longer synced to or from the target. Deleting a sync configuration doesn't delete data. *
* * @param deleteResourceDataSyncRequest * @return Result of the DeleteResourceDataSync operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws ResourceDataSyncNotFoundException * The specified sync name wasn't found. * @throws ResourceDataSyncInvalidConfigurationException * The specified sync configuration is invalid. * @sample AWSSimpleSystemsManagement.DeleteResourceDataSync * @see AWS API * Documentation */ @Override public DeleteResourceDataSyncResult deleteResourceDataSync(DeleteResourceDataSyncRequest request) { request = beforeClientExecution(request); return executeDeleteResourceDataSync(request); } @SdkInternalApi final DeleteResourceDataSyncResult executeDeleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest) { ExecutionContext executionContext = createExecutionContext(deleteResourceDataSyncRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an
* Amazon Web Services account) that can manage your Systems Manager resources. Currently, OpsItemGroup
* is the only resource that supports Systems Manager resource policies. The resource policy for
* OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational
* work items (OpsItems).
*
* Removes the server or virtual machine from the list of registered servers. You can reregister the node again at * any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first. *
* * @param deregisterManagedInstanceRequest * @return Result of the DeregisterManagedInstance operation returned by the service. * @throws InvalidInstanceIdException * The following problems can cause this exception: ** You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Removes a patch group from a patch baseline. *
* * @param deregisterPatchBaselineForPatchGroupRequest * @return Result of the DeregisterPatchBaselineForPatchGroup operation returned by the service. * @throws InvalidResourceIdException * The resource ID isn't valid. Verify that you entered the correct ID and try again. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.DeregisterPatchBaselineForPatchGroup * @see AWS API Documentation */ @Override public DeregisterPatchBaselineForPatchGroupResult deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest request) { request = beforeClientExecution(request); return executeDeregisterPatchBaselineForPatchGroup(request); } @SdkInternalApi final DeregisterPatchBaselineForPatchGroupResult executeDeregisterPatchBaselineForPatchGroup( DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest) { ExecutionContext executionContext = createExecutionContext(deregisterPatchBaselineForPatchGroupRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Removes a target from a maintenance window. *
* * @param deregisterTargetFromMaintenanceWindowRequest * @return Result of the DeregisterTargetFromMaintenanceWindow operation returned by the service. * @throws DoesNotExistException * Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, * doesn't exist. *
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @throws TargetInUseException
* You specified the
* Removes a task from a maintenance window.
* Safe option for the DeregisterTargetFromMaintenanceWindow operation, but
* the target is still referenced in a task.
* @sample AWSSimpleSystemsManagement.DeregisterTargetFromMaintenanceWindow
* @see AWS API Documentation
*/
@Override
public DeregisterTargetFromMaintenanceWindowResult deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest request) {
request = beforeClientExecution(request);
return executeDeregisterTargetFromMaintenanceWindow(request);
}
@SdkInternalApi
final DeregisterTargetFromMaintenanceWindowResult executeDeregisterTargetFromMaintenanceWindow(
DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest) {
ExecutionContext executionContext = createExecutionContext(deregisterTargetFromMaintenanceWindowRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.DeregisterTaskFromMaintenanceWindow
* @see AWS API Documentation
*/
@Override
public DeregisterTaskFromMaintenanceWindowResult deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest request) {
request = beforeClientExecution(request);
return executeDeregisterTaskFromMaintenanceWindow(request);
}
@SdkInternalApi
final DeregisterTaskFromMaintenanceWindowResult executeDeregisterTaskFromMaintenanceWindow(
DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest) {
ExecutionContext executionContext = createExecutionContext(deregisterTaskFromMaintenanceWindowRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Describes details about the activation, such as the date and time the activation was created, its expiration
* date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the
* number of nodes registered by using this activation.
*
* Describes the association for the specified target or managed node. If you created the association by using the
* Targets parameter, then you must retrieve the association by using the association ID.
* $LATEST parameter to view the latest version of
* the association.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @throws InvalidDocumentException
* The specified SSM document doesn't exist.
* @throws InvalidInstanceIdException
* The following problems can cause this exception:
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Views information about a specific execution of a specific association. *
* * @param describeAssociationExecutionTargetsRequest * @return Result of the DescribeAssociationExecutionTargets operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws AssociationDoesNotExistException * The specified association doesn't exist. * @throws InvalidNextTokenException * The specified token isn't valid. * @throws AssociationExecutionDoesNotExistException * The specified execution ID doesn't exist. Verify the ID number and try again. * @sample AWSSimpleSystemsManagement.DescribeAssociationExecutionTargets * @see AWS API Documentation */ @Override public DescribeAssociationExecutionTargetsResult describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest request) { request = beforeClientExecution(request); return executeDescribeAssociationExecutionTargets(request); } @SdkInternalApi final DescribeAssociationExecutionTargetsResult executeDescribeAssociationExecutionTargets( DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest) { ExecutionContext executionContext = createExecutionContext(describeAssociationExecutionTargetsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Views all executions for a specific association ID. *
* * @param describeAssociationExecutionsRequest * @return Result of the DescribeAssociationExecutions operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws AssociationDoesNotExistException * The specified association doesn't exist. * @throws InvalidNextTokenException * The specified token isn't valid. * @sample AWSSimpleSystemsManagement.DescribeAssociationExecutions * @see AWS API Documentation */ @Override public DescribeAssociationExecutionsResult describeAssociationExecutions(DescribeAssociationExecutionsRequest request) { request = beforeClientExecution(request); return executeDescribeAssociationExecutions(request); } @SdkInternalApi final DescribeAssociationExecutionsResult executeDescribeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest) { ExecutionContext executionContext = createExecutionContext(describeAssociationExecutionsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Provides details about all active and terminated Automation executions. *
* * @param describeAutomationExecutionsRequest * @return Result of the DescribeAutomationExecutions operation returned by the service. * @throws InvalidFilterKeyException * The specified key isn't valid. * @throws InvalidFilterValueException * The filter value isn't valid. Verify the value and try again. * @throws InvalidNextTokenException * The specified token isn't valid. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.DescribeAutomationExecutions * @see AWS API Documentation */ @Override public DescribeAutomationExecutionsResult describeAutomationExecutions(DescribeAutomationExecutionsRequest request) { request = beforeClientExecution(request); return executeDescribeAutomationExecutions(request); } @SdkInternalApi final DescribeAutomationExecutionsResult executeDescribeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest) { ExecutionContext executionContext = createExecutionContext(describeAutomationExecutionsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Information about all active and terminated step executions in an Automation workflow. *
* * @param describeAutomationStepExecutionsRequest * @return Result of the DescribeAutomationStepExecutions operation returned by the service. * @throws AutomationExecutionNotFoundException * There is no automation execution information for the requested automation execution ID. * @throws InvalidNextTokenException * The specified token isn't valid. * @throws InvalidFilterKeyException * The specified key isn't valid. * @throws InvalidFilterValueException * The filter value isn't valid. Verify the value and try again. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.DescribeAutomationStepExecutions * @see AWS API Documentation */ @Override public DescribeAutomationStepExecutionsResult describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest request) { request = beforeClientExecution(request); return executeDescribeAutomationStepExecutions(request); } @SdkInternalApi final DescribeAutomationStepExecutionsResult executeDescribeAutomationStepExecutions( DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest) { ExecutionContext executionContext = createExecutionContext(describeAutomationStepExecutionsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Lists all patches eligible to be included in a patch baseline. *
* * @param describeAvailablePatchesRequest * @return Result of the DescribeAvailablePatches operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.DescribeAvailablePatches * @see AWS * API Documentation */ @Override public DescribeAvailablePatchesResult describeAvailablePatches(DescribeAvailablePatchesRequest request) { request = beforeClientExecution(request); return executeDescribeAvailablePatches(request); } @SdkInternalApi final DescribeAvailablePatchesResult executeDescribeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest) { ExecutionContext executionContext = createExecutionContext(describeAvailablePatchesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Describes the specified Amazon Web Services Systems Manager document (SSM document). *
* * @param describeDocumentRequest * @return Result of the DescribeDocument operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @throws InvalidDocumentVersionException * The document version isn't valid or doesn't exist. * @sample AWSSimpleSystemsManagement.DescribeDocument * @see AWS API * Documentation */ @Override public DescribeDocumentResult describeDocument(DescribeDocumentRequest request) { request = beforeClientExecution(request); return executeDescribeDocument(request); } @SdkInternalApi final DescribeDocumentResult executeDescribeDocument(DescribeDocumentRequest describeDocumentRequest) { ExecutionContext executionContext = createExecutionContext(describeDocumentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the * document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's * Amazon Web Services account ID) or publicly (All). *
* * @param describeDocumentPermissionRequest * @return Result of the DescribeDocumentPermission operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @throws InvalidNextTokenException * The specified token isn't valid. * @throws InvalidPermissionTypeException * The permission type isn't supported. Share is the only supported permission type. * @throws InvalidDocumentOperationException * You attempted to delete a document while it is still shared. You must stop sharing the document before * you can delete it. * @sample AWSSimpleSystemsManagement.DescribeDocumentPermission * @see AWS * API Documentation */ @Override public DescribeDocumentPermissionResult describeDocumentPermission(DescribeDocumentPermissionRequest request) { request = beforeClientExecution(request); return executeDescribeDocumentPermission(request); } @SdkInternalApi final DescribeDocumentPermissionResult executeDescribeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest) { ExecutionContext executionContext = createExecutionContext(describeDocumentPermissionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* All associations for the managed node(s). *
* * @param describeEffectiveInstanceAssociationsRequest * @return Result of the DescribeEffectiveInstanceAssociations operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidInstanceIdException * The following problems can cause this exception: ** You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. * Applies to patch baselines for Windows only. *
* * @param describeEffectivePatchesForPatchBaselineRequest * @return Result of the DescribeEffectivePatchesForPatchBaseline operation returned by the service. * @throws InvalidResourceIdException * The resource ID isn't valid. Verify that you entered the correct ID and try again. * @throws DoesNotExistException * Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, * doesn't exist. *
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws UnsupportedOperatingSystemException
* The operating systems you specified isn't supported, or the operation isn't supported for the operating
* system.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.DescribeEffectivePatchesForPatchBaseline
* @see AWS API Documentation
*/
@Override
public DescribeEffectivePatchesForPatchBaselineResult describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest request) {
request = beforeClientExecution(request);
return executeDescribeEffectivePatchesForPatchBaseline(request);
}
@SdkInternalApi
final DescribeEffectivePatchesForPatchBaselineResult executeDescribeEffectivePatchesForPatchBaseline(
DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest) {
ExecutionContext executionContext = createExecutionContext(describeEffectivePatchesForPatchBaselineRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* The status of the associations for the managed node(s).
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent * version, association status, and IP address. This operation does not return information for nodes that are either * Stopped or Terminated. *
** If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't * specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or * a node that you don't own, you receive an error. *
*
* The IamRole field returned for this API operation is the Identity and Access Management (IAM) role
* assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Retrieves the high-level patch state of one or more managed nodes. *
* * @param describeInstancePatchStatesRequest * @return Result of the DescribeInstancePatchStates operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidNextTokenException * The specified token isn't valid. * @sample AWSSimpleSystemsManagement.DescribeInstancePatchStates * @see AWS API Documentation */ @Override public DescribeInstancePatchStatesResult describeInstancePatchStates(DescribeInstancePatchStatesRequest request) { request = beforeClientExecution(request); return executeDescribeInstancePatchStates(request); } @SdkInternalApi final DescribeInstancePatchStatesResult executeDescribeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest) { ExecutionContext executionContext = createExecutionContext(describeInstancePatchStatesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Retrieves the high-level patch state for the managed nodes in the specified patch group. *
* * @param describeInstancePatchStatesForPatchGroupRequest * @return Result of the DescribeInstancePatchStatesForPatchGroup operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidFilterException * The filter name isn't valid. Verify the you entered the correct name and try again. * @throws InvalidNextTokenException * The specified token isn't valid. * @sample AWSSimpleSystemsManagement.DescribeInstancePatchStatesForPatchGroup * @see AWS API Documentation */ @Override public DescribeInstancePatchStatesForPatchGroupResult describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest request) { request = beforeClientExecution(request); return executeDescribeInstancePatchStatesForPatchGroup(request); } @SdkInternalApi final DescribeInstancePatchStatesForPatchGroupResult executeDescribeInstancePatchStatesForPatchGroup( DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest) { ExecutionContext executionContext = createExecutionContext(describeInstancePatchStatesForPatchGroupRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Retrieves information about the patches on the specified managed node and their state relative to the patch * baseline being used for the node. *
* * @param describeInstancePatchesRequest * @return Result of the DescribeInstancePatches operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidInstanceIdException * The following problems can cause this exception: ** You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Describes a specific delete inventory operation. *
* * @param describeInventoryDeletionsRequest * @return Result of the DescribeInventoryDeletions operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDeletionIdException * The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again. * @throws InvalidNextTokenException * The specified token isn't valid. * @sample AWSSimpleSystemsManagement.DescribeInventoryDeletions * @see AWS * API Documentation */ @Override public DescribeInventoryDeletionsResult describeInventoryDeletions(DescribeInventoryDeletionsRequest request) { request = beforeClientExecution(request); return executeDescribeInventoryDeletions(request); } @SdkInternalApi final DescribeInventoryDeletionsResult executeDescribeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest) { ExecutionContext executionContext = createExecutionContext(describeInventoryDeletionsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance * window execution. *
* * @param describeMaintenanceWindowExecutionTaskInvocationsRequest * @return Result of the DescribeMaintenanceWindowExecutionTaskInvocations operation returned by the service. * @throws DoesNotExistException * Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, * doesn't exist. *
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.DescribeMaintenanceWindowExecutionTaskInvocations
* @see AWS API Documentation
*/
@Override
public DescribeMaintenanceWindowExecutionTaskInvocationsResult describeMaintenanceWindowExecutionTaskInvocations(
DescribeMaintenanceWindowExecutionTaskInvocationsRequest request) {
request = beforeClientExecution(request);
return executeDescribeMaintenanceWindowExecutionTaskInvocations(request);
}
@SdkInternalApi
final DescribeMaintenanceWindowExecutionTaskInvocationsResult executeDescribeMaintenanceWindowExecutionTaskInvocations(
DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest) {
ExecutionContext executionContext = createExecutionContext(describeMaintenanceWindowExecutionTaskInvocationsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* For a given maintenance window execution, lists the tasks that were run.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.DescribeMaintenanceWindowExecutionTasks
* @see AWS API Documentation
*/
@Override
public DescribeMaintenanceWindowExecutionTasksResult describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest request) {
request = beforeClientExecution(request);
return executeDescribeMaintenanceWindowExecutionTasks(request);
}
@SdkInternalApi
final DescribeMaintenanceWindowExecutionTasksResult executeDescribeMaintenanceWindowExecutionTasks(
DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest) {
ExecutionContext executionContext = createExecutionContext(describeMaintenanceWindowExecutionTasksRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Lists the executions of a maintenance window. This includes information about when the maintenance window was
* scheduled to be active, and information about tasks registered and run with the maintenance window.
*
* Retrieves information about upcoming executions of a maintenance window.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @sample AWSSimpleSystemsManagement.DescribeMaintenanceWindowSchedule
* @see AWS API Documentation
*/
@Override
public DescribeMaintenanceWindowScheduleResult describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest request) {
request = beforeClientExecution(request);
return executeDescribeMaintenanceWindowSchedule(request);
}
@SdkInternalApi
final DescribeMaintenanceWindowScheduleResult executeDescribeMaintenanceWindowSchedule(
DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest) {
ExecutionContext executionContext = createExecutionContext(describeMaintenanceWindowScheduleRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Lists the targets registered with the maintenance window.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.DescribeMaintenanceWindowTargets
* @see AWS API Documentation
*/
@Override
public DescribeMaintenanceWindowTargetsResult describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest request) {
request = beforeClientExecution(request);
return executeDescribeMaintenanceWindowTargets(request);
}
@SdkInternalApi
final DescribeMaintenanceWindowTargetsResult executeDescribeMaintenanceWindowTargets(
DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest) {
ExecutionContext executionContext = createExecutionContext(describeMaintenanceWindowTargetsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Lists the tasks in a maintenance window.
*
* For maintenance window tasks without a specified target, you can't supply values for --max-errors
* and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may
* be reported in the response to this command. These values don't affect the running of your task and can be
* ignored.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.DescribeMaintenanceWindowTasks
* @see AWS API Documentation
*/
@Override
public DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest request) {
request = beforeClientExecution(request);
return executeDescribeMaintenanceWindowTasks(request);
}
@SdkInternalApi
final DescribeMaintenanceWindowTasksResult executeDescribeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest) {
ExecutionContext executionContext = createExecutionContext(describeMaintenanceWindowTasksRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Retrieves the maintenance windows in an Amazon Web Services account.
*
* Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
*
* Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of
* OpsItems. For more information, see Set up OpsCenter in
* the Amazon Web Services Systems Manager User Guide.
*
* Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate,
* and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
* more information, see OpsCenter in the Amazon
* Web Services Systems Manager User Guide.
*
* Get information about a parameter.
*
* Request results are returned on a best-effort basis. If you specify
* If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
* alias the parameter uses to reference KMS. Otherwise,
* Lists the patch baselines in your Amazon Web Services account.
*
* Returns high-level aggregated patch compliance state information for a patch group.
*
* Lists all patch groups that have been registered with patch baselines.
*
* Lists the properties of available patches organized by product, product family, classification, severity, and
* other properties of available patches. You can use the reported properties in the filters you specify in requests
* for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches,
* and DescribePatchBaselines.
*
* The following section lists the properties that can be used in filters for each major operating system type:
*
* Valid properties:
* Valid properties:
* Valid properties:
* Valid properties:
* Valid properties:
* Valid properties:
* Valid properties:
* Valid properties:
* Valid properties:
* Valid properties:
* Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
* days.
*
* Deletes the association between an OpsItem and a related item. For example, this API operation can delete an
* Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems
* Manager.
*
* Get detailed information about a particular Automation execution.
*
* Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
* If you specify a time,
* If you specify more than one calendar in a request, the command returns the status of
* For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon
* Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
*
* Returns detailed information about command execution for an invocation or plugin.
*
* MaxResults in the request, the
* response includes information up to the limit specified. The number of items returned, however, can be between
* zero and the value of MaxResults. If the service reaches an internal limit while processing the
* results, it stops the operation and returns the matching values up to that point and a NextToken.
* You can specify the NextToken in a subsequent call to get the next set of results.
* DescribeParameters retrieves whatever the
* original key alias was referencing.
*
*
*
* @param describePatchPropertiesRequest
* @return Result of the DescribePatchProperties operation returned by the service.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.DescribePatchProperties
* @see AWS
* API Documentation
*/
@Override
public DescribePatchPropertiesResult describePatchProperties(DescribePatchPropertiesRequest request) {
request = beforeClientExecution(request);
return executeDescribePatchProperties(request);
}
@SdkInternalApi
final DescribePatchPropertiesResult executeDescribePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest) {
ExecutionContext executionContext = createExecutionContext(describePatchPropertiesRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestPRODUCT | CLASSIFICATION | SEVERITY
* PRODUCT | CLASSIFICATION | SEVERITY
* PRODUCT | CLASSIFICATION | SEVERITY
* PRODUCT | PRIORITY
* PRODUCT | CLASSIFICATION
* PRODUCT | CLASSIFICATION | SEVERITY
* PRODUCT | CLASSIFICATION | SEVERITY
* PRODUCT | CLASSIFICATION | SEVERITY
* PRODUCT | PRIORITY
* PRODUCT | PRODUCT_FAMILY | CLASSIFICATION |
* MSRC_SEVERITY
* GetCalendarState returns the state of the calendar at that specific time, and
* returns the next time that the change calendar state will transition. If you don't specify a time,
* GetCalendarState uses the current time. Change Calendar entries have two possible states:
* OPEN or CLOSED.
* OPEN only if
* all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
* CLOSED.
* DocumentType
* property.
* @throws UnsupportedCalendarException
* The calendar entry contained in the specified SSM document isn't supported.
* @sample AWSSimpleSystemsManagement.GetCalendarState
* @see AWS API
* Documentation
*/
@Override
public GetCalendarStateResult getCalendarState(GetCalendarStateRequest request) {
request = beforeClientExecution(request);
return executeGetCalendarState(request);
}
@SdkInternalApi
final GetCalendarStateResult executeGetCalendarState(GetCalendarStateRequest getCalendarStateRequest) {
ExecutionContext executionContext = createExecutionContext(getCalendarStateRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestGetCommandInvocation only gives the execution status of a plugin in a document. To get the command
* execution status on a specific managed node, use ListCommandInvocations. To get the command execution
* status across managed nodes, use ListCommands.
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready * to receive Session Manager connections. *
* * @param getConnectionStatusRequest * @return Result of the GetConnectionStatus operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.GetConnectionStatus * @see AWS API * Documentation */ @Override public GetConnectionStatusResult getConnectionStatus(GetConnectionStatusRequest request) { request = beforeClientExecution(request); return executeGetConnectionStatus(request); } @SdkInternalApi final GetConnectionStatusResult executeGetConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest) { ExecutionContext executionContext = createExecutionContext(getConnectionStatusRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default * patch baselines. For example, you can create a default patch baseline for each operating system. *
** If you don't specify an operating system value, the default patch baseline for Windows is returned. *
* * @param getDefaultPatchBaselineRequest * @return Result of the GetDefaultPatchBaseline operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.GetDefaultPatchBaseline * @see AWS * API Documentation */ @Override public GetDefaultPatchBaselineResult getDefaultPatchBaseline(GetDefaultPatchBaselineRequest request) { request = beforeClientExecution(request); return executeGetDefaultPatchBaseline(request); } @SdkInternalApi final GetDefaultPatchBaselineResult executeGetDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest) { ExecutionContext executionContext = createExecutionContext(getDefaultPatchBaselineRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the
* AWS-RunPatchBaseline Systems Manager document (SSM document).
*
* If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your
* local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the
* Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems
* Manager, with an SSM document that enables you to target a managed node with a script or command. For example,
* run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript
* document.
*
* Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document). *
* * @param getDocumentRequest * @return Result of the GetDocument operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @throws InvalidDocumentVersionException * The document version isn't valid or doesn't exist. * @sample AWSSimpleSystemsManagement.GetDocument * @see AWS API * Documentation */ @Override public GetDocumentResult getDocument(GetDocumentRequest request) { request = beforeClientExecution(request); return executeGetDocument(request); } @SdkInternalApi final GetDocumentResult executeGetDocument(GetDocumentRequest getDocumentRequest) { ExecutionContext executionContext = createExecutionContext(getDocumentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Query inventory information. This includes managed node status, such as Stopped or
* Terminated.
*
AWS:Application or AWS:InstanceInformation.
* @throws InvalidResultAttributeException
* The specified inventory item result attribute isn't valid.
* @sample AWSSimpleSystemsManagement.GetInventory
* @see AWS API
* Documentation
*/
@Override
public GetInventoryResult getInventory(GetInventoryRequest request) {
request = beforeClientExecution(request);
return executeGetInventory(request);
}
@SdkInternalApi
final GetInventoryResult executeGetInventory(GetInventoryRequest getInventoryRequest) {
ExecutionContext executionContext = createExecutionContext(getInventoryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Return a list of inventory type names for the account, or return a list of attribute names for a specific * Inventory item type. *
* * @param getInventorySchemaRequest * @return Result of the GetInventorySchema operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidTypeNameException * The parameter type name isn't valid. * @throws InvalidNextTokenException * The specified token isn't valid. * @sample AWSSimpleSystemsManagement.GetInventorySchema * @see AWS API * Documentation */ @Override public GetInventorySchemaResult getInventorySchema(GetInventorySchemaRequest request) { request = beforeClientExecution(request); return executeGetInventorySchema(request); } @SdkInternalApi final GetInventorySchemaResult executeGetInventorySchema(GetInventorySchemaRequest getInventorySchemaRequest) { ExecutionContext executionContext = createExecutionContext(getInventorySchemaRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Retrieves a maintenance window. *
* * @param getMaintenanceWindowRequest * @return Result of the GetMaintenanceWindow operation returned by the service. * @throws DoesNotExistException * Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, * doesn't exist. *
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.GetMaintenanceWindow
* @see AWS API
* Documentation
*/
@Override
public GetMaintenanceWindowResult getMaintenanceWindow(GetMaintenanceWindowRequest request) {
request = beforeClientExecution(request);
return executeGetMaintenanceWindow(request);
}
@SdkInternalApi
final GetMaintenanceWindowResult executeGetMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest) {
ExecutionContext executionContext = createExecutionContext(getMaintenanceWindowRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Retrieves details about a specific a maintenance window execution.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.GetMaintenanceWindowExecution
* @see AWS API Documentation
*/
@Override
public GetMaintenanceWindowExecutionResult getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest request) {
request = beforeClientExecution(request);
return executeGetMaintenanceWindowExecution(request);
}
@SdkInternalApi
final GetMaintenanceWindowExecutionResult executeGetMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest) {
ExecutionContext executionContext = createExecutionContext(getMaintenanceWindowExecutionRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Retrieves the details about a specific task run as part of a maintenance window execution.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.GetMaintenanceWindowExecutionTask
* @see AWS API Documentation
*/
@Override
public GetMaintenanceWindowExecutionTaskResult getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest request) {
request = beforeClientExecution(request);
return executeGetMaintenanceWindowExecutionTask(request);
}
@SdkInternalApi
final GetMaintenanceWindowExecutionTaskResult executeGetMaintenanceWindowExecutionTask(
GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest) {
ExecutionContext executionContext = createExecutionContext(getMaintenanceWindowExecutionTaskRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Retrieves information about a specific task running on a specific target.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.GetMaintenanceWindowExecutionTaskInvocation
* @see AWS API Documentation
*/
@Override
public GetMaintenanceWindowExecutionTaskInvocationResult getMaintenanceWindowExecutionTaskInvocation(
GetMaintenanceWindowExecutionTaskInvocationRequest request) {
request = beforeClientExecution(request);
return executeGetMaintenanceWindowExecutionTaskInvocation(request);
}
@SdkInternalApi
final GetMaintenanceWindowExecutionTaskInvocationResult executeGetMaintenanceWindowExecutionTaskInvocation(
GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest) {
ExecutionContext executionContext = createExecutionContext(getMaintenanceWindowExecutionTaskInvocationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Retrieves the details of a maintenance window task.
*
* For maintenance window tasks without a specified target, you can't supply values for
* To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks
* command.
* --max-errors
* and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may
* be reported in the response to this command. These values don't affect the running of your task and can be
* ignored.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.GetMaintenanceWindowTask
* @see AWS
* API Documentation
*/
@Override
public GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest request) {
request = beforeClientExecution(request);
return executeGetMaintenanceWindowTask(request);
}
@SdkInternalApi
final GetMaintenanceWindowTaskResult executeGetMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest) {
ExecutionContext executionContext = createExecutionContext(getMaintenanceWindowTaskRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management
* (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in
* the Amazon Web Services Systems Manager User Guide.
*
* Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate,
* and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
* more information, see OpsCenter in the Amazon
* Web Services Systems Manager User Guide.
*
* View operational metadata related to an application in Application Manager.
*
* View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include
* information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as
* information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services
* Systems Manager Explorer.
*
* Get information about a single parameter by specifying the parameter name.
*
* To get information about more than one parameter at a time, use the GetParameters operation.
*
* Retrieves the history of all changes to a parameter.
*
* If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
* alias the parameter uses to reference KMS. Otherwise,
* Get information about one or more parameters by specifying multiple parameter names.
*
* To get information about a single parameter, you can use the GetParameter operation instead.
*
* Retrieve information about one or more parameters in a specific hierarchy.
*
* Request results are returned on a best-effort basis. If you specify
* Retrieves information about a patch baseline.
* AWS:Application or AWS:InstanceInformation.
* @sample AWSSimpleSystemsManagement.GetOpsSummary
* @see AWS API
* Documentation
*/
@Override
public GetOpsSummaryResult getOpsSummary(GetOpsSummaryRequest request) {
request = beforeClientExecution(request);
return executeGetOpsSummary(request);
}
@SdkInternalApi
final GetOpsSummaryResult executeGetOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest) {
ExecutionContext executionContext = createExecutionContext(getOpsSummaryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestGetParameterHistory retrieves whatever the
* original key alias was referencing.
* MaxResults in the request, the
* response includes information up to the limit specified. The number of items returned, however, can be between
* zero and the value of MaxResults. If the service reaches an internal limit while processing the
* results, it stops the operation and returns the matching values up to that point and a NextToken.
* You can specify the NextToken in a subsequent call to get the next set of results.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InvalidResourceIdException
* The resource ID isn't valid. Verify that you entered the correct ID and try again.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.GetPatchBaseline
* @see AWS API
* Documentation
*/
@Override
public GetPatchBaselineResult getPatchBaseline(GetPatchBaselineRequest request) {
request = beforeClientExecution(request);
return executeGetPatchBaseline(request);
}
@SdkInternalApi
final GetPatchBaselineResult executeGetPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest) {
ExecutionContext executionContext = createExecutionContext(getPatchBaselineRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Retrieves the patch baseline that should be used for the specified patch group.
*
* Returns an array of the
*
* Services map a
* Query the current service setting for the Amazon Web Services account.
*
* A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a
* parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version
* number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
*
* Parameter labels have the following requirements and restrictions.
*
* A version of a parameter can have a maximum of 10 labels.
*
* You can't attach the same label to different versions of the same parameter. For example, if version 1 has the
* label Production, then you can't attach Production to version 2.
*
* You can move a label from one version of a parameter to another.
*
* You can't create a label when you create a new parameter. You must attach a label to a specific version of a
* parameter.
*
* If you no longer want to use a parameter label, then you can either delete it or move it to a different version
* of a parameter.
*
* A label can have a maximum of 100 characters.
*
* Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
*
* Labels can't begin with a number, "
* Retrieves all versions of an association for a specific association ID.
*
* Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.
* You can limit the results to a specific State Manager association document or managed node by specifying a
* filter. State Manager is a capability of Amazon Web Services Systems Manager.
*
* An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed
* nodes. A command invocation applies to one managed node. For example, if a user runs Policy object.
* ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines
* how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
* service charges money to the account based on feature or service usage, then the Amazon Web Services service team
* might create a default setting of false. This means the user can't use this feature unless they
* change the setting to true and intentionally opt in for a paid feature.
* SettingId object to a setting value. Amazon Web Services services teams define the
* default value for a SettingId. You can't create a new SettingId, but you can overwrite
* the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the
* UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to
* change the value back to the original value defined by the Amazon Web Services service team.
*
*
*
* @param labelParameterVersionRequest
* @return Result of the LabelParameterVersion operation returned by the service.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @throws TooManyUpdatesException
* There are concurrent updates for a resource that supports one update at a time.
* @throws ParameterNotFoundException
* The parameter couldn't be found. Verify the name and try again.
* @throws ParameterVersionNotFoundException
* The specified parameter version wasn't found. Verify the parameter name and version, and try again.
* @throws ParameterVersionLabelLimitExceededException
* A parameter version can have a maximum of ten labels.
* @sample AWSSimpleSystemsManagement.LabelParameterVersion
* @see AWS API
* Documentation
*/
@Override
public LabelParameterVersionResult labelParameterVersion(LabelParameterVersionRequest request) {
request = beforeClientExecution(request);
return executeLabelParameterVersion(request);
}
@SdkInternalApi
final LabelParameterVersionResult executeLabelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest) {
ExecutionContext executionContext = createExecutionContext(labelParameterVersionRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Requestaws" or "ssm" (not case sensitive). If a label fails
* to meet these requirements, then the label isn't associated with a parameter and the system displays it in the
* list of InvalidLabels.
* SendCommand
* against three managed nodes, then a command invocation is created for each requested managed node ID.
* ListCommandInvocations provide status about command execution.
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Lists the commands requested by users of the Amazon Web Services account. *
* * @param listCommandsRequest * @return Result of the ListCommands operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidCommandIdException * The specified command ID isn't valid. Verify the ID and try again. * @throws InvalidInstanceIdException * The following problems can cause this exception: ** You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* For a specified resource ID, this API operation returns a list of compliance statuses for different resource * types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in * the filter. *
* * @param listComplianceItemsRequest * @return Result of the ListComplianceItems operation returned by the service. * @throws InvalidResourceTypeException * The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance * must be a registered managed node. * @throws InvalidResourceIdException * The resource ID isn't valid. Verify that you entered the correct ID and try again. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidFilterException * The filter name isn't valid. Verify the you entered the correct name and try again. * @throws InvalidNextTokenException * The specified token isn't valid. * @sample AWSSimpleSystemsManagement.ListComplianceItems * @see AWS API * Documentation */ @Override public ListComplianceItemsResult listComplianceItems(ListComplianceItemsRequest request) { request = beforeClientExecution(request); return executeListComplianceItems(request); } @SdkInternalApi final ListComplianceItemsResult executeListComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest) { ExecutionContext executionContext = createExecutionContext(listComplianceItemsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call * can return State Manager associations, patches, or custom compliance types according to the filter criteria that * you specify. *
* * @param listComplianceSummariesRequest * @return Result of the ListComplianceSummaries operation returned by the service. * @throws InvalidFilterException * The filter name isn't valid. Verify the you entered the correct name and try again. * @throws InvalidNextTokenException * The specified token isn't valid. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.ListComplianceSummaries * @see AWS * API Documentation */ @Override public ListComplianceSummariesResult listComplianceSummaries(ListComplianceSummariesRequest request) { request = beforeClientExecution(request); return executeListComplianceSummaries(request); } @SdkInternalApi final ListComplianceSummariesResult executeListComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest) { ExecutionContext executionContext = createExecutionContext(listComplianceSummariesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Information about approval reviews for a version of a change template in Change Manager. *
* * @param listDocumentMetadataHistoryRequest * @return Result of the ListDocumentMetadataHistory operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @throws InvalidDocumentVersionException * The document version isn't valid or doesn't exist. * @throws InvalidNextTokenException * The specified token isn't valid. * @sample AWSSimpleSystemsManagement.ListDocumentMetadataHistory * @see AWS API Documentation */ @Override public ListDocumentMetadataHistoryResult listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest request) { request = beforeClientExecution(request); return executeListDocumentMetadataHistory(request); } @SdkInternalApi final ListDocumentMetadataHistoryResult executeListDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest) { ExecutionContext executionContext = createExecutionContext(listDocumentMetadataHistoryRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* List all versions for a document. *
* * @param listDocumentVersionsRequest * @return Result of the ListDocumentVersions operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidNextTokenException * The specified token isn't valid. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @sample AWSSimpleSystemsManagement.ListDocumentVersions * @see AWS API * Documentation */ @Override public ListDocumentVersionsResult listDocumentVersions(ListDocumentVersionsRequest request) { request = beforeClientExecution(request); return executeListDocumentVersions(request); } @SdkInternalApi final ListDocumentVersionsResult executeListDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest) { ExecutionContext executionContext = createExecutionContext(listDocumentVersionsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services * Region. You can limit the results of this request by using a filter. *
* * @param listDocumentsRequest * @return Result of the ListDocuments operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidNextTokenException * The specified token isn't valid. * @throws InvalidFilterKeyException * The specified key isn't valid. * @sample AWSSimpleSystemsManagement.ListDocuments * @see AWS API * Documentation */ @Override public ListDocumentsResult listDocuments(ListDocumentsRequest request) { request = beforeClientExecution(request); return executeListDocuments(request); } @SdkInternalApi final ListDocumentsResult executeListDocuments(ListDocumentsRequest listDocumentsRequest) { ExecutionContext executionContext = createExecutionContext(listDocumentsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* A list of inventory items returned by the request. *
* * @param listInventoryEntriesRequest * @return Result of the ListInventoryEntries operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidInstanceIdException * The following problems can cause this exception: ** You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. * You can limit the results to events associated with specific OpsItems by specifying a filter. *
* * @param listOpsItemEventsRequest * @return Result of the ListOpsItemEvents operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws OpsItemNotFoundException * The specified OpsItem ID doesn't exist. Verify the ID and try again. * @throws OpsItemLimitExceededException * The request caused OpsItems to exceed one or more quotas. * @throws OpsItemInvalidParameterException * A specified parameter argument isn't valid. Verify the available arguments and try again. * @sample AWSSimpleSystemsManagement.ListOpsItemEvents * @see AWS API * Documentation */ @Override public ListOpsItemEventsResult listOpsItemEvents(ListOpsItemEventsRequest request) { request = beforeClientExecution(request); return executeListOpsItemEvents(request); } @SdkInternalApi final ListOpsItemEventsResult executeListOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest) { ExecutionContext executionContext = createExecutionContext(listOpsItemEventsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability * of Amazon Web Services Systems Manager. *
* * @param listOpsItemRelatedItemsRequest * @return Result of the ListOpsItemRelatedItems operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws OpsItemInvalidParameterException * A specified parameter argument isn't valid. Verify the available arguments and try again. * @sample AWSSimpleSystemsManagement.ListOpsItemRelatedItems * @see AWS * API Documentation */ @Override public ListOpsItemRelatedItemsResult listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest request) { request = beforeClientExecution(request); return executeListOpsItemRelatedItems(request); } @SdkInternalApi final ListOpsItemRelatedItemsResult executeListOpsItemRelatedItems(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest) { ExecutionContext executionContext = createExecutionContext(listOpsItemRelatedItemsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata * objects or blobs. *
* * @param listOpsMetadataRequest * @return Result of the ListOpsMetadata operation returned by the service. * @throws OpsMetadataInvalidArgumentException * One of the arguments passed is invalid. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.ListOpsMetadata * @see AWS API * Documentation */ @Override public ListOpsMetadataResult listOpsMetadata(ListOpsMetadataRequest request) { request = beforeClientExecution(request); return executeListOpsMetadata(request); } @SdkInternalApi final ListOpsMetadataResult executeListOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest) { ExecutionContext executionContext = createExecutionContext(listOpsMetadataRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Returns a resource-level summary count. The summary includes information about compliant and non-compliant * statuses and detailed compliance-item severity counts, according to the filter criteria you specify. *
* * @param listResourceComplianceSummariesRequest * @return Result of the ListResourceComplianceSummaries operation returned by the service. * @throws InvalidFilterException * The filter name isn't valid. Verify the you entered the correct name and try again. * @throws InvalidNextTokenException * The specified token isn't valid. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.ListResourceComplianceSummaries * @see AWS API Documentation */ @Override public ListResourceComplianceSummariesResult listResourceComplianceSummaries(ListResourceComplianceSummariesRequest request) { request = beforeClientExecution(request); return executeListResourceComplianceSummaries(request); } @SdkInternalApi final ListResourceComplianceSummariesResult executeListResourceComplianceSummaries( ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest) { ExecutionContext executionContext = createExecutionContext(listResourceComplianceSummariesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, * the last sync status, and the last time a sync successfully completed. *
*
* The number of sync configurations might be too large to return using a single call to
* ListResourceDataSync. You can limit the number of sync configurations returned by using the
* MaxResults parameter. To determine whether there are more sync configurations to list, check the
* value of NextToken in the output. If there are more sync configurations to list, you can request
* them by specifying the NextToken returned in the call to the parameter of a subsequent call.
*
* Returns a list of the tags assigned to the specified resource. *
** For information about the ID format for each supported resource type, see AddTagsToResource. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws InvalidResourceTypeException * The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance * must be a registered managed node. * @throws InvalidResourceIdException * The resource ID isn't valid. Verify that you entered the correct ID and try again. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.ListTagsForResource * @see AWS API * Documentation */ @Override public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request) { request = beforeClientExecution(request); return executeListTagsForResource(request); } @SdkInternalApi final ListTagsForResourceResult executeListTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) { ExecutionContext executionContext = createExecutionContext(listTagsForResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a * document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. * If you share a document publicly, you must specify All as the account ID. *
* * @param modifyDocumentPermissionRequest * @return Result of the ModifyDocumentPermission operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @throws InvalidPermissionTypeException * The permission type isn't supported. Share is the only supported permission type. * @throws DocumentPermissionLimitException * The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 * accounts per API operation to share a private document. ** By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to * five documents. *
*
* If you need to increase the quota for privately or publicly shared Systems Manager documents, contact
* Amazon Web Services Support.
* @throws DocumentLimitExceededException
* You can have at most 500 active SSM documents.
* @sample AWSSimpleSystemsManagement.ModifyDocumentPermission
* @see AWS
* API Documentation
*/
@Override
public ModifyDocumentPermissionResult modifyDocumentPermission(ModifyDocumentPermissionRequest request) {
request = beforeClientExecution(request);
return executeModifyDocumentPermission(request);
}
@SdkInternalApi
final ModifyDocumentPermissionResult executeModifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest) {
ExecutionContext executionContext = createExecutionContext(modifyDocumentPermissionRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Registers a compliance type and other compliance details on a designated resource. This operation lets you
* register custom compliance details with a resource. This call overwrites existing compliance information on the
* resource, so you must provide a full list of compliance items each time that you send the request.
*
* ComplianceType can be one of the following:
*
* ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
*
* ExecutionType: Specify patch, association, or Custom:
* ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.
*
* Id: The patch, association, or custom compliance ID.
*
* Title: A title.
*
* Status: The status of the compliance item. For example,
* Severity: A patch severity. For example,
* DocumentName: An SSM document name. For example,
* DocumentVersion: An SSM document version number. For example, 4.
*
* Classification: A patch classification. For example,
* PatchBaselineId: A patch baseline ID.
*
* PatchSeverity: A patch severity. For example,
* PatchState: A patch state. For example,
* PatchGroup: The name of a patch group.
*
* InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify
* the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
*
* Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it
* doesn't already exist, or updates an inventory item, if it does exist.
*
*
*
* @param putComplianceItemsRequest
* @return Result of the PutComplianceItems operation returned by the service.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @throws InvalidItemContentException
* One or more content items isn't valid.
* @throws TotalSizeLimitExceededException
* The size of inventory data has exceeded the total size limit for the resource.
* @throws ItemSizeLimitExceededException
* The inventory item size has exceeded the size limit.
* @throws ComplianceTypeCountLimitExceededException
* You specified too many custom compliance types. You can specify a maximum of 10 different types.
* @throws InvalidResourceTypeException
* The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance
* must be a registered managed node.
* @throws InvalidResourceIdException
* The resource ID isn't valid. Verify that you entered the correct ID and try again.
* @sample AWSSimpleSystemsManagement.PutComplianceItems
* @see AWS API
* Documentation
*/
@Override
public PutComplianceItemsResult putComplianceItems(PutComplianceItemsRequest request) {
request = beforeClientExecution(request);
return executePutComplianceItems(request);
}
@SdkInternalApi
final PutComplianceItemsResult executePutComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest) {
ExecutionContext executionContext = createExecutionContext(putComplianceItemsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Requeststring.
* approved for patches, or Failed
* for associations.
* Critical.
* AWS-RunPatchBaseline.
* security updates.
* Critical.
* InstancesWithFailedPatches.
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
Context attribute that you specified for the InventoryItem isn't allowed
* for this inventory type. You can only use the Context attribute with inventory types like
* AWS:ComplianceItem.
* @throws InvalidInventoryItemContextException
* You specified invalid keys or values in the Context attribute for InventoryItem
* . Verify the keys and values, and try again.
* @throws SubTypeCountLimitExceededException
* The sub-type count exceeded the limit for the inventory type.
* @sample AWSSimpleSystemsManagement.PutInventory
* @see AWS API
* Documentation
*/
@Override
public PutInventoryResult putInventory(PutInventoryRequest request) {
request = beforeClientExecution(request);
return executePutInventory(request);
}
@SdkInternalApi
final PutInventoryResult executePutInventory(PutInventoryRequest putInventoryRequest) {
ExecutionContext executionContext = createExecutionContext(putInventoryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Add a parameter to the system. *
* * @param putParameterRequest * @return Result of the PutParameter operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidKeyIdException * The query key ID isn't valid. * @throws ParameterLimitExceededException * You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more * parameters and try again. * @throws TooManyUpdatesException * There are concurrent updates for a resource that supports one update at a time. * @throws ParameterAlreadyExistsException * The parameter already exists. You can't create duplicate parameters. * @throws HierarchyLevelLimitExceededException * A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the Amazon Web Services Systems Manager User * Guide. * @throws HierarchyTypeMismatchException * Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a * parameter from aString type to a SecureString type. You must create a new,
* unique parameter.
* @throws InvalidAllowedPatternException
* The request doesn't meet the regular expression requirement.
* @throws ParameterMaxVersionLimitExceededException
* Parameter Store retains the 100 most recently created versions of a parameter. After this number of
* versions has been created, Parameter Store deletes the oldest version when a new one is created. However,
* if the oldest version has a label attached to it, Parameter Store won't delete the version and
* instead presents this error message:
*
* An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.
*
* This safeguard is to prevent parameter versions with mission critical labels assigned to them from being
* deleted. To continue creating new parameters, first move the label from the oldest version of the
* parameter to a newer one for use in your operations. For information about moving parameter labels, see
* Move a parameter label (console) or Move a parameter label (CLI) in the Amazon Web Services Systems Manager User Guide.
* @throws ParameterPatternMismatchException
* The parameter name isn't valid.
* @throws UnsupportedParameterTypeException
* The parameter type isn't supported.
* @throws PoliciesLimitExceededException
* You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.
* @throws InvalidPolicyTypeException
* The policy type isn't supported. Parameter Store supports the following policy types: Expiration,
* ExpirationNotification, and NoChangeNotification.
* @throws InvalidPolicyAttributeException
* A policy attribute or its value is invalid.
* @throws IncompatiblePolicyException
* There is a conflict in the policies specified for this parameter. You can't, for example, specify two
* Expiration policies for a parameter. Review your policies, and try again.
* @sample AWSSimpleSystemsManagement.PutParameter
* @see AWS API
* Documentation
*/
@Override
public PutParameterResult putParameter(PutParameterRequest request) {
request = beforeClientExecution(request);
return executePutParameter(request);
}
@SdkInternalApi
final PutParameterResult executePutParameter(PutParameterRequest putParameterRequest) {
ExecutionContext executionContext = createExecutionContext(putParameterRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for
* example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently,
*
* Defines the default patch baseline for the relevant operating system.
*
* To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon
* Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify
* OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource
* policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter
* operational work items (OpsItems).
* OpsItemGroup. Verify these limits and try
* again.
* @throws ResourcePolicyConflictException
* The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to
* update an obsolete policy version or when multiple requests to update a policy are sent.
* @sample AWSSimpleSystemsManagement.PutResourcePolicy
* @see AWS API
* Documentation
*/
@Override
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request) {
request = beforeClientExecution(request);
return executePutResourcePolicy(request);
}
@SdkInternalApi
final PutResourcePolicyResult executePutResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) {
ExecutionContext executionContext = createExecutionContext(putResourcePolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Requestarn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of
* pb-0574b43a65ea646ed.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.RegisterDefaultPatchBaseline
* @see AWS API Documentation
*/
@Override
public RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest request) {
request = beforeClientExecution(request);
return executeRegisterDefaultPatchBaseline(request);
}
@SdkInternalApi
final RegisterDefaultPatchBaselineResult executeRegisterDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest) {
ExecutionContext executionContext = createExecutionContext(registerDefaultPatchBaselineRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Registers a patch baseline for a patch group.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service * quotas in the Amazon Web Services General Reference. * @throws InvalidResourceIdException * The resource ID isn't valid. Verify that you entered the correct ID and try again. * @throws ResourceLimitExceededException * Error returned when the caller has exceeded the default resource quotas. For example, too many * maintenance windows or patch baselines have been created. *
*
* For information about resource quotas in Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.RegisterPatchBaselineForPatchGroup
* @see AWS API Documentation
*/
@Override
public RegisterPatchBaselineForPatchGroupResult registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest request) {
request = beforeClientExecution(request);
return executeRegisterPatchBaselineForPatchGroup(request);
}
@SdkInternalApi
final RegisterPatchBaselineForPatchGroupResult executeRegisterPatchBaselineForPatchGroup(
RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest) {
ExecutionContext executionContext = createExecutionContext(registerPatchBaselineForPatchGroupRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Registers a target with a maintenance window.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service * quotas in the Amazon Web Services General Reference. * @throws ResourceLimitExceededException * Error returned when the caller has exceeded the default resource quotas. For example, too many * maintenance windows or patch baselines have been created. *
*
* For information about resource quotas in Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.RegisterTargetWithMaintenanceWindow
* @see AWS API Documentation
*/
@Override
public RegisterTargetWithMaintenanceWindowResult registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest request) {
request = beforeClientExecution(request);
return executeRegisterTargetWithMaintenanceWindow(request);
}
@SdkInternalApi
final RegisterTargetWithMaintenanceWindowResult executeRegisterTargetWithMaintenanceWindow(
RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest) {
ExecutionContext executionContext = createExecutionContext(registerTargetWithMaintenanceWindowRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Adds a new task to a maintenance window.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service * quotas in the Amazon Web Services General Reference. * @throws ResourceLimitExceededException * Error returned when the caller has exceeded the default resource quotas. For example, too many * maintenance windows or patch baselines have been created. *
*
* For information about resource quotas in Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws FeatureNotAvailableException
* You attempted to register a
* Removes tag keys from the specified resource.
*
*
* Services map a
* Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service
* team.
*
* Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for
* disconnected sessions, but not terminated sessions.
*
* This command is primarily for use by client machines to automatically reconnect during intermittent network
* issues. It isn't intended for any other use.
* LAMBDA or STEP_FUNCTIONS task in a region where the
* corresponding service isn't available.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.RegisterTaskWithMaintenanceWindow
* @see AWS API Documentation
*/
@Override
public RegisterTaskWithMaintenanceWindowResult registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest request) {
request = beforeClientExecution(request);
return executeRegisterTaskWithMaintenanceWindow(request);
}
@SdkInternalApi
final RegisterTaskWithMaintenanceWindowResult executeRegisterTaskWithMaintenanceWindow(
RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest) {
ExecutionContext executionContext = createExecutionContext(registerTaskWithMaintenanceWindowRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines
* how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
* service charges money to the account based on feature or service usage, then the Amazon Web Services service team
* might create a default setting of "false". This means the user can't use this feature unless they change the
* setting to "true" and intentionally opt in for a paid feature.
* SettingId object to a setting value. Amazon Web Services services teams define the
* default value for a SettingId. You can't create a new SettingId, but you can overwrite
* the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the
* GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API
* operation to change the default setting.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.ResumeSession
* @see AWS API
* Documentation
*/
@Override
public ResumeSessionResult resumeSession(ResumeSessionRequest request) {
request = beforeClientExecution(request);
return executeResumeSession(request);
}
@SdkInternalApi
final ResumeSessionResult executeResumeSession(ResumeSessionRequest resumeSessionRequest) {
ExecutionContext executionContext = createExecutionContext(resumeSessionRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Sends a signal to an Automation execution to change the current behavior or status of the execution.
*
* Runs commands on one or more managed nodes.
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Runs an association immediately and only one time. This operation can be helpful when troubleshooting * associations. *
* * @param startAssociationsOnceRequest * @return Result of the StartAssociationsOnce operation returned by the service. * @throws InvalidAssociationException * The association isn't valid or doesn't exist. * @throws AssociationDoesNotExistException * The specified association doesn't exist. * @sample AWSSimpleSystemsManagement.StartAssociationsOnce * @see AWS API * Documentation */ @Override public StartAssociationsOnceResult startAssociationsOnce(StartAssociationsOnceRequest request) { request = beforeClientExecution(request); return executeStartAssociationsOnce(request); } @SdkInternalApi final StartAssociationsOnceResult executeStartAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest) { ExecutionContext executionContext = createExecutionContext(startAssociationsOnceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Initiates execution of an Automation runbook. *
* * @param startAutomationExecutionRequest * @return Result of the StartAutomationExecution operation returned by the service. * @throws AutomationDefinitionNotFoundException * An Automation runbook with the specified name couldn't be found. * @throws InvalidAutomationExecutionParametersException * The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they * may not match the set of parameters permitted for the specified Automation document. * @throws AutomationExecutionLimitExceededException * The number of simultaneously running Automation executions exceeded the allowable limit. * @throws AutomationDefinitionVersionNotFoundException * An Automation runbook with the specified name and version couldn't be found. * @throws IdempotentParameterMismatchException * Error returned when an idempotent operation is retried and the parameters don't match the original call * to the API with the same idempotency token. * @throws InvalidTargetException * The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not * have permission to perform the operation. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.StartAutomationExecution * @see AWS * API Documentation */ @Override public StartAutomationExecutionResult startAutomationExecution(StartAutomationExecutionRequest request) { request = beforeClientExecution(request); return executeStartAutomationExecution(request); } @SdkInternalApi final StartAutomationExecutionResult executeStartAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest) { ExecutionContext executionContext = createExecutionContext(startAutomationExecutionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Creates a change request for Change Manager. The Automation runbooks specified in the change request run only * after all required approvals for the change request have been received. *
* * @param startChangeRequestExecutionRequest * @return Result of the StartChangeRequestExecution operation returned by the service. * @throws AutomationDefinitionNotFoundException * An Automation runbook with the specified name couldn't be found. * @throws InvalidAutomationExecutionParametersException * The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they * may not match the set of parameters permitted for the specified Automation document. * @throws AutomationExecutionLimitExceededException * The number of simultaneously running Automation executions exceeded the allowable limit. * @throws AutomationDefinitionVersionNotFoundException * An Automation runbook with the specified name and version couldn't be found. * @throws IdempotentParameterMismatchException * Error returned when an idempotent operation is retried and the parameters don't match the original call * to the API with the same idempotency token. * @throws InternalServerErrorException * An error occurred on the server side. * @throws AutomationDefinitionNotApprovedException * Indicates that the Change Manager change template used in the change request was rejected or is still in * a pending state. * @sample AWSSimpleSystemsManagement.StartChangeRequestExecution * @see AWS API Documentation */ @Override public StartChangeRequestExecutionResult startChangeRequestExecution(StartChangeRequestExecutionRequest request) { request = beforeClientExecution(request); return executeStartChangeRequestExecution(request); } @SdkInternalApi final StartChangeRequestExecutionResult executeStartChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest) { ExecutionContext executionContext = createExecutionContext(startChangeRequestExecutionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and * token that can be used to open a WebSocket connection for sending input and receiving outputs. *
*
* Amazon Web Services CLI usage: start-session is an interactive command that requires the Session
* Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems
* Manager User Guide.
*
* Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services * Tools for PowerShell on Windows local machines. *
** Stop an Automation that is currently running. *
* * @param stopAutomationExecutionRequest * @return Result of the StopAutomationExecution operation returned by the service. * @throws AutomationExecutionNotFoundException * There is no automation execution information for the requested automation execution ID. * @throws InvalidAutomationStatusUpdateException * The specified update status operation isn't valid. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.StopAutomationExecution * @see AWS * API Documentation */ @Override public StopAutomationExecutionResult stopAutomationExecution(StopAutomationExecutionRequest request) { request = beforeClientExecution(request); return executeStopAutomationExecution(request); } @SdkInternalApi final StopAutomationExecutionResult executeStopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest) { ExecutionContext executionContext = createExecutionContext(stopAutomationExecutionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the * managed node. A terminated session can't be resumed. *
* * @param terminateSessionRequest * @return Result of the TerminateSession operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.TerminateSession * @see AWS API * Documentation */ @Override public TerminateSessionResult terminateSession(TerminateSessionRequest request) { request = beforeClientExecution(request); return executeTerminateSession(request); } @SdkInternalApi final TerminateSessionResult executeTerminateSession(TerminateSessionRequest terminateSessionRequest) { ExecutionContext executionContext = createExecutionContext(terminateSessionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Remove a label or labels from a parameter. *
* * @param unlabelParameterVersionRequest * @return Result of the UnlabelParameterVersion operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws TooManyUpdatesException * There are concurrent updates for a resource that supports one update at a time. * @throws ParameterNotFoundException * The parameter couldn't be found. Verify the name and try again. * @throws ParameterVersionNotFoundException * The specified parameter version wasn't found. Verify the parameter name and version, and try again. * @sample AWSSimpleSystemsManagement.UnlabelParameterVersion * @see AWS * API Documentation */ @Override public UnlabelParameterVersionResult unlabelParameterVersion(UnlabelParameterVersionRequest request) { request = beforeClientExecution(request); return executeUnlabelParameterVersion(request); } @SdkInternalApi final UnlabelParameterVersionResult executeUnlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest) { ExecutionContext executionContext = createExecutionContext(unlabelParameterVersionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Updates an association. You can update the association name and version, the document version, schedule,
* parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation,
* the system removes all optional parameters from the request and overwrites the association with null values for
* those parameters. This is by design. You must specify all optional parameters in the call, even if you are not
* changing the parameters. This includes the Name parameter. Before calling this API action, we
* recommend that you call the DescribeAssociation API operation and make a note of all optional parameters
* required for your UpdateAssociation call.
*
* In order to call this API operation, a user, group, or role must be granted permission to call the
* DescribeAssociation API operation. If you don't have permission to call DescribeAssociation,
* then you receive the following error:
* An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
*
* When you update an association, the association immediately runs against the specified targets. You can add the
* ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.
*
$LATEST parameter to view the latest version of
* the association.
* @throws AssociationVersionLimitExceededException
* You have reached the maximum number versions allowed for an association. Each association has a limit of
* 1,000 versions.
* @throws InvalidTargetMapsException
* TargetMap parameter isn't valid.
* @sample AWSSimpleSystemsManagement.UpdateAssociation
* @see AWS API
* Documentation
*/
@Override
public UpdateAssociationResult updateAssociation(UpdateAssociationRequest request) {
request = beforeClientExecution(request);
return executeUpdateAssociation(request);
}
@SdkInternalApi
final UpdateAssociationResult executeUpdateAssociation(UpdateAssociationRequest updateAssociationRequest) {
ExecutionContext executionContext = createExecutionContext(updateAssociationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the * specified managed node. *
*
* UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM
* Agent) to report status updates about your associations and is only used for associations created with the
* InstanceId legacy parameter.
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Updates one or more values for an SSM document. *
* * @param updateDocumentRequest * @return Result of the UpdateDocument operation returned by the service. * @throws MaxDocumentSizeExceededException * The size limit of a document is 64 KB. * @throws DocumentVersionLimitExceededException * The document has too many versions. Delete one or more document versions and try again. * @throws InternalServerErrorException * An error occurred on the server side. * @throws DuplicateDocumentContentException * The content of the association document matches another document. Change the content of the document and * try again. * @throws DuplicateDocumentVersionNameException * The version name has already been used in this document. Specify a different version name, and then try * again. * @throws InvalidDocumentContentException * The content for the document isn't valid. * @throws InvalidDocumentVersionException * The document version isn't valid or doesn't exist. * @throws InvalidDocumentSchemaVersionException * The version of the document schema isn't supported. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @throws InvalidDocumentOperationException * You attempted to delete a document while it is still shared. You must stop sharing the document before * you can delete it. * @sample AWSSimpleSystemsManagement.UpdateDocument * @see AWS API * Documentation */ @Override public UpdateDocumentResult updateDocument(UpdateDocumentRequest request) { request = beforeClientExecution(request); return executeUpdateDocument(request); } @SdkInternalApi final UpdateDocumentResult executeUpdateDocument(UpdateDocumentRequest updateDocumentRequest) { ExecutionContext executionContext = createExecutionContext(updateDocumentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Set the default version of a document. *
*
* If you change a document version for a State Manager association, Systems Manager immediately runs the
* association unless you previously specifed the apply-only-at-cron-interval parameter.
*
* Updates information related to approval reviews for a specific version of a change template in Change Manager. *
* * @param updateDocumentMetadataRequest * @return Result of the UpdateDocumentMetadata operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidDocumentException * The specified SSM document doesn't exist. * @throws InvalidDocumentOperationException * You attempted to delete a document while it is still shared. You must stop sharing the document before * you can delete it. * @throws InvalidDocumentVersionException * The document version isn't valid or doesn't exist. * @sample AWSSimpleSystemsManagement.UpdateDocumentMetadata * @see AWS API * Documentation */ @Override public UpdateDocumentMetadataResult updateDocumentMetadata(UpdateDocumentMetadataRequest request) { request = beforeClientExecution(request); return executeUpdateDocumentMetadata(request); } @SdkInternalApi final UpdateDocumentMetadataResult executeUpdateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest) { ExecutionContext executionContext = createExecutionContext(updateDocumentMetadataRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Updates an existing maintenance window. Only specified parameters are modified. *
*
* The value you specify for Duration determines the specific end time for the maintenance window based
* on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
* number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the
* duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window
* tasks can start after 5 PM.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.UpdateMaintenanceWindow
* @see AWS
* API Documentation
*/
@Override
public UpdateMaintenanceWindowResult updateMaintenanceWindow(UpdateMaintenanceWindowRequest request) {
request = beforeClientExecution(request);
return executeUpdateMaintenanceWindow(request);
}
@SdkInternalApi
final UpdateMaintenanceWindowResult executeUpdateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest) {
ExecutionContext executionContext = createExecutionContext(updateMaintenanceWindowRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Modifies the target of an existing maintenance window. You can change the following:
*
* Name
*
* Description
*
* Owner
*
* IDs for an ID target
*
* Tags for a Tag target
*
* From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource
* group. For more information, see Target.
*
* If a parameter is null, then the corresponding field isn't modified.
*
*
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.UpdateMaintenanceWindowTarget
* @see AWS API Documentation
*/
@Override
public UpdateMaintenanceWindowTargetResult updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest request) {
request = beforeClientExecution(request);
return executeUpdateMaintenanceWindowTarget(request);
}
@SdkInternalApi
final UpdateMaintenanceWindowTargetResult executeUpdateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest) {
ExecutionContext executionContext = createExecutionContext(updateMaintenanceWindowTargetRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the
* following values:
*
*
*
*
*
*
*
* One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task,
* targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more
* information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User
* Guide.
*
* If the value for a parameter in
* When you update a maintenance window task that has options specified in
*
* TaskARN. For example, you can change a RUN_COMMAND task from
* AWS-RunPowerShellScript to AWS-RunShellScript.
* ServiceRoleArn
* TaskInvocationParameters
* Priority
* MaxConcurrency
* MaxErrors
* UpdateMaintenanceWindowTask is null, then the corresponding field
* isn't modified. If you set Replace to true, then all fields required by the
* RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't
* specified are set to null.
* TaskInvocationParameters,
* you must provide again all the TaskInvocationParameters values that you want to retain. The values
* you don't specify again are removed. For example, suppose that when you registered a Run Command task, you
* specified TaskInvocationParameters values for Comment, NotificationConfig,
* and OutputS3BucketName. If you update the maintenance window task and specify only a different
* OutputS3BucketName value, the values for Comment and NotificationConfig
* are removed.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.UpdateMaintenanceWindowTask
* @see AWS API Documentation
*/
@Override
public UpdateMaintenanceWindowTaskResult updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest request) {
request = beforeClientExecution(request);
return executeUpdateMaintenanceWindowTask(request);
}
@SdkInternalApi
final UpdateMaintenanceWindowTaskResult executeUpdateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest) {
ExecutionContext executionContext = createExecutionContext(updateMaintenanceWindowTaskRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or
* virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more
* information, see CreateActivation.
*
* You don't have permission to access the managed node. *
** Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running. *
** SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. *
*
* The managed node isn't in valid state. Valid states are: Running, Pending,
* Stopped, and Stopping. Invalid states are: Shutting-down and
* Terminated.
*
* Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. * For more information, see Set up OpsCenter in * the Amazon Web Services Systems Manager User Guide. *
** Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, * and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For * more information, see OpsCenter in the Amazon * Web Services Systems Manager User Guide. *
* * @param updateOpsItemRequest * @return Result of the UpdateOpsItem operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws OpsItemNotFoundException * The specified OpsItem ID doesn't exist. Verify the ID and try again. * @throws OpsItemAlreadyExistsException * The OpsItem already exists. * @throws OpsItemLimitExceededException * The request caused OpsItems to exceed one or more quotas. * @throws OpsItemInvalidParameterException * A specified parameter argument isn't valid. Verify the available arguments and try again. * @throws OpsItemAccessDeniedException * You don't have permission to view OpsItems in the specified account. Verify that your account is * configured either as a Systems Manager delegated administrator or that you are logged into the * Organizations management account. * @sample AWSSimpleSystemsManagement.UpdateOpsItem * @see AWS API * Documentation */ @Override public UpdateOpsItemResult updateOpsItem(UpdateOpsItemRequest request) { request = beforeClientExecution(request); return executeUpdateOpsItem(request); } @SdkInternalApi final UpdateOpsItemResult executeUpdateOpsItem(UpdateOpsItemRequest updateOpsItemRequest) { ExecutionContext executionContext = createExecutionContext(updateOpsItemRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager. *
* * @param updateOpsMetadataRequest * @return Result of the UpdateOpsMetadata operation returned by the service. * @throws OpsMetadataNotFoundException * The OpsMetadata object doesn't exist. * @throws OpsMetadataInvalidArgumentException * One of the arguments passed is invalid. * @throws OpsMetadataKeyLimitExceededException * The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an * application in Application Manager. * @throws OpsMetadataTooManyUpdatesException * The system is processing too many concurrent updates. Wait a few moments and try again. * @throws InternalServerErrorException * An error occurred on the server side. * @sample AWSSimpleSystemsManagement.UpdateOpsMetadata * @see AWS API * Documentation */ @Override public UpdateOpsMetadataResult updateOpsMetadata(UpdateOpsMetadataRequest request) { request = beforeClientExecution(request); return executeUpdateOpsMetadata(request); } @SdkInternalApi final UpdateOpsMetadataResult executeUpdateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest) { ExecutionContext executionContext = createExecutionContext(updateOpsMetadataRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Modifies an existing patch baseline. Fields not specified in the request are left unchanged. *
*
* For information about valid key-value pairs in PatchFilters for each supported operating system
* type, see PatchFilter.
*
* For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service
* quotas in the Amazon Web Services General Reference.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.UpdatePatchBaseline
* @see AWS API
* Documentation
*/
@Override
public UpdatePatchBaselineResult updatePatchBaseline(UpdatePatchBaselineRequest request) {
request = beforeClientExecution(request);
return executeUpdatePatchBaseline(request);
}
@SdkInternalApi
final UpdatePatchBaselineResult executeUpdatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest) {
ExecutionContext executionContext = createExecutionContext(updatePatchBaselineRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Update a resource data sync. After you create a resource data sync for a Region, you can't change the account
* options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the
*
* This API operation only supports a resource data sync that was created with a SyncFromSource
*
*
* Services map a
* Update the service setting for the account.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Include only the current account option, you can't edit that sync later and choose the
* Include all accounts from my Organizations configuration option. Instead, you must delete the first
* resource data sync, and create a new one.
* SyncType.
* UpdateResourceDataSync request is being processed. Wait a few minutes and try again.
* @throws InternalServerErrorException
* An error occurred on the server side.
* @sample AWSSimpleSystemsManagement.UpdateResourceDataSync
* @see AWS API
* Documentation
*/
@Override
public UpdateResourceDataSyncResult updateResourceDataSync(UpdateResourceDataSyncRequest request) {
request = beforeClientExecution(request);
return executeUpdateResourceDataSync(request);
}
@SdkInternalApi
final UpdateResourceDataSyncResult executeUpdateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest) {
ExecutionContext executionContext = createExecutionContext(updateResourceDataSyncRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
RequestServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines
* how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
* service charges money to the account based on feature or service usage, then the Amazon Web Services service team
* might create a default setting of "false". This means the user can't use this feature unless they change the
* setting to "true" and intentionally opt in for a paid feature.
* SettingId object to a setting value. Amazon Web Services services teams define the
* default value for a SettingId. You can't create a new SettingId, but you can overwrite
* the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the
* GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to
* change the value back to the original value defined by the Amazon Web Services service team.
*