id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
systems-manager-api-026
|
systems-manager-api.pdf
| 26 |
as a Systems Manager delegated administrator or that you are logged into the AWS Organizations management account. HTTP Status Code: 400 OpsItemAlreadyExistsException The OpsItem already exists. HTTP Status Code: 400 OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again. HTTP Status Code: 400 OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas. HTTP Status Code: 400 Examples Example This example illustrates one usage of CreateOpsItem. Errors API Version 2014-11-06 84 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CreateOpsItem Content-Type: application/x-amz-json-1.1 API Reference User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240401T161257Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 80 { "Description": "Example Ops Item", "Source": "SSM", "Title": "DocumentDeleted" } Sample Response {{ "OpsItemId": "oi-1f050EXAMPLE" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2014-11-06 85 AWS Systems Manager • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 86 AWS Systems Manager CreateOpsMetadata API Reference If you create a new application in Application Manager, AWS Systems Manager calls this API operation to specify information about the new application, including the application type. Request Syntax { "Metadata": { "string" : { "Value": "string" } }, "ResourceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Metadata Metadata for a new Application Manager application. Type: String to MetadataValue object map Map Entries: Maximum number of 5 items. Key Length Constraints: Minimum length of 1. Maximum length of 256. Key Pattern: ^(?!\s*$).+ Required: No CreateOpsMetadata API Version 2014-11-06 87 AWS Systems Manager ResourceId API Reference A resource ID for a new Application Manager application. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^(?!\s*$).+ Required: Yes Tags Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target AWS Region. In this case, you could specify the following key- value pairs: • Key=Environment,Value=Production • Key=Region,Value=us-east-2 Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No Response Syntax { "OpsMetadataArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2014-11-06 88 AWS Systems Manager OpsMetadataArn API Reference The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.] {0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*) Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 OpsMetadataAlreadyExistsException An OpsMetadata object already exists for the selected resource. HTTP Status Code: 400 OpsMetadataInvalidArgumentException One of the arguments passed is invalid. HTTP Status Code: 400 OpsMetadataLimitExceededException Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again. HTTP Status Code: 400 OpsMetadataTooManyUpdatesException The system is processing too many concurrent updates. Wait a few moments and try again. Errors API Version 2014-11-06 89 AWS Systems Manager HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 90 AWS Systems Manager API Reference CreatePatchBaseline Creates a patch baseline. Note For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter. Request Syntax { "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": number, "ApproveUntilDate": "string", "ComplianceLevel": "string", "EnableNonSecurity": boolean, "PatchFilterGroup": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] } ] } } ] }, "ApprovedPatches": [ "string" ], "ApprovedPatchesComplianceLevel": "string", "ApprovedPatchesEnableNonSecurity": boolean, "AvailableSecurityUpdatesComplianceStatus": "string", "ClientToken": "string", "Description":
|
systems-manager-api-027
|
systems-manager-api.pdf
| 27 |
AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 90 AWS Systems Manager API Reference CreatePatchBaseline Creates a patch baseline. Note For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter. Request Syntax { "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": number, "ApproveUntilDate": "string", "ComplianceLevel": "string", "EnableNonSecurity": boolean, "PatchFilterGroup": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] } ] } } ] }, "ApprovedPatches": [ "string" ], "ApprovedPatchesComplianceLevel": "string", "ApprovedPatchesEnableNonSecurity": boolean, "AvailableSecurityUpdatesComplianceStatus": "string", "ClientToken": "string", "Description": "string", "GlobalFilters": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] CreatePatchBaseline API Version 2014-11-06 91 API Reference AWS Systems Manager } ] }, "Name": "string", "OperatingSystem": "string", "RejectedPatches": [ "string" ], "RejectedPatchesAction": "string", "Sources": [ { "Configuration": "string", "Name": "string", "Products": [ "string" ] } ], "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ApprovalRules A set of rules used to include patches in the baseline. Type: PatchRuleGroup object Required: No ApprovedPatches A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide. Request Parameters API Version 2014-11-06 92 AWS Systems Manager Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 100. Required: No ApprovedPatchesComplianceLevel Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED. Type: String Valid Values: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED Required: No ApprovedPatchesEnableNonSecurity Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only. Type: Boolean Required: No AvailableSecurityUpdatesComplianceStatus Indicates the status you want to assign to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline. Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed. Supported for Windows Server managed nodes only. Type: String Request Parameters API Version 2014-11-06 93 AWS Systems Manager API Reference Valid Values: COMPLIANT | NON_COMPLIANT Required: No ClientToken User-provided idempotency token. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Description A description of the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No GlobalFilters A set of global filters used to include patches in the baseline. Important The GlobalFilters parameter can be configured only by using the AWS CLI or an AWS SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console. Type: PatchFilterGroup object Required: No Name The name of the patch baseline. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Request Parameters API Version 2014-11-06 94 AWS Systems Manager API Reference Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: Yes OperatingSystem Defines the operating system the patch baseline applies to. The default value is WINDOWS. Type: String Valid Values: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023 Required: No RejectedPatches A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 100. Required: No RejectedPatchesAction The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY Linux and macOS: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as INSTALLED_OTHER. This is the default action if no option is specified. Windows Server: Windows Server doesn't support the concept of package dependencies.
|
systems-manager-api-028
|
systems-manager-api.pdf
| 28 |
Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 100. Required: No RejectedPatchesAction The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY Linux and macOS: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as INSTALLED_OTHER. This is the default action if no option is specified. Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported Request Parameters API Version 2014-11-06 95 AWS Systems Manager API Reference as INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified. BLOCK All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED. Type: String Valid Values: ALLOW_AS_DEPENDENCY | BLOCK Required: No Sources Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only. Type: Array of PatchSource objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No Tags Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs: • Key=PatchSeverity,Value=Critical • Key=OS,Value=Windows Note To add tags to an existing patch baseline, use the AddTagsToResource operation. Type: Array of Tag objects Request Parameters API Version 2014-11-06 96 AWS Systems Manager API Reference Array Members: Maximum number of 1000 items. Required: No Response Syntax { "BaselineId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BaselineId The ID of the created patch baseline. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Errors For information about the errors that are common to all actions, see Common Errors. IdempotentParameterMismatch 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. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Response Syntax API Version 2014-11-06 97 AWS Systems Manager API Reference 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. HTTP Status Code: 400 Examples Example This example illustrates one usage of CreatePatchBaseline. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 461 X-Amz-Target: AmazonSSM.CreatePatchBaseline X-Amz-Date: 20240309T022356Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Description": "Baseline containing all updates approved for production systems", "ApprovalRules": { "PatchRules": [ { "PatchFilterGroup": { "PatchFilters": [ { "Values": [ "Critical", "Important", "Moderate" Examples API Version 2014-11-06 98 AWS Systems Manager API Reference ], "Key": "MSRC_SEVERITY" }, { "Values": [ "SecurityUpdates", "Updates", "UpdateRollups", "CriticalUpdates" ], "Key": "CLASSIFICATION" } ] }, "ApproveAfterDays": 7, "ApproveUntilDate": "", "EnableNonSecurity": true, "ComplianceLevel": "MEDIUM" } ] }, "Name": "my-Windows-Server-patch-baseline", "OperatingSystem": "WINDOWS", "ClientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE" } Sample Response { "BaselineId": "pb-0c10e65780EXAMPLE" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2014-11-06 99 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 100 AWS Systems Manager API Reference CreateResourceDataSync A resource data sync helps you view data from multiple sources in a single location. AWS Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single Amazon Simple
|
systems-manager-api-029
|
systems-manager-api.pdf
| 29 |
• AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 100 AWS Systems Manager API Reference CreateResourceDataSync A resource data sync helps you view data from multiple sources in a single location. AWS Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Creating a resource data sync for Inventory in the AWS Systems Manager User Guide. You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple AWS accounts and AWS Regions or EntireOrganization by using AWS Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager User Guide. 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. Note 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. Request Syntax { "S3Destination": { "AWSKMSKeyARN": "string", "BucketName": "string", "DestinationDataSharing": { "DestinationDataSharingType": "string" }, "Prefix": "string", "Region": "string", CreateResourceDataSync API Version 2014-11-06 101 AWS Systems Manager API Reference "SyncFormat": "string" }, "SyncName": "string", "SyncSource": { "AwsOrganizationsSource": { "OrganizationalUnits": [ { "OrganizationalUnitId": "string" } ], "OrganizationSourceType": "string" }, "EnableAllOpsDataSources": boolean, "IncludeFutureRegions": boolean, "SourceRegions": [ "string" ], "SourceType": "string" }, "SyncType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. S3Destination Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination. Type: ResourceDataSyncS3Destination object Required: No SyncName A name for the configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes Request Parameters API Version 2014-11-06 102 AWS Systems Manager SyncSource API Reference Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource. Type: ResourceDataSyncSource object Required: No SyncType Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple AWS accounts and AWS Regions, as listed in AWS Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 ResourceDataSyncAlreadyExistsException A sync configuration with the same name already exists. HTTP Status Code: 400 Response Elements API Version 2014-11-06 103 AWS Systems Manager API Reference ResourceDataSyncCountExceededException You have exceeded the allowed maximum sync configurations. HTTP Status Code: 400 ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid. HTTP Status Code: 400 Examples Example This example illustrates one usage of CreateResourceDataSync. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CreateResourceDataSync Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240327T173437Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240327/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 186 { "SyncName": "Example", "S3Destination": { "BucketName": "amzn-s3-demo-bucket", "Prefix": "amzn-s3-demo-bucket-prefix", "SyncFormat": "JsonSerDe", "Region": "us-east-2" }, "SyncType": "SyncToDestination" } Examples API Version 2014-11-06 104 AWS Systems Manager Sample Response {} See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 105 AWS Systems Manager DeleteActivation API Reference 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
|
systems-manager-api-030
|
systems-manager-api.pdf
| 30 |
SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 105 AWS Systems Manager DeleteActivation API Reference 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. Request Syntax { "ActivationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ActivationId The ID of the activation that you want to delete. Type: String Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 DeleteActivation API Version 2014-11-06 106 AWS Systems Manager InvalidActivation API Reference The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match. HTTP Status Code: 400 InvalidActivationId The activation ID isn't valid. Verify that you entered the correct ActivationId or ActivationCode and try again. HTTP Status Code: 400 TooManyUpdates There are concurrent updates for a resource that supports one update at a time. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeleteActivation. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeleteActivation Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T151218Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 56 { "ActivationId": "e488f2f6-e686-4afb-8a04-ef6dfEXAMPLE" } Examples API Version 2014-11-06 107 AWS Systems Manager Sample Response {} See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 108 AWS Systems Manager DeleteAssociation API Reference Disassociates the specified AWS Systems Manager document (SSM document) from the specified managed node. If you created the association by using the Targets parameter, then you must delete the association by using the association ID. 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. Request Syntax { "AssociationId": "string", "InstanceId": "string", "Name": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationId The association ID that you want to delete. Type: String Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a- fA-F]{12} Required: No InstanceId The managed node ID. Note InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID DeleteAssociation API Version 2014-11-06 109 AWS Systems Manager API Reference with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: No Name The name of the SSM document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AssociationDoesNotExist The specified association doesn't exist. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Response Elements API Version 2014-11-06 110 AWS Systems Manager InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidInstanceId API Reference The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states
|
systems-manager-api-031
|
systems-manager-api.pdf
| 31 |
400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Response Elements API Version 2014-11-06 110 AWS Systems Manager InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidInstanceId API Reference The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 TooManyUpdates There are concurrent updates for a resource that supports one update at a time. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeleteAssociation. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeleteAssociation Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T150348Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 57 Examples API Version 2014-11-06 111 AWS Systems Manager API Reference { "AssociationId": "33858bec-0c55-4547-a054-eb5fcEXAMPLE" } Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 112 AWS Systems Manager DeleteDocument API Reference Deletes the AWS 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. Request Syntax { "DocumentVersion": "string", "Force": boolean, "Name": "string", "VersionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentVersion The version of the document that you want to delete. If not provided, all versions of the document are deleted. Type: String Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) Required: No Force Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy. Type: Boolean DeleteDocument API Version 2014-11-06 113 API Reference AWS Systems Manager Required: No Name The name of the document. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: Yes VersionName The version name of the document that you want to delete. If not provided, all versions of the document are deleted. Type: String Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AssociatedInstances You must disassociate a document from all managed nodes before you can delete it. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The specified SSM document doesn't exist. Response Elements API Version 2014-11-06 114 AWS Systems Manager HTTP Status Code: 400 InvalidDocumentOperation API Reference You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeleteDocument. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeleteDocument Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T151532Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 19 { "Name": "Example" } Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Examples API Version 2014-11-06 115 API Reference AWS Systems Manager • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 116 AWS Systems Manager DeleteInventory API Reference 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. Request Syntax { "ClientToken": "string", "DryRun": boolean, "SchemaDeleteOption": "string", "TypeName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken User-provided idempotency token. Type: String
|
systems-manager-api-032
|
systems-manager-api.pdf
| 32 |
AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 116 AWS Systems Manager DeleteInventory API Reference 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. Request Syntax { "ClientToken": "string", "DryRun": boolean, "SchemaDeleteOption": "string", "TypeName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken User-provided idempotency token. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: No DryRun Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option. Type: Boolean Required: No DeleteInventory API Version 2014-11-06 117 AWS Systems Manager SchemaDeleteOption API Reference Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options: DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory operation for a version greater than the disabled version. DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want. Type: String Valid Values: DisableSchema | DeleteSchema Required: No TypeName The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS|Custom):.*$ Required: Yes Response Syntax { "DeletionId": "string", "DeletionSummary": { "RemainingCount": number, "SummaryItems": [ { "Count": number, "RemainingCount": number, "Version": "string" Response Syntax API Version 2014-11-06 118 AWS Systems Manager } ], "TotalCount": number }, "TypeName": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DeletionId Every DeleteInventory operation is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other operations. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} DeletionSummary A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the AWS Systems Manager User Guide. Type: InventoryDeletionSummary object TypeName The name of the inventory data type specified in the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS|Custom):.*$ Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2014-11-06 119 AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDeleteInventoryParametersException API Reference One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again. HTTP Status Code: 400 InvalidInventoryRequestException The request isn't valid. HTTP Status Code: 400 InvalidOptionException The delete inventory option specified isn't valid. Verify the option and try again. HTTP Status Code: 400 InvalidTypeNameException The parameter type name isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeleteInventory. Sample Request POST / HTTP/1.1 Host: ssm.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeleteInventory Content-Type: application/x-amz-json-1.1 Examples API Version 2014-11-06 120 AWS Systems Manager API Reference User-Agent: aws-cli/2.2.25 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ ssm.delete-inventory X-Amz-Date: 20240809T230226Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240809/us-west-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature39c3b3042cd2aEXAMPLE Content-Length: 124 { "TypeName": "Custom:RackInfo", "SchemaDeleteOption": "DeleteSchema", "ClientToken": "a7d4972c-ab3e-4b9a-b5c0-d5aExample" } Sample Response { "DeletionId": "5bc2ba3b-ee6a-40fa-8d09-5e5Example", "DeletionSummary": { "RemainingCount": 1, "SummaryItems": [ { "Count": 1, "RemainingCount": 1, "Version": "1.0" } ], "TotalCount": 1 }, "TypeName": "Custom:RackInfo" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2014-11-06 121 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 122 AWS Systems Manager API Reference DeleteMaintenanceWindow Deletes a maintenance window. Request Syntax { "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following
|
systems-manager-api-033
|
systems-manager-api.pdf
| 33 |
.NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2014-11-06 121 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 122 AWS Systems Manager API Reference DeleteMaintenanceWindow Deletes a maintenance window. Request Syntax { "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WindowId The ID of the maintenance window to delete. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes Response Syntax { "WindowId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DeleteMaintenanceWindow API Version 2014-11-06 123 API Reference AWS Systems Manager WindowId The ID of the deleted maintenance window. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DeleteMaintenanceWindow. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 36 X-Amz-Target: AmazonSSM.DeleteMaintenanceWindow X-Amz-Date: 20240312T210257Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { Errors API Version 2014-11-06 124 AWS Systems Manager API Reference "WindowId": "mw-0c50858d01EXAMPLE" } Sample Response { "WindowId": "mw-0c50858d01EXAMPLE" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 125 AWS Systems Manager DeleteOpsItem API Reference Delete an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to delete an OpsItem. Important Note the following important information about this operation. • Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem. • This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response. • This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call. • This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide. Request Syntax { "OpsItemId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OpsItemId The ID of the OpsItem that you want to delete. DeleteOpsItem API Version 2014-11-06 126 AWS Systems Manager Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: Yes Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeleteOpsItem. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeleteOpsItem Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T151532Z Response Elements API Version 2014-11-06 127 AWS Systems Manager API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 19 { "OpsItemId": "oi-abcdef12345" } Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 128 API Reference AWS Systems Manager DeleteOpsMetadata Delete OpsMetadata related to an application. Request Syntax { "OpsMetadataArn": "string"
|
systems-manager-api-034
|
systems-manager-api.pdf
| 34 |
Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 128 API Reference AWS Systems Manager DeleteOpsMetadata Delete OpsMetadata related to an application. Request Syntax { "OpsMetadataArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OpsMetadataArn The Amazon Resource Name (ARN) of an OpsMetadata Object to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.] {0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. DeleteOpsMetadata API Version 2014-11-06 129 API Reference AWS Systems Manager HTTP Status Code: 500 OpsMetadataInvalidArgumentException One of the arguments passed is invalid. HTTP Status Code: 400 OpsMetadataNotFoundException The OpsMetadata object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 130 AWS Systems Manager DeleteParameter API Reference Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. Request Syntax { "Name": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Name The name of the parameter to delete. Note You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteParameter API Version 2014-11-06 131 AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 ParameterNotFound API Reference The parameter couldn't be found. Verify the name and try again. Note For the DeleteParameter and GetParameter actions, if the specified parameter doesn't exist, the ParameterNotFound exception is not recorded in AWS CloudTrail event logs. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeleteParameter. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 28 X-Amz-Target: AmazonSSM.DeleteParameter X-Amz-Date: 20240316T010702Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Name": "EC2DevServerType" Examples API Version 2014-11-06 132 AWS Systems Manager } Sample Response {} See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 133 AWS Systems Manager DeleteParameters API Reference Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. Request Syntax { "Names": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Names The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. Note You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Response Syntax { "DeletedParameters": [ "string" ], "InvalidParameters": [ "string" ] DeleteParameters API Version 2014-11-06 134 AWS Systems Manager } Response Elements
|
systems-manager-api-035
|
systems-manager-api.pdf
| 35 |
accepts the following data in JSON format. Names The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name. Note You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Response Syntax { "DeletedParameters": [ "string" ], "InvalidParameters": [ "string" ] DeleteParameters API Version 2014-11-06 134 AWS Systems Manager } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DeletedParameters The names of the deleted parameters. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 2048. InvalidParameters The names of parameters that weren't deleted because the parameters aren't valid. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DeleteParameters. Response Elements API Version 2014-11-06 135 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 53 X-Amz-Target: AmazonSSM.DeleteParameters X-Amz-Date: 20240316T010844Z API Reference User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Names": [ "EC2TestServerType", "EC2ProdServerType" ] } Sample Response { "DeletedParameters": [ "EC2ProdServerType", "EC2TestServerType" ], "InvalidParameters": [] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2014-11-06 136 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 137 AWS Systems Manager API Reference DeletePatchBaseline Deletes a patch baseline. Request Syntax { "BaselineId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BaselineId The ID of the patch baseline to delete. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Required: Yes Response Syntax { "BaselineId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DeletePatchBaseline API Version 2014-11-06 138 AWS Systems Manager BaselineId The ID of the deleted patch baseline. Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 ResourceInUseException Error returned if an attempt is made to delete a patch baseline that is registered for a patch group. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeletePatchBaseline. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 38 X-Amz-Target: AmazonSSM.DeletePatchBaseline X-Amz-Date: 20240309T062407Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Errors API Version 2014-11-06 139 AWS Systems Manager API Reference Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "BaselineId": "pb-0c10e65780EXAMPLE" } Sample Response { "BaselineId": "pb-0c10e65780EXAMPLE" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 140 AWS Systems Manager API Reference DeleteResourceDataSync 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. Request Syntax { "SyncName": "string", "SyncType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SyncName The name of the configuration to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes SyncType Specify the type of resource
|
systems-manager-api-036
|
systems-manager-api.pdf
| 36 |
AWS Systems Manager API Reference DeleteResourceDataSync 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. Request Syntax { "SyncName": "string", "SyncType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SyncName The name of the configuration to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes SyncType Specify the type of resource data sync to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DeleteResourceDataSync API Version 2014-11-06 141 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid. HTTP Status Code: 400 ResourceDataSyncNotFoundException The specified sync name wasn't found. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeleteResourceDataSync. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeleteResourceDataSync Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240330T144518Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 28 { Errors API Version 2014-11-06 142 AWS Systems Manager API Reference "SyncName": "exampleSync" } Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 143 AWS Systems Manager API Reference DeleteResourcePolicy Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an AWS account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies. • OpsItemGroup - The resource policy for OpsItemGroup enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). • Parameter - The resource policy is used to share a parameter with other accounts using AWS Resource Access Manager (AWS RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the AWS Systems Manager User Guide. Request Syntax { "PolicyHash": "string", "PolicyId": "string", "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. PolicyHash ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy. Type: String Required: Yes PolicyId The policy ID. Type: String DeleteResourcePolicy API Version 2014-11-06 144 AWS Systems Manager Required: Yes ResourceArn API Reference Amazon Resource Name (ARN) of the resource to which the policies are attached. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 MalformedResourcePolicyDocumentException The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made. HTTP Status Code: 400 ResourceNotFoundException The specified parameter to be shared could not be found. HTTP Status Code: 400 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. Response Elements API Version 2014-11-06 145 AWS Systems Manager HTTP Status Code: 400 ResourcePolicyInvalidParameterException API Reference One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again. HTTP Status Code: 400 ResourcePolicyNotFoundException No policies with the specified policy ID and hash could be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 146 AWS Systems Manager API Reference
|
systems-manager-api-037
|
systems-manager-api.pdf
| 37 |
policies with the specified policy ID and hash could be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 146 AWS Systems Manager API Reference DeregisterManagedInstance Removes the server or virtual machine from the list of registered servers. If you want to reregister an on-premises server, edge device, or VM, you must use a different Activation Code and Activation ID than used to register the machine previously. The Activation Code and Activation ID must not have already been used on the maximum number of activations specified when they were created. For more information, see Deregistering managed nodes in a hybrid and multicloud environment in the AWS Systems Manager User Guide. Request Syntax { "InstanceId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. InstanceId The ID assigned to the managed node when you registered it using the activation process. Type: String Length Constraints: Minimum length of 20. Maximum length of 124. Pattern: (^mi-[0-9a-f]{17}$)|(^eks_c:[0-9A-Za-z][A-Za-z0-9\-_]{0,99}_ \w{17}$) Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DeregisterManagedInstance API Version 2014-11-06 147 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeregisterManagedInstance. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeregisterManagedInstance Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240220T234004Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 37 Errors API Version 2014-11-06 148 AWS Systems Manager { "InstanceId": "mi-017431b35cEXAMPLE" } API Reference Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 149 AWS Systems Manager API Reference DeregisterPatchBaselineForPatchGroup Removes a patch group from a patch baseline. Request Syntax { "BaselineId": "string", "PatchGroup": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BaselineId The ID of the patch baseline to deregister the patch group from. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Required: Yes PatchGroup The name of the patch group that should be deregistered from the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes DeregisterPatchBaselineForPatchGroup API Version 2014-11-06 150 API Reference AWS Systems Manager Response Syntax { "BaselineId": "string", "PatchGroup": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BaselineId The ID of the patch baseline the patch group was deregistered from. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ PatchGroup The name of the patch group deregistered from the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. Response Syntax API Version 2014-11-06 151 AWS Systems Manager HTTP Status Code: 500 InvalidResourceId API Reference The resource ID isn't valid. Verify that you entered the correct ID and try again. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeregisterPatchBaselineForPatchGroup. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 74 X-Amz-Target: AmazonSSM.DeregisterPatchBaselineForPatchGroup X-Amz-Date: 20240309T062043Z User-Agent:
|
systems-manager-api-038
|
systems-manager-api.pdf
| 38 |
the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. Response Syntax API Version 2014-11-06 151 AWS Systems Manager HTTP Status Code: 500 InvalidResourceId API Reference The resource ID isn't valid. Verify that you entered the correct ID and try again. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeregisterPatchBaselineForPatchGroup. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 74 X-Amz-Target: AmazonSSM.DeregisterPatchBaselineForPatchGroup X-Amz-Date: 20240309T062043Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "PatchGroup": "mypatchgroup", "BaselineId": "pb-0c10e65780EXAMPLE" } Sample Response { "PatchGroup": "mypatchgroup", "BaselineId": "pb-0c10e65780EXAMPLE" } Examples API Version 2014-11-06 152 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 153 AWS Systems Manager API Reference DeregisterTargetFromMaintenanceWindow Removes a target from a maintenance window. Request Syntax { "Safe": boolean, "WindowId": "string", "WindowTargetId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Safe The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window. Type: Boolean Required: No WindowId The ID of the maintenance window the target should be removed from. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes WindowTargetId The ID of the target definition to remove. DeregisterTargetFromMaintenanceWindow API Version 2014-11-06 154 AWS Systems Manager Type: String Length Constraints: Fixed length of 36. API Reference Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "WindowId": "string", "WindowTargetId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WindowId The ID of the maintenance window the target was removed from. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ WindowTargetId The ID of the removed target definition. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Response Syntax API Version 2014-11-06 155 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 TargetInUseException You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task. HTTP Status Code: 400 Examples Example This example illustrates one usage of DeregisterTargetFromMaintenanceWindow. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeregisterTargetFromMaintenanceWindow Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T182719Z Errors API Version 2014-11-06 156 AWS Systems Manager API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 94 { "WindowId": "mw-0c50858d01EXAMPLE", "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE" } Sample Response { "WindowId": "mw-0c50858d01EXAMPLE", "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 157 AWS Systems Manager API Reference DeregisterTaskFromMaintenanceWindow Removes a task from a maintenance window. Request Syntax { "WindowId": "string", "WindowTaskId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WindowId The ID of the maintenance window the task should be removed from. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes WindowTaskId The ID of the task to remove from the maintenance window. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes DeregisterTaskFromMaintenanceWindow API Version 2014-11-06 158 API Reference AWS Systems Manager Response Syntax { "WindowId": "string", "WindowTaskId": "string" } Response Elements If the action is
|
systems-manager-api-039
|
systems-manager-api.pdf
| 39 |
} Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WindowId The ID of the maintenance window the task should be removed from. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes WindowTaskId The ID of the task to remove from the maintenance window. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes DeregisterTaskFromMaintenanceWindow API Version 2014-11-06 158 API Reference AWS Systems Manager Response Syntax { "WindowId": "string", "WindowTaskId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WindowId The ID of the maintenance window the task was removed from. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ WindowTaskId The ID of the task removed from the maintenance window. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist. Response Syntax API Version 2014-11-06 159 AWS Systems Manager API Reference For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DeregisterTaskFromMaintenanceWindow. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DeregisterTaskFromMaintenanceWindow Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T180133Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 92 { "WindowId": "mw-0c50858d01EXAMPLE", "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE" } Sample Response { "WindowId": "mw-0c50858d01EXAMPLE", "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE" } Examples API Version 2014-11-06 160 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 161 AWS Systems Manager DescribeActivations API Reference Describes details about the activation, such as the date and time the activation was created, its expiration date, the AWS Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation. Request Syntax { "Filters": [ { "FilterKey": "string", "FilterValues": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters A filter to view information about your activations. Type: Array of DescribeActivationsFilter objects Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No DescribeActivations API Version 2014-11-06 162 AWS Systems Manager NextToken API Reference A token to start the list. Use this token to get the next set of results. Type: String Required: No Response Syntax { "ActivationList": [ { "ActivationId": "string", "CreatedDate": number, "DefaultInstanceName": "string", "Description": "string", "ExpirationDate": number, "Expired": boolean, "IamRole": "string", "RegistrationLimit": number, "RegistrationsCount": number, "Tags": [ { "Key": "string", "Value": "string" } ] } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ActivationList A list of activations for your AWS account. Response Syntax API Version 2014-11-06 163 AWS Systems Manager API Reference Type: Array of Activation objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeActivations. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeActivations Errors API Version 2014-11-06 164 AWS Systems Manager API Reference Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T152059Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "ActivationList": [ { "ActivationId": "e9136c70-ba7b-4d7d-8e31-174a7EXAMPLE", "CreatedDate":
|
systems-manager-api-040
|
systems-manager-api.pdf
| 40 |
Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeActivations. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeActivations Errors API Version 2014-11-06 164 AWS Systems Manager API Reference Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T152059Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "ActivationList": [ { "ActivationId": "e9136c70-ba7b-4d7d-8e31-174a7EXAMPLE", "CreatedDate": 1581954699.792, "Description": "Example", "ExpirationDate": 1584316800, "Expired": true, "IamRole": "service-role/RoleForManagedInstances", "RegistrationLimit": 5, "RegistrationsCount": 1 } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2014-11-06 165 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 166 AWS Systems Manager API Reference DescribeAssociation 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. Request Syntax { "AssociationId": "string", "AssociationVersion": "string", "InstanceId": "string", "Name": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationId The association ID for which you want information. Type: String Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a- fA-F]{12} Required: No AssociationVersion Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for a managed node, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions. Type: String Pattern: ([$]LATEST)|([1-9][0-9]*) DescribeAssociation API Version 2014-11-06 167 API Reference AWS Systems Manager Required: No InstanceId The managed node ID. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: No Name The name of the SSM document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: No Response Syntax { "AssociationDescription": { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "ApplyOnlyAtCronInterval": boolean, "AssociationId": "string", "AssociationName": "string", "AssociationVersion": "string", "AutomationTargetParameterName": "string", "CalendarNames": [ "string" ], "ComplianceSeverity": "string", "Date": number, "DocumentVersion": "string", "Duration": number, "InstanceId": "string", Response Syntax API Version 2014-11-06 168 AWS Systems Manager API Reference "LastExecutionDate": number, "LastSuccessfulExecutionDate": number, "LastUpdateAssociationDate": number, "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "OutputLocation": { "S3Location": { "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "OutputS3Region": "string" } }, "Overview": { "AssociationStatusAggregatedCount": { "string" : number }, "DetailedStatus": "string", "Status": "string" }, "Parameters": { "string" : [ "string" ] }, "ScheduleExpression": "string", "ScheduleOffset": number, "Status": { "AdditionalInfo": "string", "Date": number, "Message": "string", "Name": "string" }, "SyncCompliance": "string", "TargetLocations": [ { "Accounts": [ "string" ], "ExcludeAccounts": [ "string" ], "ExecutionRoleName": "string", "IncludeChildOrganizationUnits": boolean, "Regions": [ "string" ], "TargetLocationAlarmConfiguration": { "Alarms": [ { "Name": "string" } Response Syntax API Version 2014-11-06 169 AWS Systems Manager API Reference ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } ], "TargetMaps": [ { "string" : [ "string" ] } ], "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TriggeredAlarms": [ { "Name": "string", "State": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AssociationDescription Information about the association. Response Elements API Version 2014-11-06 170 AWS Systems Manager API Reference Type: AssociationDescription object Errors For information about the errors that are common to all actions, see Common Errors. AssociationDoesNotExist The specified association doesn't exist. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidAssociationVersion The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association. HTTP Status Code: 400 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 Errors API Version
|
systems-manager-api-041
|
systems-manager-api.pdf
| 41 |
parameter to view the latest version of the association. HTTP Status Code: 400 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 Errors API Version 2014-11-06 171 API Reference AWS Systems Manager Examples Example This example illustrates one usage of DescribeAssociation. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeAssociation Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T153423Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 57 { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE" } Sample Response { "AssociationDescription": { "ApplyOnlyAtCronInterval": false, "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "AssociationVersion": "1", "ComplianceSeverity": "UNSPECIFIED", "Date": 1561053271.583, "DocumentVersion": "$DEFAULT", "LastExecutionDate": 1582037438.692, "LastSuccessfulExecutionDate": 1582037438.692, "LastUpdateAssociationDate": 1561053271.583, "Name": "AWS-UpdateSSMAgent", "Overview": { "AssociationStatusAggregatedCount": { "Success": 3 }, "DetailedStatus": "Success", Examples API Version 2014-11-06 172 AWS Systems Manager API Reference "Status": "Success" }, "Parameters": { "allowDowngrade": [ "false" ], "version": [ "" ] }, "Targets": [ { "Key": "tag:ssm", "Values": [ "true" ] } ] } } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 173 AWS Systems Manager API Reference DescribeAssociationExecutions Views all executions for a specific association ID. Request Syntax { "AssociationId": "string", "Filters": [ { "Key": "string", "Type": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationId The association ID for which you want to view execution history details. Type: String Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a- fA-F]{12} Required: Yes Filters Filters for the request. You can specify the following filters and values. ExecutionId (EQUAL) Status (EQUAL) DescribeAssociationExecutions API Version 2014-11-06 174 AWS Systems Manager API Reference CreatedTime (EQUAL, GREATER_THAN, LESS_THAN) Type: Array of AssociationExecutionFilter objects Array Members: Minimum number of 1 item. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken A token to start the list. Use this token to get the next set of results. Type: String Required: No Response Syntax { "AssociationExecutions": [ { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "AssociationId": "string", "AssociationVersion": "string", "CreatedTime": number, Response Syntax API Version 2014-11-06 175 AWS Systems Manager API Reference "DetailedStatus": "string", "ExecutionId": "string", "LastExecutionDate": number, "ResourceCountByStatus": "string", "Status": "string", "TriggeredAlarms": [ { "Name": "string", "State": "string" } ] } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AssociationExecutions A list of the executions for the specified association ID. Type: Array of AssociationExecution objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AssociationDoesNotExist The specified association doesn't exist. HTTP Status Code: 400 Response Elements API Version 2014-11-06 176 API Reference AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeAssociationExecutions. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeAssociationExecutions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T154610Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 57 { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE" } Sample Response { "AssociationExecutions": [ { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", Examples API Version 2014-11-06 177 AWS Systems Manager API Reference "AssociationVersion": "1", "CreatedTime": 1561053271.718, "DetailedStatus": "Success", "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE", "ResourceCountByStatus": "{Success=3}", "Status": "Success" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 •
|
systems-manager-api-042
|
systems-manager-api.pdf
| 42 |
X-Amz-Date: 20240324T154610Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 57 { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE" } Sample Response { "AssociationExecutions": [ { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", Examples API Version 2014-11-06 177 AWS Systems Manager API Reference "AssociationVersion": "1", "CreatedTime": 1561053271.718, "DetailedStatus": "Success", "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE", "ResourceCountByStatus": "{Success=3}", "Status": "Success" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 178 AWS Systems Manager API Reference DescribeAssociationExecutionTargets Views information about a specific execution of a specific association. Request Syntax { "AssociationId": "string", "ExecutionId": "string", "Filters": [ { "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationId The association ID that includes the execution for which you want to view details. Type: String Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a- fA-F]{12} Required: Yes ExecutionId The execution ID for which you want to view details. Type: String DescribeAssociationExecutionTargets API Version 2014-11-06 179 AWS Systems Manager API Reference Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a- fA-F]{12} Required: Yes Filters Filters for the request. You can specify the following filters and values. Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL) Type: Array of AssociationExecutionTargetsFilter objects Array Members: Minimum number of 1 item. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken A token to start the list. Use this token to get the next set of results. Type: String Required: No Response Syntax { "AssociationExecutionTargets": [ Response Syntax API Version 2014-11-06 180 AWS Systems Manager API Reference { "AssociationId": "string", "AssociationVersion": "string", "DetailedStatus": "string", "ExecutionId": "string", "LastExecutionDate": number, "OutputSource": { "OutputSourceId": "string", "OutputSourceType": "string" }, "ResourceId": "string", "ResourceType": "string", "Status": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AssociationExecutionTargets Information about the execution. Type: Array of AssociationExecutionTarget objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AssociationDoesNotExist The specified association doesn't exist. Response Elements API Version 2014-11-06 181 AWS Systems Manager HTTP Status Code: 400 AssociationExecutionDoesNotExist API Reference The specified execution ID doesn't exist. Verify the ID number and try again. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeAssociationExecutionTargets. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeAssociationExecutionTargets Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T165104Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 112 { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE" } Examples API Version 2014-11-06 182 AWS Systems Manager Sample Response { API Reference "AssociationExecutionTargets": [ { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "AssociationVersion": "1", "DetailedStatus": "Success", "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE", "LastExecutionDate": 1582037438.692, "OutputSource": { "OutputSourceId": "1cdbb1e6-2e69-40b1-ac1d-121dcEXAMPLE", "OutputSourceType": "RunCommand" }, "ResourceId": "i-02573cafcfEXAMPLE", "ResourceType": "ManagedInstance", "Status": "Success" }, { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "AssociationVersion": "1", "DetailedStatus": "Success", "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE", "LastExecutionDate": 1581948052.198, "OutputSource": { "OutputSourceId": "b170ae99-4959-479b-ab4d-f6ae0EXAMPLE", "OutputSourceType": "RunCommand" }, "ResourceId": "i-0471e04240EXAMPLE", "ResourceType": "ManagedInstance", "Status": "Success" }, { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "AssociationVersion": "1", "DetailedStatus": "Success", "ExecutionId": "d6d51ef5-4eca-48ef-9d7d-bd6ceEXAMPLE", "LastExecutionDate": 1561053316.711, "OutputSource": { "OutputSourceId": "89cd739c-d1a5-4dc9-af4f-8b624EXAMPLE", "OutputSourceType": "RunCommand" }, "ResourceId": "i-07782c72faEXAMPLE", "ResourceType": "ManagedInstance", Examples API Version 2014-11-06 183 AWS Systems Manager API Reference "Status": "Success" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 184 AWS Systems Manager API Reference DescribeAutomationExecutions Provides details about all active and terminated Automation executions. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data
|
systems-manager-api-043
|
systems-manager-api.pdf
| 43 |
SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 184 AWS Systems Manager API Reference DescribeAutomationExecutions Provides details about all active and terminated Automation executions. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Filters used to limit the scope of executions that are requested. Type: Array of AutomationExecutionFilter objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No DescribeAutomationExecutions API Version 2014-11-06 185 AWS Systems Manager NextToken API Reference The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "AutomationExecutionMetadataList": [ { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "AssociationId": "string", "AutomationExecutionId": "string", "AutomationExecutionStatus": "string", "AutomationSubtype": "string", "AutomationType": "string", "ChangeRequestName": "string", "CurrentAction": "string", "CurrentStepName": "string", "DocumentName": "string", "DocumentVersion": "string", "ExecutedBy": "string", "ExecutionEndTime": number, "ExecutionStartTime": number, "FailureMessage": "string", "LogFile": "string", "MaxConcurrency": "string", "MaxErrors": "string", "Mode": "string", "OpsItemId": "string", "Outputs": { "string" : [ "string" ] }, Response Syntax API Version 2014-11-06 186 AWS Systems Manager API Reference "ParentAutomationExecutionId": "string", "ResolvedTargets": { "ParameterValues": [ "string" ], "Truncated": boolean }, "Runbooks": [ { "DocumentName": "string", "DocumentVersion": "string", "MaxConcurrency": "string", "MaxErrors": "string", "Parameters": { "string" : [ "string" ] }, "TargetLocations": [ { "Accounts": [ "string" ], "ExcludeAccounts": [ "string" ], "ExecutionRoleName": "string", "IncludeChildOrganizationUnits": boolean, "Regions": [ "string" ], "TargetLocationAlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } ], "TargetMaps": [ { "string" : [ "string" ] Response Syntax API Version 2014-11-06 187 API Reference AWS Systems Manager } ], "TargetParameterName": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } ], "ScheduledTime": number, "Target": "string", "TargetLocationsURL": "string", "TargetMaps": [ { "string" : [ "string" ] } ], "TargetParameterName": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TriggeredAlarms": [ { "Name": "string", "State": "string" } ] } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Elements API Version 2014-11-06 188 AWS Systems Manager API Reference AutomationExecutionMetadataList The list of details about each automation execution which has occurred which matches the filter specification, if any. Type: Array of AutomationExecutionMetadata objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidFilterValue The filter value isn't valid. Verify the value and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Errors API Version 2014-11-06 189 AWS Systems Manager Examples Example API Reference This example illustrates one usage of DescribeAutomationExecutions. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeAutomationExecutions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T173011Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "AutomationExecutionMetadataList": [ { "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE", "AutomationExecutionStatus": "Success", "AutomationType": "Local", "DocumentName": "Example", "DocumentVersion": "1", "ExecutedBy": "arn:aws:sts::111122223333:assumed-role/Example", "ExecutionEndTime": 1585062669.053, "ExecutionStartTime": 1585061570.827, "LogFile": "", "Mode": "Auto", "Outputs": {}, "ResolvedTargets": { "ParameterValues": [], "Truncated": false }, "Targets": [] } ] Examples API Version 2014-11-06 190 AWS Systems Manager } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 191 AWS Systems Manager API Reference DescribeAutomationStepExecutions Information about all active and terminated step executions in an Automation workflow. Request Syntax { "AutomationExecutionId": "string", "Filters":
|
systems-manager-api-044
|
systems-manager-api.pdf
| 44 |
information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 191 AWS Systems Manager API Reference DescribeAutomationStepExecutions Information about all active and terminated step executions in an Automation workflow. Request Syntax { "AutomationExecutionId": "string", "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ReverseOrder": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AutomationExecutionId The Automation execution ID for which you want step execution descriptions. Type: String Length Constraints: Fixed length of 36. Required: Yes Filters One or more filters to limit the number of step executions returned by the request. Type: Array of StepExecutionFilter objects Array Members: Minimum number of 1 item. Maximum number of 6 items. Required: No DescribeAutomationStepExecutions API Version 2014-11-06 192 AWS Systems Manager MaxResults API Reference The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No ReverseOrder Indicates whether to list step executions in reverse order by start time. The default value is 'false'. Type: Boolean Required: No Response Syntax { "NextToken": "string", "StepExecutions": [ { "Action": "string", "ExecutionEndTime": number, "ExecutionStartTime": number, "FailureDetails": { "Details": { "string" : [ "string" ] }, "FailureStage": "string", "FailureType": "string" }, "FailureMessage": "string", Response Syntax API Version 2014-11-06 193 AWS Systems Manager API Reference "Inputs": { "string" : "string" }, "IsCritical": boolean, "IsEnd": boolean, "MaxAttempts": number, "NextStep": "string", "OnFailure": "string", "Outputs": { "string" : [ "string" ] }, "OverriddenParameters": { "string" : [ "string" ] }, "ParentStepDetails": { "Action": "string", "Iteration": number, "IteratorValue": "string", "StepExecutionId": "string", "StepName": "string" }, "Response": "string", "ResponseCode": "string", "StepExecutionId": "string", "StepName": "string", "StepStatus": "string", "TargetLocation": { "Accounts": [ "string" ], "ExcludeAccounts": [ "string" ], "ExecutionRoleName": "string", "IncludeChildOrganizationUnits": boolean, "Regions": [ "string" ], "TargetLocationAlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { Response Syntax API Version 2014-11-06 194 AWS Systems Manager API Reference "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" }, "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TimeoutSeconds": number, "TriggeredAlarms": [ { "Name": "string", "State": "string" } ], "ValidNextSteps": [ "string" ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String StepExecutions A list of details about the current state of all steps that make up an execution. Type: Array of StepExecution objects Response Elements API Version 2014-11-06 195 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidFilterValue The filter value isn't valid. Verify the value and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeAutomationStepExecutions. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Errors API Version 2014-11-06 196 AWS Systems Manager Accept-Encoding: identity API Reference X-Amz-Target: AmazonSSM.DescribeAutomationStepExecutions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T180909Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 65 { "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE" } Sample Response { "StepExecutions": [ { "Action": "aws:createImage", "ExecutionEndTime": 1585062668.968, "ExecutionStartTime": 1585061571.144, "Inputs": { "ImageDescription": "\"AMI for i-02573cafcfEXAMPLE created on 2020-03-24_14.52.51\"", "ImageName": "\"i-02573cafcfEXAMPLE-2020-03-24_14.52.51\"", "InstanceId": "\"i-02573cafcfEXAMPLE\"", "NoReboot": "false" }, "OnFailure": "Abort", "Outputs": { "ImageId": [ "ami-0f4706cb37EXAMPLE" ], "ImageState": [ "available" ], "OutputPayload": [ "{\"ImageId\":\"ami-0f4706cb37EXAMPLE\",\"ImageState\":\"available \"}" ] }, "OverriddenParameters": {}, Examples API Version 2014-11-06 197 AWS Systems Manager API Reference "StepExecutionId": "eff80946-356d-4128-97b2-6a0f5EXAMPLE", "StepName": "createImage", "StepStatus": "Success" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET •
|
systems-manager-api-045
|
systems-manager-api.pdf
| 45 |
"AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE" } Sample Response { "StepExecutions": [ { "Action": "aws:createImage", "ExecutionEndTime": 1585062668.968, "ExecutionStartTime": 1585061571.144, "Inputs": { "ImageDescription": "\"AMI for i-02573cafcfEXAMPLE created on 2020-03-24_14.52.51\"", "ImageName": "\"i-02573cafcfEXAMPLE-2020-03-24_14.52.51\"", "InstanceId": "\"i-02573cafcfEXAMPLE\"", "NoReboot": "false" }, "OnFailure": "Abort", "Outputs": { "ImageId": [ "ami-0f4706cb37EXAMPLE" ], "ImageState": [ "available" ], "OutputPayload": [ "{\"ImageId\":\"ami-0f4706cb37EXAMPLE\",\"ImageState\":\"available \"}" ] }, "OverriddenParameters": {}, Examples API Version 2014-11-06 197 AWS Systems Manager API Reference "StepExecutionId": "eff80946-356d-4128-97b2-6a0f5EXAMPLE", "StepName": "createImage", "StepStatus": "Success" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 198 AWS Systems Manager API Reference DescribeAvailablePatches Lists all patches eligible to be included in a patch baseline. Note Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Each element in the array is a structure containing a key-value pair. Windows Server Supported keys for Windows Server managed node patches include the following: • PATCH_SET Sample values: OS | APPLICATION DescribeAvailablePatches API Version 2014-11-06 199 AWS Systems Manager • PRODUCT API Reference Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus • PRODUCT_FAMILY Sample values: Windows | Office • MSRC_SEVERITY Sample values: ServicePacks | Important | Moderate • CLASSIFICATION Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates • PATCH_ID Sample values: KB123456 | KB4516046 Linux Important When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the AWS Command Line Interface (AWS CLI), the following command fails: aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615 However, the following command succeeds: aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615 Supported keys for Linux managed node patches include the following: • PRODUCT Sample values: AmazonLinux2018.03 | AmazonLinux2.0 • NAME Sample values: kernel-headers | samba-python | php Request Parameters API Version 2014-11-06 200 AWS Systems Manager • SEVERITY Sample values: Critical | Important | Medium | Low API Reference • EPOCH Sample values: 0 | 1 • VERSION Sample values: 78.6.1 | 4.10.16 • RELEASE Sample values: 9.56.amzn1 | 1.amzn2 • ARCH Sample values: i686 | x86_64 • REPOSITORY Sample values: Core | Updates • ADVISORY_ID Sample values: ALAS-2018-1058 | ALAS2-2021-1594 • CVE_ID Sample values: CVE-2018-3615 | CVE-2020-1472 • BUGZILLA_ID Sample values: 1463241 Type: Array of PatchOrchestratorFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No MaxResults The maximum number of patches to return (per page). Type: Integer Request Parameters API Version 2014-11-06 201 AWS Systems Manager API Reference Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "NextToken": "string", "Patches": [ { "AdvisoryIds": [ "string" ], "Arch": "string", "BugzillaIds": [ "string" ], "Classification": "string", "ContentUrl": "string", "CVEIds": [ "string" ], "Description": "string", "Epoch": number, "Id": "string", "KbNumber": "string", "Language": "string", "MsrcNumber": "string", "MsrcSeverity": "string", "Name": "string", "Product": "string", "ProductFamily": "string", "Release": "string", "ReleaseDate": number, "Repository": "string", "Severity": "string", "Title": "string", "Vendor": "string", "Version": "string" } ] Response Syntax API Version 2014-11-06 202 AWS Systems Manager } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Patches An array of patches. Each entry in the array is a patch structure. Type: Array of Patch objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeAvailablePatches. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Response Elements API Version 2014-11-06 203 AWS Systems Manager Accept-Encoding: identity Content-Length: 17 X-Amz-Target: AmazonSSM.DescribeAvailablePatches X-Amz-Date: 20240308T193543Z API Reference User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Filters": [ { "Key": "PRODUCT", "Values": [ "WindowsServer2016" ] }, { "Key": "CLASSIFICATION", "Values": [ "SecurityUpdates" ] }, { "Key": "MSRC_SEVERITY", "Values": [ "Critical" ] } ] } Sample Response { "Patches": [ { "Classification": "SecurityUpdates", "ContentUrl": "https://support.microsoft.com/en-us/kb/4074588", "Description": "A security issue
|
systems-manager-api-046
|
systems-manager-api.pdf
| 46 |
occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeAvailablePatches. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Response Elements API Version 2014-11-06 203 AWS Systems Manager Accept-Encoding: identity Content-Length: 17 X-Amz-Target: AmazonSSM.DescribeAvailablePatches X-Amz-Date: 20240308T193543Z API Reference User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Filters": [ { "Key": "PRODUCT", "Values": [ "WindowsServer2016" ] }, { "Key": "CLASSIFICATION", "Values": [ "SecurityUpdates" ] }, { "Key": "MSRC_SEVERITY", "Values": [ "Critical" ] } ] } Sample Response { "Patches": [ { "Classification": "SecurityUpdates", "ContentUrl": "https://support.microsoft.com/en-us/kb/4074588", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by Examples API Version 2014-11-06 204 AWS Systems Manager API Reference installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "Id": "11adea10-0701-430e-954f-9471595ae246", "KbNumber": "KB4074588", "Language": "All", "MsrcNumber": "", "MsrcSeverity": "Critical", "Product": "WindowsServer2016", "ProductFamily": "Windows", "ReleaseDate": 1518548400, "Title": "2018-02 Cumulative Update for Windows Server 2016 (1709) for x64- based Systems (KB4074588)", "Vendor": "Microsoft" }, { "Classification": "SecurityUpdates", "ContentUrl": "https://support.microsoft.com/en-us/kb/4074590", "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "Id": "f5f58231-ac5d-4640-ab1b-9dc8d857c265", "KbNumber": "KB4074590", "Language": "All", "MsrcNumber": "", "MsrcSeverity": "Critical", "Product": "WindowsServer2016", "ProductFamily": "Windows", "ReleaseDate": 1518544805, "Title": "2018-02 Cumulative Update for Windows Server 2016 for x64-based Systems (KB4074590)", "Vendor": "Microsoft" }, { "Classification": "SecurityUpdates", "ContentUrl": "https://support.microsoft.com/en-us/kb/4074595", Examples API Version 2014-11-06 205 AWS Systems Manager API Reference "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", "Id": "754b5889-2e01-40cc-8833-edf86b35541f", "KbNumber": "KB4074595", "Language": "All", "MsrcNumber": "", "MsrcSeverity": "Critical", "Product": "WindowsServer2016", "ProductFamily": "Windows", "ReleaseDate": 1517965209, "Title": "2018-02 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4074595)", "Vendor": "Microsoft" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2014-11-06 206 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 207 AWS Systems Manager DescribeDocument API Reference Describes the specified AWS Systems Manager document (SSM document). Request Syntax { "DocumentVersion": "string", "Name": "string", "VersionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentVersion The document version for which you want information. Can be a specific version or the default version. Type: String Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) Required: No Name The name of the SSM document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: Yes VersionName An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed. Type: String DescribeDocument API Version 2014-11-06 208 AWS Systems Manager API Reference Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No Response Syntax { "Document": { "ApprovedVersion": "string", "AttachmentsInformation": [ { "Name": "string" } ], "Author": "string", "Category": [ "string" ], "CategoryEnum": [ "string" ], "CreatedDate": number, "DefaultVersion": "string", "Description": "string", "DisplayName": "string", "DocumentFormat": "string", "DocumentType": "string", "DocumentVersion": "string", "Hash": "string", "HashType": "string", "LatestVersion": "string", "Name": "string", "Owner": "string", "Parameters": [ { "DefaultValue": "string", "Description": "string", "Name": "string", "Type": "string" } ], "PendingReviewVersion": "string", "PlatformTypes": [ "string" ], "Requires": [ { "Name": "string", "RequireType": "string", Response Syntax API Version 2014-11-06 209 AWS Systems Manager API Reference "Version": "string", "VersionName": "string" } ], "ReviewInformation": [ { "ReviewedTime": number, "Reviewer": "string", "Status": "string" } ], "ReviewStatus": "string", "SchemaVersion": "string", "Sha1": "string", "Status": "string", "StatusInformation": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "string", "VersionName": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Document Information about the SSM document. Type: DocumentDescription object Errors For information
|
systems-manager-api-047
|
systems-manager-api.pdf
| 47 |
"string" ], "Requires": [ { "Name": "string", "RequireType": "string", Response Syntax API Version 2014-11-06 209 AWS Systems Manager API Reference "Version": "string", "VersionName": "string" } ], "ReviewInformation": [ { "ReviewedTime": number, "Reviewer": "string", "Status": "string" } ], "ReviewStatus": "string", "SchemaVersion": "string", "Sha1": "string", "Status": "string", "StatusInformation": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "string", "VersionName": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Document Information about the SSM document. Type: DocumentDescription object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2014-11-06 210 API Reference AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentVersion The document version isn't valid or doesn't exist. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeDocument. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeDocument Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T182134Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 23 { "Name": "Example" } Examples API Version 2014-11-06 211 API Reference AWS Systems Manager Sample Response { "Document": { "CreatedDate": 1585061514.204, "DefaultVersion": "1", "Description": "Example", "DocumentFormat": "YAML", "DocumentType": "Automation", "DocumentVersion": "1", "DisplayName": "ExampleDoc", "Hash": "68b196e538f5a895f87a0cc15eb74614021f44b47329aa95ccc0f4f71EXAMPLE", "HashType": "Sha256", "LatestVersion": "1", "Name": "Example", "Owner": "111122223333", "Parameters": [ { "DefaultValue": "", "Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.", "Name": "AutomationAssumeRole", "Type": "String" }, { "DefaultValue": "", "Description": "(Required) The Instance Id to create an image of.", "Name": "InstanceId", "Type": "String" } ], "PlatformTypes": [ "Windows", "Linux" ], "SchemaVersion": "0.3", "Status": "Active", "Tags": [] } } Examples API Version 2014-11-06 212 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 213 AWS Systems Manager API Reference DescribeDocumentPermission Describes the permissions for a AWS 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 AWS account ID) or publicly (All). Request Syntax { "MaxResults": number, "Name": "string", "NextToken": "string", "PermissionType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 200. Required: No Name The name of the document for which you are the owner. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: Yes DescribeDocumentPermission API Version 2014-11-06 214 AWS Systems Manager NextToken API Reference The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No PermissionType The permission type for the document. The permission type can be Share. Type: String Valid Values: Share Required: Yes Response Syntax { "AccountIds": [ "string" ], "AccountSharingInfoList": [ { "AccountId": "string", "SharedDocumentVersion": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AccountIds The account IDs that have permission to use this document. The ID can be either an AWS account or All. Type: Array of strings Response Syntax API Version 2014-11-06 215 AWS Systems Manager API Reference Array Members: Maximum number of 20 items. Pattern: (?i)all|[0-9]{12} AccountSharingInfoList A list of AWS accounts where the current document is shared and the version shared with each account. Type: Array of AccountSharingInfo objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentOperation You attempted to delete a document while it is still shared. You must stop sharing the document before you
|
systems-manager-api-048
|
systems-manager-api.pdf
| 48 |
accounts where the current document is shared and the version shared with each account. Type: Array of AccountSharingInfo objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentOperation You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Errors API Version 2014-11-06 216 AWS Systems Manager InvalidPermissionType API Reference The permission type isn't supported. Share is the only supported permission type. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeDocumentPermission. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeDocumentPermission Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T182653Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 50 { "Name": "Example", "PermissionType": "Share" } Sample Response { "AccountIds": [], "AccountSharingInfoList": [] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Examples API Version 2014-11-06 217 API Reference AWS Systems Manager • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 218 AWS Systems Manager API Reference DescribeEffectiveInstanceAssociations All associations for the managed nodes. Request Syntax { "InstanceId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. InstanceId The managed node ID for which you want to view all associations. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 5. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) DescribeEffectiveInstanceAssociations API Version 2014-11-06 219 API Reference AWS Systems Manager Type: String Required: No Response Syntax { "Associations": [ { "AssociationId": "string", "AssociationVersion": "string", "Content": "string", "InstanceId": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Associations The associations for the requested managed node. Type: Array of InstanceAssociation objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2014-11-06 220 AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidInstanceId API Reference The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeEffectiveInstanceAssociations. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeEffectiveInstanceAssociations Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240326T144721Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240326/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 37 Examples API Version 2014-11-06 221 AWS Systems Manager API Reference { "InstanceId": "i-02573cafcfEXAMPLE" } Sample Response { "Associations": [ { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "InstanceId": "i-02573cafcfEXAMPLE", "Content": "{\n \"schemaVersion\": \"1.2\",\n \"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",\n-- truncated--", "AssociationVersion": "1" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 222 AWS
|
systems-manager-api-049
|
systems-manager-api.pdf
| 49 |
\"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",\n-- truncated--", "AssociationVersion": "1" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 222 AWS Systems Manager API Reference DescribeEffectivePatchesForPatchBaseline Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only. Request Syntax { "BaselineId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BaselineId The ID of the patch baseline to retrieve the effective patches for. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Required: Yes MaxResults The maximum number of patches to return (per page). Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No DescribeEffectivePatchesForPatchBaseline API Version 2014-11-06 223 AWS Systems Manager NextToken API Reference The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "EffectivePatches": [ { "Patch": { "AdvisoryIds": [ "string" ], "Arch": "string", "BugzillaIds": [ "string" ], "Classification": "string", "ContentUrl": "string", "CVEIds": [ "string" ], "Description": "string", "Epoch": number, "Id": "string", "KbNumber": "string", "Language": "string", "MsrcNumber": "string", "MsrcSeverity": "string", "Name": "string", "Product": "string", "ProductFamily": "string", "Release": "string", "ReleaseDate": number, "Repository": "string", "Severity": "string", "Title": "string", "Vendor": "string", "Version": "string" }, "PatchStatus": { "ApprovalDate": number, "ComplianceLevel": "string", "DeploymentStatus": "string" } Response Syntax API Version 2014-11-06 224 AWS Systems Manager } ], "NextToken": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. EffectivePatches An array of patches and patch status. Type: Array of EffectivePatch objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Response Elements API Version 2014-11-06 225 AWS Systems Manager InvalidResourceId API Reference The resource ID isn't valid. Verify that you entered the correct ID and try again. HTTP Status Code: 400 UnsupportedOperatingSystem The operating systems you specified isn't supported, or the operation isn't supported for the operating system. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeEffectivePatchesForPatchBaseline. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 38 X-Amz-Target: AmazonSSM.DescribeEffectivePatchesForPatchBaseline X-Amz-Date: 20240309T061447Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "BaselineId": "pb-0c10e65780EXAMPLE" } Sample Response { "EffectivePatches": [ { "Patch": { Examples API Version 2014-11-06 226 AWS Systems Manager API Reference "Classification": "SecurityUpdates", "ContentUrl": "https://support.microsoft.com/en-us/kb/2032276", "Description": "A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and gain control over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to restart your system.", "Id": "8692029b-a3a2-4a87-a73b-8ea881b4b4d6", "KbNumber": "KB2032276", "Language": "All", "MsrcNumber": "MS10-043", "MsrcSeverity": "Important", "Product": "WindowsServer2008R2", "ProductFamily": "Windows", "ReleaseDate": 1279040400, "Title": "Security Update for Windows Server 2008 R2 x64 Edition (KB2032276)", "Vendor": "Microsoft" }, "PatchStatus": { "ApprovalDate": 1279299600, "ComplianceLevel": "UNSPECIFIED", "DeploymentStatus": "APPROVED" } }, { "Patch": { "Classification": "SecurityUpdates", "ContentUrl": "https://support.microsoft.com/en-us/kb/2124261", "Description": "A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and gain control over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to restart your system.", "Id": "12ef1bed-0dd2-4633-b3ac-60888aa8ba33", "KbNumber": "KB2124261", "Language": "All", "MsrcNumber": "MS10-065", Examples API Version 2014-11-06 227 AWS Systems Manager API Reference "MsrcSeverity": "Important", "Product": "Windows7", "ProductFamily": "Windows", "ReleaseDate": 1284483600, "Title": "Security Update for Windows 7 (KB2124261)", "Vendor": "Microsoft" }, "PatchStatus": { "ApprovalDate": 1284742800, "ComplianceLevel": "UNSPECIFIED", "DeploymentStatus": "APPROVED" } }, { "Patch": { "Classification": "SecurityUpdates", "ContentUrl": "https://support.microsoft.com/en-us/kb/2124261", "Description": "A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and
|
systems-manager-api-050
|
systems-manager-api.pdf
| 50 |
gain control over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to restart your system.", "Id": "12ef1bed-0dd2-4633-b3ac-60888aa8ba33", "KbNumber": "KB2124261", "Language": "All", "MsrcNumber": "MS10-065", Examples API Version 2014-11-06 227 AWS Systems Manager API Reference "MsrcSeverity": "Important", "Product": "Windows7", "ProductFamily": "Windows", "ReleaseDate": 1284483600, "Title": "Security Update for Windows 7 (KB2124261)", "Vendor": "Microsoft" }, "PatchStatus": { "ApprovalDate": 1284742800, "ComplianceLevel": "UNSPECIFIED", "DeploymentStatus": "APPROVED" } }, { "Patch": { "Classification": "SecurityUpdates", "ContentUrl": "https://support.microsoft.com/en-us/kb/2124261", "Description": "A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and gain control over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to restart your system.", "Id": "1b571637-30ed-48d6-b2f3-24d374fdebb8", "KbNumber": "KB2124261", "Language": "All", "MsrcNumber": "MS10-065", "MsrcSeverity": "Important", "Product": "WindowsServer2008R2", "ProductFamily": "Windows", "ReleaseDate": 1284483600, "Title": "Security Update for Windows Server 2008 R2 x64 Edition (KB2124261)", "Vendor": "Microsoft" }, "PatchStatus": { "ApprovalDate": 1284742800, "ComplianceLevel": "UNSPECIFIED", "DeploymentStatus": "APPROVED" } } // There may be more content here Examples API Version 2014-11-06 228 AWS Systems Manager ] } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 229 AWS Systems Manager API Reference DescribeInstanceAssociationsStatus The status of the associations for the managed nodes. Request Syntax { "InstanceId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. InstanceId The managed node IDs for which you want association status information. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) DescribeInstanceAssociationsStatus API Version 2014-11-06 230 API Reference AWS Systems Manager Type: String Required: No Response Syntax { "InstanceAssociationStatusInfos": [ { "AssociationId": "string", "AssociationName": "string", "AssociationVersion": "string", "DetailedStatus": "string", "DocumentVersion": "string", "ErrorCode": "string", "ExecutionDate": number, "ExecutionSummary": "string", "InstanceId": "string", "Name": "string", "OutputUrl": { "S3OutputUrl": { "OutputUrl": "string" } }, "Status": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. InstanceAssociationStatusInfos Status information about the association. Type: Array of InstanceAssociationStatusInfo objects Response Syntax API Version 2014-11-06 231 AWS Systems Manager NextToken API Reference The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeInstanceAssociationsStatus. Errors API Version 2014-11-06 232 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity API Reference X-Amz-Target: AmazonSSM.DescribeInstanceAssociationsStatus Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T185152Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 37 { "InstanceId": "i-02573cafcfEXAMPLE" } Sample Response { "InstanceAssociationStatusInfos": [ { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "AssociationVersion": "1", "DetailedStatus": "Success", "DocumentVersion": "1", "ExecutionDate": 1581948052.198, "InstanceId": "i-02573cafcfEXAMPLE", "Name": "AWS-UpdateSSMAgent", "Status": "Success" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2014-11-06 233 API Reference AWS Systems Manager • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3
|
systems-manager-api-051
|
systems-manager-api.pdf
| 51 |
"DetailedStatus": "Success", "DocumentVersion": "1", "ExecutionDate": 1581948052.198, "InstanceId": "i-02573cafcfEXAMPLE", "Name": "AWS-UpdateSSMAgent", "Status": "Success" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2014-11-06 233 API Reference AWS Systems Manager • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 234 AWS Systems Manager API Reference DescribeInstanceInformation 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. Note The IamRole field returned for this API operation is the role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "InstanceInformationFilterList": [ { "key": "string", "valueSet": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. DescribeInstanceInformation API Version 2014-11-06 235 AWS Systems Manager API Reference The request accepts the following data in JSON format. Filters One or more filters. Use a filter to return a more specific list of managed nodes. You can filter based on tags applied to your managed nodes. Tag filters can't be combined with other filter types. Use this Filters data type instead of InstanceInformationFilterList, which is deprecated. Type: Array of InstanceInformationStringFilter objects Array Members: Minimum number of 0 items. Required: No InstanceInformationFilterList This is a legacy method. We recommend that you don't use this method. Instead, use the Filters data type. Filters enables you to return node information by filtering based on tags applied to managed nodes. Note Attempting to use InstanceInformationFilterList and Filters leads to an exception error. Type: Array of InstanceInformationFilter objects Array Members: Minimum number of 0 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. The default value is 10 items. Type: Integer Valid Range: Minimum value of 5. Maximum value of 50. Request Parameters API Version 2014-11-06 236 AWS Systems Manager Required: No NextToken API Reference The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "InstanceInformationList": [ { "ActivationId": "string", "AgentVersion": "string", "AssociationOverview": { "DetailedStatus": "string", "InstanceAssociationStatusAggregatedCount": { "string" : number } }, "AssociationStatus": "string", "ComputerName": "string", "IamRole": "string", "InstanceId": "string", "IPAddress": "string", "IsLatestVersion": boolean, "LastAssociationExecutionDate": number, "LastPingDateTime": number, "LastSuccessfulAssociationExecutionDate": number, "Name": "string", "PingStatus": "string", "PlatformName": "string", "PlatformType": "string", "PlatformVersion": "string", "RegistrationDate": number, "ResourceType": "string", "SourceId": "string", "SourceType": "string" } ], Response Syntax API Version 2014-11-06 237 AWS Systems Manager "NextToken": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. InstanceInformationList The managed node information list. Type: Array of InstanceInformation objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. • AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running. Response Elements API Version 2014-11-06 238 AWS Systems Manager API Reference • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidInstanceInformationFilterValue The specified filter value isn't valid. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeInstanceInformation. Sample Request
|
systems-manager-api-052
|
systems-manager-api.pdf
| 52 |
managed node. • AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running. Response Elements API Version 2014-11-06 238 AWS Systems Manager API Reference • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidInstanceInformationFilterValue The specified filter value isn't valid. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeInstanceInformation. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeInstanceInformation Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240220T234247Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 72 { "Filters": [ { "Key": "InstanceIds", "Values": [ Examples API Version 2014-11-06 239 AWS Systems Manager API Reference "i-02573cafcfEXAMPLE" ] } ] } Sample Response { "InstanceInformationList": [ { "AgentVersion": "2.3.871.0", "AssociationOverview": { "DetailedStatus": "Failed", "InstanceAssociationStatusAggregatedCount": { "Failed": 1, "Success": 1 } }, "AssociationStatus": "Failed", "ComputerName": "WIN-11RMS222RPK.WORKGROUP", "IPAddress": "203.0.113.0", "InstanceId": "i-02573cafcfEXAMPLE", "IsLatestVersion": false, "LastAssociationExecutionDate": 1582242019, "LastPingDateTime": 1582242018.094, "PingStatus": "Online", "PlatformName": "Microsoft Windows Server 2008 R2 Datacenter", "PlatformType": "Windows", "PlatformVersion": "6.1.7601", "ResourceType": "EC2Instance" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2014-11-06 240 API Reference AWS Systems Manager • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 241 AWS Systems Manager API Reference DescribeInstancePatches Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "InstanceId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Each element in the array is a structure containing a key-value pair. Supported keys for DescribeInstancePatchesinclude the following: • Classification Sample values: Security | SecurityUpdates • KBId Sample values: KB4480056 | java-1.7.0-openjdk.x86_64 • Severity Sample values: Important | Medium | Low • State DescribeInstancePatches API Version 2014-11-06 242 AWS Systems Manager API Reference Sample values: Installed | InstalledOther | InstalledPendingReboot For lists of all State values, see Patch compliance state values in the AWS Systems Manager User Guide. Type: Array of PatchOrchestratorFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No InstanceId The ID of the managed node whose patch state information should be retrieved. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes MaxResults The maximum number of patches to return (per page). Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "NextToken": "string", "Patches": [ { Response Syntax API Version 2014-11-06 243 AWS Systems Manager API Reference "Classification": "string", "CVEIds": "string", "InstalledTime": number, "KBId": "string", "Severity": "string", "State": "string", "Title": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Patches Each entry in the array is a structure containing: • Title (string) • KBId (string) • Classification (string) • Severity (string) • State (string, such as "INSTALLED" or "FAILED") • InstalledTime (DateTime) • InstalledBy (string) Type: Array of PatchComplianceData objects Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2014-11-06 244 AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilter API Reference The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status
|
systems-manager-api-053
|
systems-manager-api.pdf
| 53 |
The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeInstancePatches. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 37 Examples API Version 2014-11-06 245 AWS Systems Manager API Reference X-Amz-Target: AmazonSSM.DescribeInstancePatches X-Amz-Date: 20240308T205131Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "InstanceId": "i-02573cafcfEXAMPLE" } Sample Response { "Patches": [ { "Title": "NetworkManager.x86_64:1:1.30.0-7.el8", "KBId": "NetworkManager.x86_64", "Classification": "Security", "Severity": "Moderate", "State": "Installed", "InstalledTime": "2024-05-19T10:03:07-07:00" }, { "Title": "bash.x86_64:0:4.4.19-14.el8", "KBId": "bash.x86_64", "Classification": "Security", "Severity": "Low", "State": "Installed", "InstalledTime": "2024-05-19T10:03:25-07:00" }, { "Title": "kernel-modules.x86_64:0:4.18.0-305.10.2.el8_4", "KBId": "kernel-modules.x86_64", "Classification": "Security", "Severity": "Important", "State": "Installed", "InstalledTime": "2024-08-04T10:45:42-07:00" } // There may be more content here ] } Examples API Version 2014-11-06 246 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 247 AWS Systems Manager API Reference DescribeInstancePatchStates Retrieves the high-level patch state of one or more managed nodes. Request Syntax { "InstanceIds": [ "string" ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. InstanceIds The ID of the managed node for which patch state information should be retrieved. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes MaxResults The maximum number of managed nodes to return (per page). Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) DescribeInstancePatchStates API Version 2014-11-06 248 API Reference AWS Systems Manager Type: String Required: No Response Syntax { "InstancePatchStates": [ { "AvailableSecurityUpdateCount": number, "BaselineId": "string", "CriticalNonCompliantCount": number, "FailedCount": number, "InstalledCount": number, "InstalledOtherCount": number, "InstalledPendingRebootCount": number, "InstalledRejectedCount": number, "InstallOverrideList": "string", "InstanceId": "string", "LastNoRebootInstallOperationTime": number, "MissingCount": number, "NotApplicableCount": number, "Operation": "string", "OperationEndTime": number, "OperationStartTime": number, "OtherNonCompliantCount": number, "OwnerInformation": "string", "PatchGroup": "string", "RebootOption": "string", "SecurityNonCompliantCount": number, "SnapshotId": "string", "UnreportedNotApplicableCount": number } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2014-11-06 249 AWS Systems Manager InstancePatchStates API Reference The high-level patch state for the requested managed nodes. Type: Array of InstancePatchState objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeInstancePatchStates. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Errors API Version 2014-11-06 250 AWS Systems Manager Content-Length: 40 API Reference X-Amz-Target: AmazonSSM.DescribeInstancePatchStates X-Amz-Date: 20240308T202310Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "InstanceIds": [ "i-02573cafcfEXAMPLE" ] } Sample Response { "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "mypatchgroup", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "CriticalNonCompliantCount": 2, "SecurityNonCompliantCount": 2, "OtherNonCompliantCount": 1, "InstalledCount": 123, "InstalledOtherCount": 334, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 1, "FailedCount": 2, "UnreportedNotApplicableCount": 11, "NotApplicableCount": 2063, "OperationStartTime": "2024-05-03T11:00:56-07:00", "OperationEndTime": "2024-05-03T11:01:09-07:00", "Operation": "Scan", "LastNoRebootInstallOperationTime": "2024-04-14T12:17:41-07:00", "RebootOption": "RebootIfNeeded" } ] } Examples API Version 2014-11-06 251 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS
|
systems-manager-api-054
|
systems-manager-api.pdf
| 54 |
1, "FailedCount": 2, "UnreportedNotApplicableCount": 11, "NotApplicableCount": 2063, "OperationStartTime": "2024-05-03T11:00:56-07:00", "OperationEndTime": "2024-05-03T11:01:09-07:00", "Operation": "Scan", "LastNoRebootInstallOperationTime": "2024-04-14T12:17:41-07:00", "RebootOption": "RebootIfNeeded" } ] } Examples API Version 2014-11-06 251 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 252 AWS Systems Manager API Reference DescribeInstancePatchStatesForPatchGroup Retrieves the high-level patch state for the managed nodes in the specified patch group. Request Syntax { "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "PatchGroup": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Each entry in the array is a structure containing: • Key (string between 1 and 200 characters) • Values (array containing a single string) • Type (string "Equal", "NotEqual", "LessThan", "GreaterThan") Type: Array of InstancePatchStateFilter objects Array Members: Minimum number of 0 items. Maximum number of 4 items. Required: No MaxResults The maximum number of patches to return (per page). DescribeInstancePatchStatesForPatchGroup API Version 2014-11-06 253 AWS Systems Manager Type: Integer API Reference Valid Range: Minimum value of 10. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No PatchGroup The name of the patch group for which the patch state information should be retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes Response Syntax { "InstancePatchStates": [ { "AvailableSecurityUpdateCount": number, "BaselineId": "string", "CriticalNonCompliantCount": number, "FailedCount": number, "InstalledCount": number, "InstalledOtherCount": number, "InstalledPendingRebootCount": number, "InstalledRejectedCount": number, "InstallOverrideList": "string", "InstanceId": "string", "LastNoRebootInstallOperationTime": number, Response Syntax API Version 2014-11-06 254 AWS Systems Manager API Reference "MissingCount": number, "NotApplicableCount": number, "Operation": "string", "OperationEndTime": number, "OperationStartTime": number, "OtherNonCompliantCount": number, "OwnerInformation": "string", "PatchGroup": "string", "RebootOption": "string", "SecurityNonCompliantCount": number, "SnapshotId": "string", "UnreportedNotApplicableCount": number } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. InstancePatchStates The high-level patch state for the requested managed nodes. Type: Array of InstancePatchState objects Array Members: Minimum number of 1 item. Maximum number of 5 items. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2014-11-06 255 AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilter API Reference The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeInstancePatchStatesForPatchGroup. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 33 X-Amz-Target: AmazonSSM.DescribeInstancePatchStatesForPatchGroup X-Amz-Date: 20240308T204541Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "PatchGroup": "mypatchgroup" } Examples API Version 2014-11-06 256 API Reference AWS Systems Manager Sample Response { "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "mypatchgroup", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "OwnerInformation": "", "InstalledCount": 32, "InstalledOtherCount": 1, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 0, "UnreportedNotApplicableCount": 2671, "NotApplicableCount": 400, "OperationStartTime": "2024-08-04T11:03:50.590000-07:00", "OperationEndTime": "2024-08-04T11:04:21.555000-07:00", "Operation": "Scan", "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 1, "OtherNonCompliantCount": 0 }, { "InstanceId": "i-0471e04240EXAMPLE", "PatchGroup": "mypatchgroup", "BaselineId": "pb-09ca3fb51fEXAMPLE", "SnapshotId": "05d8ffb0-1bbe-4812-ba2d-d9b7bEXAMPLE", "OwnerInformation": "", "InstalledCount": 45, "InstalledOtherCount": 3, "InstalledPendingRebootCount": 1, "InstalledRejectedCount": 0, "MissingCount": 2, "FailedCount": 1, "UnreportedNotApplicableCount": 3154, "NotApplicableCount": 321, "OperationStartTime": "2024-08-04T11:04:30.290000-07:00", "OperationEndTime": "2024-08-04T11:04:49.255000-07:00", "Operation": "Scan", Examples API Version 2014-11-06 257 AWS Systems Manager API Reference "RebootOption": "NoReboot", "CriticalNonCompliantCount": 0, "SecurityNonCompliantCount": 2, "OtherNonCompliantCount": 1 } // There may be more content here ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 258 AWS Systems Manager API Reference DescribeInstanceProperties An API operation used by the Systems Manager console to display information about Systems Manager managed nodes. Request Syntax { "FiltersWithOperator": [
|
systems-manager-api-055
|
systems-manager-api.pdf
| 55 |
API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 258 AWS Systems Manager API Reference DescribeInstanceProperties An API operation used by the Systems Manager console to display information about Systems Manager managed nodes. Request Syntax { "FiltersWithOperator": [ { "Key": "string", "Operator": "string", "Values": [ "string" ] } ], "InstancePropertyFilterList": [ { "key": "string", "valueSet": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FiltersWithOperator The request filters to use with the operator. Type: Array of InstancePropertyStringFilter objects Array Members: Minimum number of 1 item. Maximum number of 40 items. Required: No InstancePropertyFilterList An array of instance property filters. DescribeInstanceProperties API Version 2014-11-06 259 AWS Systems Manager API Reference Type: Array of InstancePropertyFilter objects Array Members: Minimum number of 1 item. Maximum number of 40 items. Required: No MaxResults The maximum number of items to return for the call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No NextToken The token provided by a previous request to use to return the next set of properties. Type: String Required: No Response Syntax { "InstanceProperties": [ { "ActivationId": "string", "AgentVersion": "string", "Architecture": "string", "AssociationOverview": { "DetailedStatus": "string", "InstanceAssociationStatusAggregatedCount": { "string" : number } }, "AssociationStatus": "string", "ComputerName": "string", "IamRole": "string", "InstanceId": "string", "InstanceRole": "string", Response Syntax API Version 2014-11-06 260 AWS Systems Manager API Reference "InstanceState": "string", "InstanceType": "string", "IPAddress": "string", "KeyName": "string", "LastAssociationExecutionDate": number, "LastPingDateTime": number, "LastSuccessfulAssociationExecutionDate": number, "LaunchTime": number, "Name": "string", "PingStatus": "string", "PlatformName": "string", "PlatformType": "string", "PlatformVersion": "string", "RegistrationDate": number, "ResourceType": "string", "SourceId": "string", "SourceType": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. InstanceProperties Properties for the managed instances. Type: Array of InstanceProperty objects NextToken The token for the next set of properties to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2014-11-06 261 AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidActivationId API Reference The activation ID isn't valid. Verify that you entered the correct ActivationId or ActivationCode and try again. HTTP Status Code: 400 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidInstancePropertyFilterValue The specified filter value isn't valid. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. Errors API Version 2014-11-06 262 AWS Systems Manager HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 263 AWS Systems Manager API Reference DescribeInventoryDeletions Describes a specific delete inventory operation. Request Syntax { "DeletionId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeletionId Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory operation. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum
|
systems-manager-api-056
|
systems-manager-api.pdf
| 56 |
delete inventory operation. Request Syntax { "DeletionId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeletionId Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory operation. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken A token to start the list. Use this token to get the next set of results. DescribeInventoryDeletions API Version 2014-11-06 264 API Reference AWS Systems Manager Type: String Required: No Response Syntax { "InventoryDeletions": [ { "DeletionId": "string", "DeletionStartTime": number, "DeletionSummary": { "RemainingCount": number, "SummaryItems": [ { "Count": number, "RemainingCount": number, "Version": "string" } ], "TotalCount": number }, "LastStatus": "string", "LastStatusMessage": "string", "LastStatusUpdateTime": number, "TypeName": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. InventoryDeletions A list of status items for deleted inventory. Type: Array of InventoryDeletionStatusItem objects Response Syntax API Version 2014-11-06 265 AWS Systems Manager NextToken API Reference The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDeletionIdException The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeInventoryDeletions. Sample Request POST / HTTP/1.1 Host: ssm.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeInventoryDeletions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.2.25 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ ssm.describe-inventory-deletions Errors API Version 2014-11-06 266 AWS Systems Manager X-Amz-Date: 20240810T211220Z API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240810/us-west-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 {} Sample Response { "InventoryDeletions": [ { "DeletionId": "5bc2ba3b-ee6a-40fa-8d09-5eExample", "DeletionStartTime": 1628550146, "DeletionSummary": { "RemainingCount": 0, "SummaryItems": [ { "Count": 1, "RemainingCount": 0, "Version": "1.0" } ], "TotalCount": 1 }, "LastStatus": "Complete", "LastStatusMessage": "Deletion is successful", "LastStatusUpdateTime": 1628550238, "TypeName": "Custom:RackInfo" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2014-11-06 267 AWS Systems Manager • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 268 AWS Systems Manager API Reference DescribeMaintenanceWindowExecutions 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. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Each entry in the array is a structure containing: • Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter. • Values. An array of strings, each between 1 and 256 characters. Supported values are date/ time strings in a valid ISO 8601 date/time format, such as 2024-11-04T05:00:00Z. Type: Array of MaintenanceWindowFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No DescribeMaintenanceWindowExecutions API Version 2014-11-06 269 AWS Systems Manager MaxResults API Reference The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No WindowId The ID of the maintenance window whose executions should be retrieved. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes Response Syntax { "NextToken": "string", "WindowExecutions": [ { "EndTime": number, "StartTime": number, "Status": "string", "StatusDetails": "string", "WindowExecutionId": "string", "WindowId": "string" } Response Syntax API Version 2014-11-06 270 AWS Systems Manager ] } Response Elements API Reference If the action is successful, the service sends
|
systems-manager-api-057
|
systems-manager-api.pdf
| 57 |
value of 10. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No WindowId The ID of the maintenance window whose executions should be retrieved. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes Response Syntax { "NextToken": "string", "WindowExecutions": [ { "EndTime": number, "StartTime": number, "Status": "string", "StatusDetails": "string", "WindowExecutionId": "string", "WindowId": "string" } Response Syntax API Version 2014-11-06 270 AWS Systems Manager ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String WindowExecutions Information about the maintenance window executions. Type: Array of MaintenanceWindowExecution objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeMaintenanceWindowExecutions. Sample Request POST / HTTP/1.1 Response Elements API Version 2014-11-06 271 AWS Systems Manager API Reference Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 36 X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowExecutions X-Amz-Date: 20240312T204551Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "WindowId": "mw-0c50858d01EXAMPLE" } Sample Response { "NextToken": "AAEABbrXFUcgJpmXZxxu+AD17F+5bzlsAyqrig1EXAMPLE...pYY", "WindowExecutions": [ { "WindowId": "mw-0c50858d01EXAMPLE", "WindowExecutionId": "6027b513-64fe-4cf0-be7d-1191aEXAMPLE", "Status": "IN_PROGRESS", "StartTime": "2024-08-04T11:00:00.000000-07:00" }, { "WindowId": "mw-0c50858d01EXAMPLE", "WindowExecutionId": "ff75b750-4834-4377-8f61-b3cadEXAMPLE", "Status": "SUCCESS", "StartTime": "2024-08-03T11:00:00.000000-07:00", "EndTime": "2024-08-03T11:37:21.450000-07:00" }, { "WindowId": "mw-0c50858d01EXAMPLE", "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE", "Status": "FAILED", "StatusDetails": "One or more tasks in the orchestration failed.", "StartTime": "2024-08-02T11:00:00.000000-07:00", "EndTime": "2024-08-02T11:22:36.190000-07:00" } ] } Examples API Version 2014-11-06 272 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 273 AWS Systems Manager API Reference DescribeMaintenanceWindowExecutionTaskInvocations Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "TaskId": "string", "WindowExecutionId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. Type: Array of MaintenanceWindowFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. DescribeMaintenanceWindowExecutionTaskInvocations API Version 2014-11-06 274 AWS Systems Manager Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. API Reference Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No TaskId The ID of the specific task in the maintenance window task that should be retrieved. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes WindowExecutionId The ID of the maintenance window execution the task is part of. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "NextToken": "string", "WindowExecutionTaskInvocationIdentities": [ { Response Syntax API Version 2014-11-06 275 AWS Systems Manager API Reference "EndTime": number, "ExecutionId": "string", "InvocationId": "string", "OwnerInformation": "string", "Parameters": "string", "StartTime": number, "Status": "string", "StatusDetails": "string", "TaskExecutionId": "string", "TaskType": "string", "WindowExecutionId": "string", "WindowTargetId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String WindowExecutionTaskInvocationIdentities Information about the task invocation results per invocation. Type: Array of MaintenanceWindowExecutionTaskInvocationIdentity objects Errors For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist. Response Elements API Version 2014-11-06 276 AWS Systems Manager API Reference For information about resource quotas in AWS Systems Manager, see Systems
|
systems-manager-api-058
|
systems-manager-api.pdf
| 58 |
by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String WindowExecutionTaskInvocationIdentities Information about the task invocation results per invocation. Type: Array of MaintenanceWindowExecutionTaskInvocationIdentity objects Errors For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist. Response Elements API Version 2014-11-06 276 AWS Systems Manager API Reference For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeMaintenanceWindowExecutionTaskInvocations. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowExecutionTaskInvocations Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240224T233800Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240224/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 111 { "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE", "TaskId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE" } Sample Response { "WindowExecutionTaskInvocationIdentities": [ { "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE", Examples API Version 2014-11-06 277 AWS Systems Manager API Reference "TaskExecutionId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE", "InvocationId": "0e466033-290b-4d74-9ae0-f33e3EXAMPLE", "ExecutionId": "1203cf98-5a79-4ec3-97e9-12e0bEXAMPLE", "TaskType": "RUN_COMMAND", "Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-ApplyPatchBaseline \",\"instanceIds\":[\"i-00ec29b21eEXAMPLE\",\"i-09911ddd90EXAMPLE\"],\"maxConcurrency \":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"SnapshotId\":[\"\"],\"Operation\": [\"Install\"]},\"timeoutSeconds\":600}", "Status": "SUCCESS", "StatusDetails": "Success", "StartTime": "2024-08-04T11:35:35.170000-07:00", "EndTime": "2024-08-04T11:42:11.330000-07:00" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 278 AWS Systems Manager API Reference DescribeMaintenanceWindowExecutionTasks For a given maintenance window execution, lists the tasks that were run. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "WindowExecutionId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. Type: Array of MaintenanceWindowFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer DescribeMaintenanceWindowExecutionTasks API Version 2014-11-06 279 AWS Systems Manager API Reference Valid Range: Minimum value of 10. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No WindowExecutionId The ID of the maintenance window execution whose task executions should be retrieved. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "NextToken": "string", "WindowExecutionTaskIdentities": [ { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "EndTime": number, "StartTime": number, "Status": "string", "StatusDetails": "string", "TaskArn": "string", Response Syntax API Version 2014-11-06 280 AWS Systems Manager API Reference "TaskExecutionId": "string", "TaskType": "string", "TriggeredAlarms": [ { "Name": "string", "State": "string" } ], "WindowExecutionId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String WindowExecutionTaskIdentities Information about the task executions. Type: Array of MaintenanceWindowExecutionTaskIdentity objects Errors For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. Response Elements API Version 2014-11-06 281 API Reference AWS Systems Manager HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeMaintenanceWindowExecutionTasks. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowExecutionTasks Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240224T234903Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240224/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 61 { "WindowExecutionId": "a06e9f91-3b9c-4c3e-8bd4-246ccEXAMPLE" } Sample Response { "WindowExecutionTaskIdentities": [ { "WindowExecutionId": "a06e9f91-3b9c-4c3e-8bd4-246ccEXAMPLE", "TaskExecutionId": "f407ba63-998f-4b89-8467-279fcEXAMPLE", "Status": "SUCCESS", "StartTime": "2024-08-04T11:35:35.145000-07:00", "EndTime": "2024-08-04T11:38:09.062000-07:00", Examples API Version 2014-11-06 282 AWS Systems Manager API Reference "TaskArn": "AWS-RunPatchBaseline", "TaskType": "RUN_COMMAND" } ] } See Also For more information about using this API in one of the
|
systems-manager-api-059
|
systems-manager-api.pdf
| 59 |
400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeMaintenanceWindowExecutionTasks. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowExecutionTasks Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240224T234903Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240224/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 61 { "WindowExecutionId": "a06e9f91-3b9c-4c3e-8bd4-246ccEXAMPLE" } Sample Response { "WindowExecutionTaskIdentities": [ { "WindowExecutionId": "a06e9f91-3b9c-4c3e-8bd4-246ccEXAMPLE", "TaskExecutionId": "f407ba63-998f-4b89-8467-279fcEXAMPLE", "Status": "SUCCESS", "StartTime": "2024-08-04T11:35:35.145000-07:00", "EndTime": "2024-08-04T11:38:09.062000-07:00", Examples API Version 2014-11-06 282 AWS Systems Manager API Reference "TaskArn": "AWS-RunPatchBaseline", "TaskType": "RUN_COMMAND" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 283 AWS Systems Manager API Reference DescribeMaintenanceWindows Retrieves the maintenance windows in an AWS account. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled. For example, Name=MyMaintenanceWindow and Enabled=True. Type: Array of MaintenanceWindowFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. DescribeMaintenanceWindows API Version 2014-11-06 284 AWS Systems Manager Required: No NextToken API Reference The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "NextToken": "string", "WindowIdentities": [ { "Cutoff": number, "Description": "string", "Duration": number, "Enabled": boolean, "EndDate": "string", "Name": "string", "NextExecutionTime": "string", "Schedule": "string", "ScheduleOffset": number, "ScheduleTimezone": "string", "StartDate": "string", "WindowId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Response Syntax API Version 2014-11-06 285 API Reference AWS Systems Manager Type: String WindowIdentities Information about the maintenance windows. Type: Array of MaintenanceWindowIdentity objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeMaintenanceWindows. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 2 X-Amz-Target: AmazonSSM.DescribeMaintenanceWindows X-Amz-Date: 20240312T202609Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Filters": [ { "Values": [ Errors API Version 2014-11-06 286 AWS Systems Manager API Reference "true" ], "Key": "Enabled" } ] } Sample Response { "WindowIdentities": [ { "WindowId": "mw-0c5ed765acEXAMPLE", "Name": "Windows-Testing-Maintenance-Window", "Description": "Standard maintenance windows for Test Servers", "Enabled": true, "Duration": 6, "Cutoff": 2, "Schedule": "rate(2 weeks)", "NextExecutionTime": "2024-02-24T23:52:15.099Z" }, { "WindowId": "mw-0c50858d01EXAMPLE", "Name": "Windows-Staging-Maintenance-Window", "Description": "Standard maintenance windows for Staging Servers", "Enabled": true, "Duration": 10, "Cutoff": 4, "Schedule": "cron(0 0 6 ? * MON *)", "NextExecutionTime": "2024-03-02T06:00:00.099Z" }, { "WindowId": "mw-07f80c1841EXAMPLE", "Cutoff": 4, "Name": "Windows-Production-Maintenance-Window", "Description": "Standard maintenance windows for Production Servers", "Enabled": true, "Duration": 10, "Schedule": "cron(0 0 6 ? * WED *)", "NextExecutionTime": "2024-03-05T06:00:00.099Z" } ] } Examples API Version 2014-11-06 287 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 288 AWS Systems Manager API Reference DescribeMaintenanceWindowSchedule Retrieves information about upcoming executions of a maintenance window. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ResourceType": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Filters
|
systems-manager-api-060
|
systems-manager-api.pdf
| 60 |
Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 288 AWS Systems Manager API Reference DescribeMaintenanceWindowSchedule Retrieves information about upcoming executions of a maintenance window. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ResourceType": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time. Type: Array of PatchOrchestratorFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No DescribeMaintenanceWindowSchedule API Version 2014-11-06 289 AWS Systems Manager MaxResults API Reference The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No ResourceType The type of resource you want to retrieve information about. For example, INSTANCE. Type: String Valid Values: INSTANCE | RESOURCE_GROUP Required: No Targets The managed node ID or key-value pair to retrieve information about. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No WindowId The ID of the maintenance window to retrieve information about. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Request Parameters API Version 2014-11-06 290 API Reference AWS Systems Manager Required: No Response Syntax { "NextToken": "string", "ScheduledWindowExecutions": [ { "ExecutionTime": "string", "Name": "string", "WindowId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. (You use this token in the next call.) Type: String ScheduledWindowExecutions Information about maintenance window executions scheduled for the specified time range. Type: Array of ScheduledWindowExecution objects Errors For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist. Response Syntax API Version 2014-11-06 291 AWS Systems Manager API Reference For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeMaintenanceWindowSchedule. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowSchedule Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240224T235938Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240224/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 36 { "WindowId": "mw-0c50858d01EXAMPLE" } Sample Response { "NextToken": "EXAMPLE/39c3b3042cd2aEXAMPLEAKIAIOSFODNN7EXAMPLE==", "ScheduledWindowExecutions": [ { "ExecutionTime": "2024-02-25T00:00:15.099Z", Examples API Version 2014-11-06 292 AWS Systems Manager API Reference "Name": "MyMaintenanceWindow", "WindowId": "mw-0c50858d01EXAMPLE" }, { "ExecutionTime": "2024-02-26T00:00:15.099Z", "Name": "MyMaintenanceWindow", "WindowId": "mw-0c50858d01EXAMPLE" }, { "ExecutionTime": "2024-02-27T00:00:15.099Z", "Name": "MyMaintenanceWindow", "WindowId": "mw-0c50858d01EXAMPLE" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 293 AWS Systems Manager API Reference DescribeMaintenanceWindowsForTarget Retrieves information about the maintenance window targets or tasks that a managed node is associated with. Request Syntax { "MaxResults": number, "NextToken": "string", "ResourceType": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No DescribeMaintenanceWindowsForTarget API Version 2014-11-06 294 AWS Systems Manager ResourceType API Reference The type of resource you want to retrieve information about. For example, INSTANCE. Type: String Valid Values: INSTANCE |
|
systems-manager-api-061
|
systems-manager-api.pdf
| 61 |
following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No DescribeMaintenanceWindowsForTarget API Version 2014-11-06 294 AWS Systems Manager ResourceType API Reference The type of resource you want to retrieve information about. For example, INSTANCE. Type: String Valid Values: INSTANCE | RESOURCE_GROUP Required: Yes Targets The managed node ID or key-value pair to retrieve information about. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: Yes Response Syntax { "NextToken": "string", "WindowIdentities": [ { "Name": "string", "WindowId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. (You use this token in the next call.) Type: String Response Syntax API Version 2014-11-06 295 AWS Systems Manager WindowIdentities API Reference Information about the maintenance window targets and tasks a managed node is associated with. Type: Array of MaintenanceWindowIdentityForTarget objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeMaintenanceWindowsForTarget. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowsForTarget Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T003520Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 100 { "Targets": [ { "Key": "InstanceIds", Errors API Version 2014-11-06 296 AWS Systems Manager API Reference "Values": [ "i-07782c72faEXAMPLE" ] } ], "ResourceType": "INSTANCE" } Sample Response { "WindowIdentities": [ { "Name": "MyFirstMaintenanceWindow", "WindowId": "mw-0c50858d01EXAMPLE" }, { "Name": "MySecondMaintenanceWindow", "WindowId": "mw-05aaf9f490EXAMPLE" }, { "Name": "MyThirdMaintenanceWindow", "WindowId": "mw-0ecb1226ddEXAMPLE" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2014-11-06 297 AWS Systems Manager • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 298 AWS Systems Manager API Reference DescribeMaintenanceWindowTargets Lists the targets registered with the maintenance window. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId, and OwnerInformation. Type: Array of MaintenanceWindowFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer DescribeMaintenanceWindowTargets API Version 2014-11-06 299 AWS Systems Manager API Reference Valid Range: Minimum value of 10. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No WindowId The ID of the maintenance window whose targets should be retrieved. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes Response Syntax { "NextToken": "string", "Targets": [ { "Description": "string", "Name": "string", "OwnerInformation": "string", "ResourceType": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "WindowId": "string", "WindowTargetId": "string" } Response Syntax API Version 2014-11-06 300 AWS Systems Manager ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Targets Information about the targets in the maintenance window. Type: Array of MaintenanceWindowTarget objects Errors For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas
|
systems-manager-api-062
|
systems-manager-api.pdf
| 62 |
The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Targets Information about the targets in the maintenance window. Type: Array of MaintenanceWindowTarget objects Errors For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Response Elements API Version 2014-11-06 301 AWS Systems Manager Examples Example API Reference This example illustrates one usage of DescribeMaintenanceWindowTargets. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowTargets Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T003928Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 36 { "WindowId": "mw-0c50858d01EXAMPLE" } Sample Response { "Targets": [ { "WindowId": "mw-0c50858d01EXAMPLE", "Name": "MyTargets", "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE", "ResourceType": "INSTANCE", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-02573cafcfEXAMPLE", "i-0471e04240EXAMPLE" ] } ] }, Examples API Version 2014-11-06 302 AWS Systems Manager { "WindowId": "mw-0c50858d01EXAMPLE", "WindowTargetId": "7f4813bb-df25-4e59-b34f-c9e83EXAMPLE", API Reference "ResourceType": "INSTANCE", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-07782c72faEXAMPLE" ] } ] } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 303 AWS Systems Manager API Reference DescribeMaintenanceWindowTasks Lists the tasks in a maintenance window. Note 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. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType. Type: Array of MaintenanceWindowFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. DescribeMaintenanceWindowTasks API Version 2014-11-06 304 AWS Systems Manager Required: No MaxResults API Reference The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No WindowId The ID of the maintenance window whose tasks should be retrieved. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes Response Syntax { "NextToken": "string", "Tasks": [ { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], Response Syntax API Version 2014-11-06 305 AWS Systems Manager API Reference "IgnorePollAlarmFailure": boolean }, "CutoffBehavior": "string", "Description": "string", "LoggingInfo": { "S3BucketName": "string", "S3KeyPrefix": "string", "S3Region": "string" }, "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "Priority": number, "ServiceRoleArn": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TaskArn": "string", "TaskParameters": { "string" : { "Values": [ "string" ] } }, "Type": "string", "WindowId": "string", "WindowTaskId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Response Elements API Version 2014-11-06 306 AWS Systems Manager Type: String Tasks Information about the tasks in the maintenance window. Type: Array of MaintenanceWindowTask objects Errors API Reference For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP
|
systems-manager-api-063
|
systems-manager-api.pdf
| 63 |
the string is empty. Response Elements API Version 2014-11-06 306 AWS Systems Manager Type: String Tasks Information about the tasks in the maintenance window. Type: Array of MaintenanceWindowTask objects Errors API Reference For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribeMaintenanceWindowTasks. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowTasks Content-Type: application/x-amz-json-1.1 Errors API Version 2014-11-06 307 AWS Systems Manager API Reference User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T004311Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 36 { "WindowId": "mw-0ecb1226dd7bEXAMPLE" } Sample Response { "Tasks": [ { "WindowId": "mw-0ecb1226ddEXAMPLE", "WindowTaskId": "018b31c3-2d77-4b9e-bd48-c91edEXAMPLE", "TaskArn": "AWS-RestartEC2Instance", "TaskParameters": {}, "Type": "AUTOMATION", "Description": "Restarting EC2 Instance for maintenance", "MaxConcurrency": "1", "MaxErrors": "1", "Name": "My-Automation-Example-Task", "Priority": 0, "ServiceRoleArn": "arn:aws:iam::111122223333:role/aws-service-role/ ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ] }, { "WindowId": "mw-0ecb1226ddEXAMPLE", "WindowTaskId": "1943dee0-0a17-4978-9bf4-3cc2fEXAMPLE", "TaskArn": "AWS-DisableS3BucketPublicReadWrite", "TaskParameters": {}, "Type": "AUTOMATION", Examples API Version 2014-11-06 308 AWS Systems Manager API Reference "Description": "Automation task to disable read/write access on public S3 buckets", "MaxConcurrency": "10", "MaxErrors": "5", "Name": "My-Disable-S3-Public-Read-Write-Access-Automation-Task", "Priority": 0, "ServiceRoleArn": "arn:aws:iam::111122223333:role/aws-service-role/ ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE" ] } ] } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 309 AWS Systems Manager DescribeOpsItems API Reference Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use AWS Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide. Request Syntax { "MaxResults": number, "NextToken": "string", "OpsItemFilters": [ { "Key": "string", "Operator": "string", "Values": [ "string" ] } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No DescribeOpsItems API Version 2014-11-06 310 AWS Systems Manager NextToken API Reference A token to start the list. Use this token to get the next set of results. Type: String Required: No OpsItemFilters One or more filters to limit the response. • Key: CreatedTime Operations: GreaterThan, LessThan • Key: LastModifiedBy Operations: Contains, Equals • Key: LastModifiedTime Operations: GreaterThan, LessThan • Key: Priority Operations: Equals • Key: Source Operations: Contains, Equals • Key: Status Operations: Equals • Key: Title* Operations: Equals,Contains • Key: OperationalData** Operations: Equals • Key: OperationalDataKey Operations: Equals • Key: OperationalDataValue Request Parameters API Version 2014-11-06 311 AWS Systems Manager API Reference Operations: Equals, Contains • Key: OpsItemId Operations: Equals • Key: ResourceId Operations: Contains • Key: AutomationId Operations: Equals • Key: AccountId Operations: Equals *The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit. **If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"} Type: Array of OpsItemFilter objects Required: No Response Syntax { "NextToken": "string", "OpsItemSummaries": [ { "ActualEndTime": number, "ActualStartTime": number, "Category": "string", "CreatedBy": "string", "CreatedTime": number, "LastModifiedBy": "string", "LastModifiedTime": number, "OperationalData": { "string" : { "Type": "string", Response Syntax API Version 2014-11-06 312 AWS Systems Manager API Reference "Value": "string" } }, "OpsItemId": "string", "OpsItemType": "string", "PlannedEndTime": number, "PlannedStartTime": number, "Priority": number, "Severity": "string", "Source": "string", "Status": "string", "Title": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token
|
systems-manager-api-064
|
systems-manager-api.pdf
| 64 |
"OpsItemSummaries": [ { "ActualEndTime": number, "ActualStartTime": number, "Category": "string", "CreatedBy": "string", "CreatedTime": number, "LastModifiedBy": "string", "LastModifiedTime": number, "OperationalData": { "string" : { "Type": "string", Response Syntax API Version 2014-11-06 312 AWS Systems Manager API Reference "Value": "string" } }, "OpsItemId": "string", "OpsItemType": "string", "PlannedEndTime": number, "PlannedStartTime": number, "Priority": number, "Severity": "string", "Source": "string", "Status": "string", "Title": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String OpsItemSummaries A list of OpsItems. Type: Array of OpsItemSummary objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Response Elements API Version 2014-11-06 313 API Reference AWS Systems Manager Examples Example This example illustrates one usage of DescribeOpsItems. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeOpsItems Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240401T163154Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 80 { "OpsItemFilters": [ { "Key": "Status", "Values": [ "Open" ], "Operator": "Equal" } ] } Sample Response { "OpsItemSummaries": [ { "CreatedBy": "arn:aws:iam::111122223333:user/example", "CreatedTime": 1585757579.218, "LastModifiedBy": "arn:aws:iam::111122223333:user/example", "LastModifiedTime": 1585757579.218, "OpsItemId": "oi-1f050EXAMPLE", Examples API Version 2014-11-06 314 AWS Systems Manager API Reference "Source": "SSM", "Status": "Open", "Title": "DocumentDeleted" }, { "Category": "Availability", "CreatedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/ af3935bb93783f02aeea51784EXAMPLE", "CreatedTime": 1582701517.193, "LastModifiedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/ af3935bb93783f02aeea51784EXAMPLE", "LastModifiedTime": 1582701517.193, "OperationalData": { "/aws/dedup": { "Type": "SearchableString", "Value": "{\"dedupString\":\"SSMOpsItems-SSM-maintenance-window- execution-failed\"}" }, "/aws/resources": { "Type": "SearchableString", "Value": "[{\"arn\":\"arn:aws:ssm:us- east-2:111122223333:maintenancewindow/mw-0e357ebdc6EXAMPLE\"}]" } }, "OpsItemId": "oi-f99f2EXAMPLE", "Severity": "3", "Source": "SSM", "Status": "Open", "Title": "SSM Maintenance Window execution failed" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2014-11-06 315 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 316 AWS Systems Manager DescribeParameters API Reference Lists the parameters in your AWS account or the parameters shared with you when you enable the Shared option. Request results are returned on a best-effort basis. If you specify 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. Important If you change the AWS 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, DescribeParameters retrieves whatever the original key alias was referencing. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ParameterFilters": [ { "Key": "string", "Option": "string", "Values": [ "string" ] } ], "Shared": boolean } DescribeParameters API Version 2014-11-06 317 AWS Systems Manager Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters This data type is deprecated. Instead, use ParameterFilters. Type: Array of ParametersFilter objects Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No ParameterFilters Filters to limit the request results. Type: Array of ParameterStringFilter objects Required: No Shared Lists parameters that are shared with you. Request Parameters API Version 2014-11-06 318 AWS Systems Manager Note API Reference By default when using this option, the command returns parameters that have been shared using a standard AWS Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated AWS RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the AWS RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing parameters, see Working with shared parameters in the AWS Systems Manager User Guide.
|
systems-manager-api-065
|
systems-manager-api.pdf
| 65 |
Lists parameters that are shared with you. Request Parameters API Version 2014-11-06 318 AWS Systems Manager Note API Reference By default when using this option, the command returns parameters that have been shared using a standard AWS Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated AWS RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the AWS RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing parameters, see Working with shared parameters in the AWS Systems Manager User Guide. Type: Boolean Required: No Response Syntax { "NextToken": "string", "Parameters": [ { "AllowedPattern": "string", "ARN": "string", "DataType": "string", "Description": "string", "KeyId": "string", "LastModifiedDate": number, "LastModifiedUser": "string", "Name": "string", "Policies": [ { "PolicyStatus": "string", "PolicyText": "string", "PolicyType": "string" } ], "Tier": "string", "Type": "string", "Version": number Response Syntax API Version 2014-11-06 319 AWS Systems Manager } ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. Type: String Parameters Parameters returned by the request. Type: Array of ParameterMetadata objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidFilterOption The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel. HTTP Status Code: 400 Response Elements API Version 2014-11-06 320 AWS Systems Manager InvalidFilterValue The filter value isn't valid. Verify the value and try again. API Reference HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribeParameters. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 95 X-Amz-Target: AmazonSSM.DescribeParameters X-Amz-Date: 20240316T010204Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "ParameterFilters": [ { "Values": [ "String" ], "Key": "Type" }, { "Values": [ "/Branch312" Examples API Version 2014-11-06 321 API Reference AWS Systems Manager ], "Key": "Name" } ] } Sample Response { "Parameters": [ { "LastModifiedDate": 1521160696.821, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "/Branch312/Dev/Engineer1", "Policies": [], "Type": "String", "Version": 1, "Tier": "Standard" }, { "LastModifiedDate": 1521160709.358, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "/Branch312/Dev/Engineer2", "Policies": [], "Type": "String", "Version": 1, "Tier": "Standard" }, { "LastModifiedDate": 1521160717.945, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "/Branch312/Dev/Engineer3", "Policies": [], "Type": "String", "Version": 1, "Tier": "Standard" }, { "LastModifiedDate": 1521160747.499, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mary.Major", "Name": "/Branch312/Dev/Intern", "Policies": [ { Examples API Version 2014-11-06 322 AWS Systems Manager API Reference "PolicyStatus": "Pending", "PolicyText": "{\"Type\":\"Expiration\",\"Version\":\"1.0\", \"Attributes\":{\"Timestamp\":\"2024-03-31T17:00:00Z\"}}", "PolicyType": "Expiration" }, { "PolicyStatus": "Pending", "PolicyText": "{\"Type\":\"ExpirationNotification\",\"Version\": \"1.0\",\"Attributes\":{\"Before\":\"14\",\"Unit\":\"Days\"}}", "PolicyType": "ExpirationNotification" } ], "Type": "String", "Version": 1, "Tier": "Standard" }, { "LastModifiedDate": 1521160588.291, "LastModifiedUser": "arn:aws:iam::111122223333:user/John.Stiles", "Name": "/Branch312/Dev/TeamLead", "Policies": [], "Type": "String", "Version": 1, "Tier": "Standard" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2014-11-06 323 AWS Systems Manager • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 324 AWS Systems Manager API Reference DescribePatchBaselines Lists the patch baselines in your AWS account. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Each element in the array is a structure containing a key-value pair. Supported keys for DescribePatchBaselines include the following: • NAME_PREFIX Sample values: AWS- | My- • OWNER Sample values: AWS | Self • OPERATING_SYSTEM Sample values: AMAZON_LINUX | SUSE | WINDOWS Type: Array of PatchOrchestratorFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. DescribePatchBaselines API Version 2014-11-06 325 API Reference AWS Systems Manager Required: No MaxResults The maximum number of patch baselines to return (per page). Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "BaselineIdentities": [ { "BaselineDescription": "string", "BaselineId": "string", "BaselineName": "string", "DefaultBaseline": boolean, "OperatingSystem": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The
|
systems-manager-api-066
|
systems-manager-api.pdf
| 66 |
of 5 items. DescribePatchBaselines API Version 2014-11-06 325 API Reference AWS Systems Manager Required: No MaxResults The maximum number of patch baselines to return (per page). Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "BaselineIdentities": [ { "BaselineDescription": "string", "BaselineId": "string", "BaselineName": "string", "DefaultBaseline": boolean, "OperatingSystem": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BaselineIdentities An array of PatchBaselineIdentity elements. Response Syntax API Version 2014-11-06 326 AWS Systems Manager API Reference Type: Array of PatchBaselineIdentity objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribePatchBaselines. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 2 X-Amz-Target: AmazonSSM.DescribePatchBaselines X-Amz-Date: 20240309T024139Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE {} Errors API Version 2014-11-06 327 AWS Systems Manager Sample Response { "BaselineIdentities": [ { API Reference "BaselineDescription": "Default Patch Baseline for Suse Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/ pb-07d8884178EXAMPLE", "BaselineName": "AWS-SuseDefaultPatchBaseline", "DefaultBaseline": true, "OperatingSystem": "SUSE" }, { "BaselineDescription": "Default Patch Baseline Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/ pb-09ca3fb51fEXAMPLE", "BaselineName": "AWS-DefaultPatchBaseline", "DefaultBaseline": true, "OperatingSystem": "WINDOWS" }, { "BaselineDescription": "Default Patch Baseline for Amazon Linux Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/ pb-0c10e65780EXAMPLE", "BaselineName": "AWS-AmazonLinuxDefaultPatchBaseline", "DefaultBaseline": true, "OperatingSystem": "AMAZON_LINUX" }, { "BaselineDescription": "Default Patch Baseline for Ubuntu Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/ pb-0c7e89f711EXAMPLE", "BaselineName": "AWS-UbuntuDefaultPatchBaseline", "DefaultBaseline": true, "OperatingSystem": "UBUNTU" }, { "BaselineDescription": "Default Patch Baseline for Redhat Enterprise Linux Provided by AWS.", "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/ pb-0cbb3a633dEXAMPLE", "BaselineName": "AWS-RedHatDefaultPatchBaseline", Examples API Version 2014-11-06 328 AWS Systems Manager API Reference "DefaultBaseline": true, "OperatingSystem": "REDHAT_ENTERPRISE_LINUX" } // There may be more content here ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 329 AWS Systems Manager API Reference DescribePatchGroups Lists all patch groups that have been registered with patch baselines. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters Each element in the array is a structure containing a key-value pair. Supported keys for DescribePatchGroups include the following: • NAME_PREFIX Sample values: AWS- | My-. • OPERATING_SYSTEM Sample values: AMAZON_LINUX | SUSE | WINDOWS Type: Array of PatchOrchestratorFilter objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No DescribePatchGroups API Version 2014-11-06 330 AWS Systems Manager MaxResults API Reference The maximum number of patch groups to return (per page). Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "Mappings": [ { "BaselineIdentity": { "BaselineDescription": "string", "BaselineId": "string", "BaselineName": "string", "DefaultBaseline": boolean, "OperatingSystem": "string" }, "PatchGroup": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2014-11-06 331 AWS Systems Manager Mappings Each entry in the array contains: API Reference • PatchGroup: string (between 1 and 256 characters. Regex: ^([\p{L}\p{Z}\p{N}_.:/=+ \-@]*)$) • PatchBaselineIdentity: A PatchBaselineIdentity element. Type: Array of PatchGroupPatchBaselineMapping objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribePatchGroups. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 2 X-Amz-Target: AmazonSSM.DescribePatchGroups X-Amz-Date: 20240308T211212Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Errors API Version 2014-11-06 332 AWS Systems Manager API Reference Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/
|
systems-manager-api-067
|
systems-manager-api.pdf
| 67 |
of PatchGroupPatchBaselineMapping objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribePatchGroups. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 2 X-Amz-Target: AmazonSSM.DescribePatchGroups X-Amz-Date: 20240308T211212Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Errors API Version 2014-11-06 332 AWS Systems Manager API Reference Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE {} Sample Response { "Mappings": [ { "PatchGroup": "Database Servers", "BaselineIdentity": { "BaselineName": "Windows-Server-2012R2", "DefaultBaseline": false, "BaselineDescription": "Windows Server 2012 R2, Important and Critical security updates", "BaselineId": "pb-0c4e592064EXAMPLE", "OperatingSystem": "WINDOWS" } }, { "PatchGroup": "Production", "BaselineIdentity": { "BaselineName": "Windows-Server-2012R2", "DefaultBaseline": false, "BaselineDescription": "Windows Server 2012 R2, Important and Critical security updates", "BaselineId": "pb-0c4e592064EXAMPLE", "OperatingSystem": "WINDOWS" } }, { "PatchGroup": "Production", "BaselineIdentity": { "BaselineName": "Amazon-Linux-Production", "DefaultBaseline": false, "BaselineDescription": "Patch baseline used for production instances", "BaselineId": "pb-022cbaf99cEXAMPLE", "OperatingSystem": "AMAZON_LINUX" } }, Examples API Version 2014-11-06 333 API Reference AWS Systems Manager { "PatchGroup": "Production", "BaselineIdentity": { "BaselineName": "RHEL-ZeroDay-Critical", "DefaultBaseline": false, "BaselineId": "pb-0ea5bc85f4EXAMPLE", "OperatingSystem": "REDHAT_ENTERPRISE_LINUX" } }, { "PatchGroup": "Production-Demo", "BaselineIdentity": { "BaselineName": "Only-Security-Patches", "DefaultBaseline": false, "BaselineDescription": "Security updates for all versions of Windows", "BaselineId": "pb-08521bdf9eEXAMPLE", "OperatingSystem": "WINDOWS" } } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 334 AWS Systems Manager API Reference DescribePatchGroupState Returns high-level aggregated patch compliance state information for a patch group. Request Syntax { "PatchGroup": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. PatchGroup The name of the patch group whose patch snapshot should be retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes Response Syntax { "Instances": number, "InstancesWithAvailableSecurityUpdates": number, "InstancesWithCriticalNonCompliantPatches": number, "InstancesWithFailedPatches": number, "InstancesWithInstalledOtherPatches": number, "InstancesWithInstalledPatches": number, "InstancesWithInstalledPendingRebootPatches": number, "InstancesWithInstalledRejectedPatches": number, "InstancesWithMissingPatches": number, "InstancesWithNotApplicablePatches": number, DescribePatchGroupState API Version 2014-11-06 335 AWS Systems Manager API Reference "InstancesWithOtherNonCompliantPatches": number, "InstancesWithSecurityNonCompliantPatches": number, "InstancesWithUnreportedNotApplicablePatches": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Instances The number of managed nodes in the patch group. Type: Integer InstancesWithAvailableSecurityUpdates The number of managed nodes for which security-related patches are available but not approved because because they didn't meet the patch baseline requirements. For example, an updated version of a patch might have been released before the specified auto-approval period was over. Applies to Windows Server managed nodes only. Type: Integer InstancesWithCriticalNonCompliantPatches The number of managed nodes where patches that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT. Type: Integer InstancesWithFailedPatches The number of managed nodes with patches from the patch baseline that failed to install. Type: Integer InstancesWithInstalledOtherPatches The number of managed nodes with patches installed that aren't defined in the patch baseline. Response Elements API Version 2014-11-06 336 AWS Systems Manager Type: Integer InstancesWithInstalledPatches The number of managed nodes with installed patches. Type: Integer InstancesWithInstalledPendingRebootPatches API Reference The number of managed nodes with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these managed nodes is NON_COMPLIANT. Type: Integer InstancesWithInstalledRejectedPatches The number of managed nodes with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list. Note If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero). Type: Integer InstancesWithMissingPatches The number of managed nodes with missing patches from the patch baseline. Type: Integer InstancesWithNotApplicablePatches The number of managed nodes with patches that aren't applicable. Type: Integer InstancesWithOtherNonCompliantPatches The number of managed nodes with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT. Response Elements API Version 2014-11-06 337 AWS Systems Manager Type: Integer InstancesWithSecurityNonCompliantPatches API Reference The number of managed nodes where patches that are specified as Security in
|
systems-manager-api-068
|
systems-manager-api.pdf
| 68 |
RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero). Type: Integer InstancesWithMissingPatches The number of managed nodes with missing patches from the patch baseline. Type: Integer InstancesWithNotApplicablePatches The number of managed nodes with patches that aren't applicable. Type: Integer InstancesWithOtherNonCompliantPatches The number of managed nodes with patches installed that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT. Response Elements API Version 2014-11-06 337 AWS Systems Manager Type: Integer InstancesWithSecurityNonCompliantPatches API Reference The number of managed nodes where patches that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT. Type: Integer InstancesWithUnreportedNotApplicablePatches The number of managed nodes with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a tool in AWS Systems Manager. Type: Integer Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of DescribePatchGroupState. Sample Request POST / HTTP/1.1 Errors API Version 2014-11-06 338 AWS Systems Manager API Reference Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 33 X-Amz-Target: AmazonSSM.DescribePatchGroupState X-Amz-Date: 20240308T205757Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "PatchGroup": "mypatchgroup" } Sample Response { "Instances": 12, "InstancesWithCriticalNonCompliantPatches": 1, "InstancesWithFailedPatches": 2, "InstancesWithInstalledOtherPatches": 3, "InstancesWithInstalledPatches": 12, "InstancesWithInstalledPendingRebootPatches": 2, "InstancesWithInstalledRejectedPatches": 1, "InstancesWithMissingPatches": 3, "InstancesWithNotApplicablePatches": 0, "InstancesWithOtherNonCompliantPatches": 0, "InstancesWithSecurityNonCompliantPatches": 1, "InstancesWithUnreportedNotApplicablePatches": 0 } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2014-11-06 339 AWS Systems Manager • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 340 AWS Systems Manager API Reference DescribePatchProperties 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: AMAZON_LINUX Valid properties: PRODUCT | CLASSIFICATION | SEVERITY AMAZON_LINUX_2 Valid properties: PRODUCT | CLASSIFICATION | SEVERITY AMAZON_LINUX_2023 Valid properties: PRODUCT | CLASSIFICATION | SEVERITY CENTOS Valid properties: PRODUCT | CLASSIFICATION | SEVERITY DEBIAN Valid properties: PRODUCT | PRIORITY MACOS Valid properties: PRODUCT | CLASSIFICATION ORACLE_LINUX Valid properties: PRODUCT | CLASSIFICATION | SEVERITY REDHAT_ENTERPRISE_LINUX Valid properties: PRODUCT | CLASSIFICATION | SEVERITY SUSE Valid properties: PRODUCT | CLASSIFICATION | SEVERITY UBUNTU Valid properties: PRODUCT | PRIORITY DescribePatchProperties API Version 2014-11-06 341 AWS Systems Manager WINDOWS API Reference Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY Request Syntax { "MaxResults": number, "NextToken": "string", "OperatingSystem": "string", "PatchSet": "string", "Property": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No OperatingSystem The operating system type for which to list patches. Type: String Request Syntax API Version 2014-11-06 342 AWS Systems Manager API Reference Valid Values: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023 Required: Yes PatchSet Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems. Type: String Valid Values: OS | APPLICATION Required: No Property The patch property for which you want to view patch details. Type: String Valid Values: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY | PRIORITY | SEVERITY Required: Yes Response Syntax { "NextToken": "string", "Properties": [ { "string" : "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2014-11-06 343 AWS Systems Manager API Reference The
|
systems-manager-api-069
|
systems-manager-api.pdf
| 69 |
patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems. Type: String Valid Values: OS | APPLICATION Required: No Property The patch property for which you want to view patch details. Type: String Valid Values: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY | PRIORITY | SEVERITY Required: Yes Response Syntax { "NextToken": "string", "Properties": [ { "string" : "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2014-11-06 343 AWS Systems Manager API Reference The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. (You use this token in the next call.) Type: String Properties A list of the properties for patches matching the filter request parameters. Type: Array of string to string maps Key Length Constraints: Minimum length of 1. Maximum length of 64. Value Length Constraints: Minimum length of 0. Maximum length of 4096. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of DescribePatchProperties. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 95 X-Amz-Target: AmazonSSM.DescribePatchProperties X-Amz-Date: 20240312T010204Z Errors API Version 2014-11-06 344 AWS Systems Manager API Reference User-Agent: aws-cli/1.16.96 Python/2.7.15 Windows/10 botocore/1.12.86 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "OperatingSystem": "Windows", "Property": "PRODUCT", "PatchSet": "OS" } Sample Response { "Properties": [ { "Name": "WindowsServer2012", "ProductFamily": "Windows" }, { "Name": "WindowsServer2012R2", "ProductFamily": "Windows" }, { "Name": "WindowsServer2016", "ProductFamily": "Windows" }, { "Name": "WindowsServer2019", "ProductFamily": "Windows" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2014-11-06 345 API Reference AWS Systems Manager • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 346 AWS Systems Manager DescribeSessions API Reference Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days. Request Syntax { "Filters": [ { "key": "string", "value": "string" } ], "MaxResults": number, "NextToken": "string", "State": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more filters to limit the type of sessions returned by the request. Type: Array of SessionFilter objects Array Members: Minimum number of 1 item. Maximum number of 6 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer DescribeSessions API Version 2014-11-06 347 AWS Systems Manager API Reference Valid Range: Minimum value of 1. Maximum value of 200. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No State The session status to retrieve a list of sessions for. For example, "Active". Type: String Valid Values: Active | History Required: Yes Response Syntax { "NextToken": "string", "Sessions": [ { "Details": "string", "DocumentName": "string", "EndDate": number, "MaxSessionDuration": "string", "OutputUrl": { "CloudWatchOutputUrl": "string", "S3OutputUrl": "string" }, "Owner": "string", "Reason": "string", "SessionId": "string", "StartDate": number, "Status": "string", "Target": "string" } Response Syntax API Version 2014-11-06 348 AWS Systems Manager ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Sessions A list of sessions meeting the request parameters. Type: Array of Session objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Response Elements API Version 2014-11-06 349 API Reference AWS Systems Manager Examples Example This example illustrates one usage of DescribeSessions. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeSessions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240221T175636Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 20 { "State": "History" } Sample Response { "Sessions": [ { "EndDate": 1582069847.807, "OutputUrl":
|
systems-manager-api-070
|
systems-manager-api.pdf
| 70 |
common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Response Elements API Version 2014-11-06 349 API Reference AWS Systems Manager Examples Example This example illustrates one usage of DescribeSessions. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeSessions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240221T175636Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 20 { "State": "History" } Sample Response { "Sessions": [ { "EndDate": 1582069847.807, "OutputUrl": { "S3OutputUrl": "https://us-east-2.console.aws.amazon.com/s3/object/ amzn-s3-demo-bucket/session-data/Mary-Major-0ab177d470EXAMPLE.log" }, "Owner": "arn:aws:iam::111122223333:user/Mary-Major", "SessionId": "Mary-Major-0ab177d470EXAMPLE", "StartDate": 1582068633.188, "Status": "Terminated", "Target": "i-07782c72faEXAMPLE" } // There may be more content here ] Examples API Version 2014-11-06 350 AWS Systems Manager } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 351 AWS Systems Manager API Reference DisassociateOpsItemRelatedItem 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 tool in AWS Systems Manager. Request Syntax { "AssociationId": "string", "OpsItemId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationId The ID of the association for which you want to delete an association between the OpsItem and a related item. Type: String Required: Yes OpsItemId The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DisassociateOpsItemRelatedItem API Version 2014-11-06 352 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 OpsItemConflictException The specified OpsItem is in the process of being deleted. HTTP Status Code: 400 OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again. HTTP Status Code: 400 OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again. HTTP Status Code: 400 OpsItemRelatedItemAssociationNotFoundException The association wasn't found using the parameters you specified in the call. Verify the information and try again. HTTP Status Code: 400 Examples Example This example illustrates one usage of DisassociateOpsItemRelatedItem. Sample Request POST / HTTP/1.1 Errors API Version 2014-11-06 353 AWS Systems Manager API Reference Host: ssm.us-east-1.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DisassociateOpsItemRelatedItem Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/ssm.disassociate-ops-item-related-item X-Amz-Date: 20240910T182919Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240910/us- east-1/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 89 { "OpsItemId": "oi-f99f2EXAMPLE", "AssociationId": "e2036148-cccb-490e-ac2a-390e5EXAMPLE" } Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 354 AWS Systems Manager GetAccessToken Returns a credentials set to be used with just-in-time node access. API Reference Request Syntax { "AccessRequestId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AccessRequestId The ID of a just-in-time node access request. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: Yes Response Syntax { "AccessRequestStatus": "string", "Credentials": { "AccessKeyId": "string", "ExpirationTime": number, "SecretAccessKey": "string", "SessionToken": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetAccessToken API Version 2014-11-06 355 AWS Systems Manager API Reference The following data is returned in JSON format by the service. AccessRequestStatus The status of the access request. Type: String Valid Values: Approved | Rejected | Revoked | Expired | Pending Credentials The temporary security credentials which can be used to start just-in-time node access sessions. Type: Credentials object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The requester doesn't have permissions to perform the requested operation. HTTP Status Code: 400 InternalServerError An error occurred on the server side.
|
systems-manager-api-071
|
systems-manager-api.pdf
| 71 |
HTTP 200 response. GetAccessToken API Version 2014-11-06 355 AWS Systems Manager API Reference The following data is returned in JSON format by the service. AccessRequestStatus The status of the access request. Type: String Valid Values: Approved | Rejected | Revoked | Expired | Pending Credentials The temporary security credentials which can be used to start just-in-time node access sessions. Type: Credentials object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The requester doesn't have permissions to perform the requested operation. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 ResourceNotFoundException The specified parameter to be shared could not be found. HTTP Status Code: 400 ThrottlingException The request or operation couldn't be performed because the service is throttling requests. HTTP Status Code: 400 ValidationException The request isn't valid. Verify that you entered valid contents for the command and try again. Errors API Version 2014-11-06 356 AWS Systems Manager HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 357 AWS Systems Manager API Reference GetAutomationExecution Get detailed information about a particular Automation execution. Request Syntax { "AutomationExecutionId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AutomationExecutionId The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated. Type: String Length Constraints: Fixed length of 36. Required: Yes Response Syntax { "AutomationExecution": { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "AssociationId": "string", GetAutomationExecution API Version 2014-11-06 358 AWS Systems Manager API Reference "AutomationExecutionId": "string", "AutomationExecutionStatus": "string", "AutomationSubtype": "string", "ChangeRequestName": "string", "CurrentAction": "string", "CurrentStepName": "string", "DocumentName": "string", "DocumentVersion": "string", "ExecutedBy": "string", "ExecutionEndTime": number, "ExecutionStartTime": number, "FailureMessage": "string", "MaxConcurrency": "string", "MaxErrors": "string", "Mode": "string", "OpsItemId": "string", "Outputs": { "string" : [ "string" ] }, "Parameters": { "string" : [ "string" ] }, "ParentAutomationExecutionId": "string", "ProgressCounters": { "CancelledSteps": number, "FailedSteps": number, "SuccessSteps": number, "TimedOutSteps": number, "TotalSteps": number }, "ResolvedTargets": { "ParameterValues": [ "string" ], "Truncated": boolean }, "Runbooks": [ { "DocumentName": "string", "DocumentVersion": "string", "MaxConcurrency": "string", "MaxErrors": "string", "Parameters": { "string" : [ "string" ] }, "TargetLocations": [ Response Syntax API Version 2014-11-06 359 AWS Systems Manager API Reference { "Accounts": [ "string" ], "ExcludeAccounts": [ "string" ], "ExecutionRoleName": "string", "IncludeChildOrganizationUnits": boolean, "Regions": [ "string" ], "TargetLocationAlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } ], "TargetMaps": [ { "string" : [ "string" ] } ], "TargetParameterName": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } ], "ScheduledTime": number, "StepExecutions": [ { "Action": "string", Response Syntax API Version 2014-11-06 360 AWS Systems Manager API Reference "ExecutionEndTime": number, "ExecutionStartTime": number, "FailureDetails": { "Details": { "string" : [ "string" ] }, "FailureStage": "string", "FailureType": "string" }, "FailureMessage": "string", "Inputs": { "string" : "string" }, "IsCritical": boolean, "IsEnd": boolean, "MaxAttempts": number, "NextStep": "string", "OnFailure": "string", "Outputs": { "string" : [ "string" ] }, "OverriddenParameters": { "string" : [ "string" ] }, "ParentStepDetails": { "Action": "string", "Iteration": number, "IteratorValue": "string", "StepExecutionId": "string", "StepName": "string" }, "Response": "string", "ResponseCode": "string", "StepExecutionId": "string", "StepName": "string", "StepStatus": "string", "TargetLocation": { "Accounts": [ "string" ], "ExcludeAccounts": [ "string" ], "ExecutionRoleName": "string", "IncludeChildOrganizationUnits": boolean, "Regions": [ "string" ], "TargetLocationAlarmConfiguration": { "Alarms": [ Response Syntax API Version 2014-11-06 361 AWS Systems Manager API Reference { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" }, "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TimeoutSeconds": number, "TriggeredAlarms": [ { "Name": "string", "State": "string" } ], "ValidNextSteps": [ "string" ] } ], "StepExecutionsTruncated": boolean, "Target": "string", "TargetLocations": [ { "Accounts": [ "string" ], "ExcludeAccounts": [ "string" ], "ExecutionRoleName": "string", "IncludeChildOrganizationUnits": boolean, "Regions": [ "string" ], "TargetLocationAlarmConfiguration": { "Alarms": [ Response Syntax API Version 2014-11-06 362 AWS Systems Manager API Reference { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } ], "TargetLocationsURL": "string", "TargetMaps": [ { "string" : [ "string" ] } ],
|
systems-manager-api-072
|
systems-manager-api.pdf
| 72 |
"string" ] } ], "TimeoutSeconds": number, "TriggeredAlarms": [ { "Name": "string", "State": "string" } ], "ValidNextSteps": [ "string" ] } ], "StepExecutionsTruncated": boolean, "Target": "string", "TargetLocations": [ { "Accounts": [ "string" ], "ExcludeAccounts": [ "string" ], "ExecutionRoleName": "string", "IncludeChildOrganizationUnits": boolean, "Regions": [ "string" ], "TargetLocationAlarmConfiguration": { "Alarms": [ Response Syntax API Version 2014-11-06 362 AWS Systems Manager API Reference { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } ], "TargetLocationsURL": "string", "TargetMaps": [ { "string" : [ "string" ] } ], "TargetParameterName": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TriggeredAlarms": [ { "Name": "string", "State": "string" } ], "Variables": { "string" : [ "string" ] } } } Response Syntax API Version 2014-11-06 363 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AutomationExecution Detailed information about the current state of an automation execution. Type: AutomationExecution object Errors For information about the errors that are common to all actions, see Common Errors. AutomationExecutionNotFoundException There is no automation execution information for the requested automation execution ID. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of GetAutomationExecution. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetAutomationExecution Content-Type: application/x-amz-json-1.1 Response Elements API Version 2014-11-06 364 AWS Systems Manager API Reference User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T185532Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 65 { "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE" } Sample Response { "AutomationExecution": { "AutomationExecutionId": "8a5f5be8-5d93-437a-adbb-394f7EXAMPLE", "AutomationExecutionStatus": "Success", "DocumentName": "CreateImage", "DocumentVersion": "1", "ExecutedBy": "arn:aws:sts::111122223333:assumed-role/Example", "ExecutionEndTime": 1585062669.053, "ExecutionStartTime": 1585061570.827, "Mode": "Auto", "Outputs": {}, "Parameters": { "InstanceId": [ "i-02573cafcfEXAMPLE" ] }, "ResolvedTargets": { "ParameterValues": [], "Truncated": false }, "StepExecutions": [ { "Action": "aws:createImage", "ExecutionEndTime": 1585062668.968, "ExecutionStartTime": 1585061571.144, "Inputs": { "ImageDescription": "\"AMI for i-02573cafcfEXAMPLE created on 2020-03-24_14.52.51\"", "ImageName": "\"i-02573cafcfEXAMPLE-2020-03-24_14.52.51\"", "InstanceId": "\"i-02573cafcfEXAMPLE\"", Examples API Version 2014-11-06 365 AWS Systems Manager API Reference "NoReboot": "false" }, "OnFailure": "Abort", "Outputs": { "ImageId": [ "ami-0f4706cb37EXAMPLE" ], "ImageState": [ "available" ], "OutputPayload": [ "{\"ImageId\":\"ami-0f4706cb37EXAMPLE\",\"ImageState\": \"available\"}" ] }, "OverriddenParameters": {}, "StepExecutionId": "eff80946-356d-4128-97b2-6a0f5EXAMPLE", "StepName": "createImage", "StepStatus": "Success" } ], "StepExecutionsTruncated": false, "Targets": [] } } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2014-11-06 366 AWS Systems Manager • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 367 AWS Systems Manager GetCalendarState API Reference Gets the state of a AWS Systems Manager change calendar at the current time or a specified time. If you specify a time, 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. If you specify more than one calendar in a request, the command returns the status of 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. For more information about Change Calendar, a tool in AWS Systems Manager, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide. Request Syntax { "AtTime": "string", "CalendarNames": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AtTime (Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you don't specify a value or AtTime, the current time is used. Type: String Required: No CalendarNames The names of Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state. GetCalendarState API Version 2014-11-06 368 API Reference AWS Systems Manager Type: Array of strings Required: Yes Response Syntax { "AtTime": "string", "NextTransitionTime": "string", "State": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AtTime The time, as an ISO 8601 string, that you specified in your command. If you don't specify a time, GetCalendarState uses the current time. Type: String NextTransitionTime The time, as an ISO 8601 string,
|
systems-manager-api-073
|
systems-manager-api.pdf
| 73 |
that represent the calendar entries for which you want to get the state. GetCalendarState API Version 2014-11-06 368 API Reference AWS Systems Manager Type: Array of strings Required: Yes Response Syntax { "AtTime": "string", "NextTransitionTime": "string", "State": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AtTime The time, as an ISO 8601 string, that you specified in your command. If you don't specify a time, GetCalendarState uses the current time. Type: String NextTransitionTime The time, as an ISO 8601 string, that the calendar state will change. If the current calendar state is OPEN, NextTransitionTime indicates when the calendar state changes to CLOSED, and vice-versa. Type: String State The state of the calendar. An OPEN calendar indicates that actions are allowed to proceed, and a CLOSED calendar indicates that actions aren't allowed to proceed. Type: String Valid Values: OPEN | CLOSED Response Syntax API Version 2014-11-06 369 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentType The SSM document type isn't valid. Valid document types are described in the DocumentType property. HTTP Status Code: 400 UnsupportedCalendarException The calendar entry contained in the specified SSM document isn't supported. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetCalendarState. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetCalendarState Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240224T191829Z Errors API Version 2014-11-06 370 AWS Systems Manager API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 67 { "CalendarNames": [ "MyCalendar" ], "AtTime": "2024-02-25T19:05:47Z" } Sample Response { "AtTime": "2024-02-25T19:05:47Z", "State": "OPEN" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 371 AWS Systems Manager API Reference GetCommandInvocation Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command. GetCommandInvocation 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. Request Syntax { "CommandId": "string", "InstanceId": "string", "PluginName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CommandId (Required) The parent command ID of the invocation plugin. Type: String Length Constraints: Fixed length of 36. Required: Yes InstanceId (Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for AWS Systems Manager. GetCommandInvocation API Version 2014-11-06 372 AWS Systems Manager Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes PluginName API Reference The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like aws:RunShellScript. To find the PluginName, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list. Type: String Length Constraints: Minimum length of 4. Required: No Response Syntax { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "string", "CloudWatchOutputEnabled": boolean }, "CommandId": "string", "Comment": "string", "DocumentName": "string", "DocumentVersion": "string", "ExecutionElapsedTime": "string", "ExecutionEndDateTime": "string", "ExecutionStartDateTime": "string", "InstanceId": "string", "PluginName": "string", "ResponseCode": number, "StandardErrorContent": "string", Response Syntax API Version 2014-11-06 373 AWS Systems Manager API Reference "StandardErrorUrl": "string", "StandardOutputContent": "string", "StandardOutputUrl": "string", "Status": "string", "StatusDetails": "string" } Response Elements If the
|
systems-manager-api-074
|
systems-manager-api.pdf
| 74 |
the name of the step you want details for. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list. Type: String Length Constraints: Minimum length of 4. Required: No Response Syntax { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "string", "CloudWatchOutputEnabled": boolean }, "CommandId": "string", "Comment": "string", "DocumentName": "string", "DocumentVersion": "string", "ExecutionElapsedTime": "string", "ExecutionEndDateTime": "string", "ExecutionStartDateTime": "string", "InstanceId": "string", "PluginName": "string", "ResponseCode": number, "StandardErrorContent": "string", Response Syntax API Version 2014-11-06 373 AWS Systems Manager API Reference "StandardErrorUrl": "string", "StandardOutputContent": "string", "StandardOutputUrl": "string", "Status": "string", "StatusDetails": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CloudWatchOutputConfig Amazon CloudWatch Logs information where Systems Manager sent the command output. Type: CloudWatchOutputConfig object CommandId The parent command ID of the invocation plugin. Type: String Length Constraints: Fixed length of 36. Comment The comment text for the command. Type: String Length Constraints: Maximum length of 100. DocumentName The name of the document that was run. For example, AWS-RunShellScript. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ DocumentVersion The Systems Manager document (SSM document) version used in the request. Response Elements API Version 2014-11-06 374 AWS Systems Manager Type: String Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) ExecutionElapsedTime Duration since ExecutionStartDateTime. Type: String API Reference Pattern: ^([\-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]| 3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}| 3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00) ([\.,]\d(?!:))?)?(\17[0-5]\d([\.,]\d)?)?([zZ]|([\-])([01]\d|2[0-3]):? ([0-5]\d)?)?)?)?$ ExecutionEndDateTime The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter. aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z If the plugin hasn't started to run, the string is empty. Type: String Pattern: ^([\-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]| 3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}| 3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00) ([\.,]\d(?!:))?)?(\17[0-5]\d([\.,]\d)?)?([zZ]|([\-])([01]\d|2[0-3]):? ([0-5]\d)?)?)?)?$ ExecutionStartDateTime The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter. aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z Response Elements API Version 2014-11-06 375 AWS Systems Manager API Reference If the plugin hasn't started to run, the string is empty. Type: String Pattern: ^([\-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]| 3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}| 3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00) ([\.,]\d(?!:))?)?(\17[0-5]\d([\.,]\d)?)?([zZ]|([\-])([01]\d|2[0-3]):? ([0-5]\d)?)?)?)?$ InstanceId The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for AWS Systems Manager. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) PluginName The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin. Type: String Length Constraints: Minimum length of 4. ResponseCode The error level response code for the plugin script. If the response code is -1, then the command hasn't started running on the managed node, or it wasn't received by the node. Type: Integer StandardErrorContent The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, then this string is empty. Type: String Length Constraints: Maximum length of 8000. Response Elements API Version 2014-11-06 376 AWS Systems Manager StandardErrorUrl API Reference The URL for the complete text written by the plugin to stderr. If the command hasn't finished running, then this string is empty. Type: String StandardOutputContent The first 24,000 characters written by the plugin to stdout. If the command hasn't finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty. Type: String Length Constraints: Maximum length of 24000. StandardOutputUrl The URL for the complete text written by the plugin to stdout in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty. Type: String Status The status of this invocation plugin. This status can be different than StatusDetails. Type: String Valid Values: Pending | InProgress | Delayed | Success | Cancelled | TimedOut | Failed | Cancelling StatusDetails A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: • Pending: The command hasn't been sent to the managed node. • In Progress: The command has been sent to the managed node but hasn't reached a terminal state. Response Elements API Version 2014-11-06 377 AWS Systems Manager API Reference • Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again. • Success: The command or plugin ran successfully. This is a terminal state. • Delivery Timed Out: The
|
systems-manager-api-075
|
systems-manager-api.pdf
| 75 |
hasn't been sent to the managed node. • In Progress: The command has been sent to the managed node but hasn't reached a terminal state. Response Elements API Version 2014-11-06 377 AWS Systems Manager API Reference • Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again. • Success: The command or plugin ran successfully. This is a terminal state. • Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. • Execution Timed Out: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. • Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. • Cancelled: The command was terminated before it was completed. This is a terminal state. • Undeliverable: The command can't be delivered to the managed node. The node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Errors API Version 2014-11-06 378 AWS Systems Manager InvalidCommandId API Reference The specified command ID isn't valid. Verify the ID and try again. HTTP Status Code: 400 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidPluginName The plugin name isn't valid. HTTP Status Code: 400 InvocationDoesNotExist The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node ID and try again. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetCommandInvocation. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetCommandInvocation Examples API Version 2014-11-06 379 AWS Systems Manager API Reference Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240220T235111Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 90 { "CommandId": "32d70fe0-ddbc-4a4e-943f-ffcbcEXAMPLE", "InstanceId": "i-02573cafcfEXAMPLE" } Sample Response { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false }, "CommandId": "32d70fe0-ddbc-4a4e-943f-ffcbcEXAMPLE", "Comment": "b48291dd-ba76-43e0-b9df-13e11ddaac26:6960febb-2907-4b59-8e1a- d6ce8EXAMPLE", "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "", "ExecutionElapsedTime": "PT44.002S", "ExecutionEndDateTime": "2024-02-20T23:35:26.758Z", "ExecutionStartDateTime": "2024-02-20T23:34:42.758Z", "InstanceId": "i-02573cafcfEXAMPLE", "PluginName": "aws:updateSsmAgent", "ResponseCode": 0, "StandardErrorContent": "", "StandardErrorUrl": "", "StandardOutputContent": "Updating amazon-ssm-agent from 2.3.842.0 to latest \nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us- east-2/ssm-agent-manifest.json \nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us- east-2/amazon-ssm-agent-updater/2.3.871.0/amazon-ssm-agent-updater-windows-amd64.zip \nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us- east-2/amazon-ssm-agent/2.3.842.0/amazon-ssm-agent-windows-amd64.zip \nSuccessfully downloaded https://s3.us-east-2.amazonaws.com/amazon-ssm-us- east-2/amazon-ssm-agent/2.3.871.0/amazon-ssm-agent-windows-amd64.zip \nInitiating amazon-ssm-agent update to 2.3.871.0 Examples API Version 2014-11-06 380 AWS Systems Manager API Reference \namazon-ssm-agent updated successfully to 2.3.871.0", "StandardOutputUrl": "", "Status": "Success", "StatusDetails": "Success" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 381 AWS Systems Manager API Reference GetConnectionStatus Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections. Request Syntax { "Target": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Target The managed node ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 400. Required: Yes Response Syntax {
|
systems-manager-api-076
|
systems-manager-api.pdf
| 76 |
V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 381 AWS Systems Manager API Reference GetConnectionStatus Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections. Request Syntax { "Target": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Target The managed node ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 400. Required: Yes Response Syntax { "Status": "string", "Target": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetConnectionStatus API Version 2014-11-06 382 API Reference AWS Systems Manager Status The status of the connection to the managed node. Type: String Valid Values: connected | notconnected Target The ID of the managed node to check connection status. Type: String Length Constraints: Minimum length of 1. Maximum length of 400. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of GetConnectionStatus. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetConnectionStatus Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240221T180655Z Errors API Version 2014-11-06 383 AWS Systems Manager API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 33 { "Target": "i-02573cafcfEXAMPLE" } Sample Response { "Status": "connected", "Target": "i-02573cafcfEXAMPLE" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 384 AWS Systems Manager API Reference GetDefaultPatchBaseline Retrieves the default patch baseline. AWS 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. Request Syntax { "OperatingSystem": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OperatingSystem Returns the default patch baseline for the specified operating system. Type: String Valid Values: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023 Required: No Response Syntax { "BaselineId": "string", "OperatingSystem": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetDefaultPatchBaseline API Version 2014-11-06 385 AWS Systems Manager API Reference The following data is returned in JSON format by the service. BaselineId The ID of the default patch baseline. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ OperatingSystem The operating system for the returned patch baseline. Type: String Valid Values: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023 Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of GetDefaultPatchBaseline. Sample Request POST / HTTP/1.1 Errors API Version 2014-11-06 386 AWS Systems Manager API Reference Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 35 X-Amz-Target: AmazonSSM.GetDefaultPatchBaseline X-Amz-Date: 20240309T025228Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "OperatingSystem": "AMAZON_LINUX" } Sample Response { "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/ pb-0c10e65780EXAMPLE", "OperatingSystem": "AMAZON_LINUX" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 387 AWS Systems Manager API Reference See Also API Version 2014-11-06 388 AWS Systems Manager API Reference GetDeployablePatchSnapshotForInstance 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). Note If you run the command locally, such as with
|
systems-manager-api-077
|
systems-manager-api.pdf
| 77 |
for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 387 AWS Systems Manager API Reference See Also API Version 2014-11-06 388 AWS Systems Manager API Reference GetDeployablePatchSnapshotForInstance 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). Note If you run the command locally, such as with the AWS Command Line Interface (AWS CLI), the system attempts to use your local AWS credentials and the operation fails. To avoid this, you can run the command in the AWS Systems Manager console. Use Run Command, a tool in AWS 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. Request Syntax { "BaselineOverride": { "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": number, "ApproveUntilDate": "string", "ComplianceLevel": "string", "EnableNonSecurity": boolean, "PatchFilterGroup": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] } ] } } ] }, "ApprovedPatches": [ "string" ], "ApprovedPatchesComplianceLevel": "string", "ApprovedPatchesEnableNonSecurity": boolean, "AvailableSecurityUpdatesComplianceStatus": "string", GetDeployablePatchSnapshotForInstance API Version 2014-11-06 389 AWS Systems Manager API Reference "GlobalFilters": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] } ] }, "OperatingSystem": "string", "RejectedPatches": [ "string" ], "RejectedPatchesAction": "string", "Sources": [ { "Configuration": "string", "Name": "string", "Products": [ "string" ] } ] }, "InstanceId": "string", "SnapshotId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BaselineOverride Defines the basic information about a patch baseline override. Type: BaselineOverride object Required: No InstanceId The ID of the managed node for which the appropriate patch snapshot should be retrieved. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Request Parameters API Version 2014-11-06 390 AWS Systems Manager Required: Yes SnapshotId API Reference The snapshot ID provided by the user when running AWS-RunPatchBaseline. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "InstanceId": "string", "Product": "string", "SnapshotDownloadUrl": "string", "SnapshotId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. InstanceId The managed node ID. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Product Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the managed node for the specified patch snapshot. Response Syntax API Version 2014-11-06 391 AWS Systems Manager Type: String SnapshotDownloadUrl API Reference A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot. Type: String SnapshotId The user-defined snapshot ID. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}- [0-9a-fA-F]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 UnsupportedFeatureRequiredException Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see Turning on the advanced-instances tier in the AWS Systems Manager User Guide. HTTP Status Code: 400 UnsupportedOperatingSystem The operating systems you specified isn't supported, or the operation isn't supported for the operating system. HTTP Status Code: 400 Errors API Version 2014-11-06 392 AWS Systems Manager Examples Example API Reference This example illustrates one usage of GetDeployablePatchSnapshotForInstance. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 91 X-Amz-Target: AmazonSSM.GetDeployablePatchSnapshotForInstance Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.2.12 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ ssm.get-deployable-patch-snapshot-for-instance X-Amz-Date: 20240618T204500Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240618/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "InstanceId": "i-02573cafcfEXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE" } Sample Response { "InstanceId": "i-02573cafcfEXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "Product": "AmazonLinux2018.03", "SnapshotDownloadUrl": "https://amzn-s3-demo-bucket.s3.us-east-2.amazonaws.com/ b7d801675252464bEXAMPLE--truncated--" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Examples API Version 2014-11-06 393 API Reference AWS Systems Manager • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 394 AWS Systems Manager GetDocument API Reference Gets the contents of the specified AWS Systems Manager document (SSM document). Request Syntax { "DocumentFormat": "string", "DocumentVersion": "string", "Name": "string", "VersionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in
|
systems-manager-api-078
|
systems-manager-api.pdf
| 78 |
C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 394 AWS Systems Manager GetDocument API Reference Gets the contents of the specified AWS Systems Manager document (SSM document). Request Syntax { "DocumentFormat": "string", "DocumentVersion": "string", "Name": "string", "VersionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentFormat Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format. Type: String Valid Values: YAML | JSON | TEXT Required: No DocumentVersion The document version for which you want information. Type: String Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) Required: No Name The name of the SSM document. Type: String GetDocument API Version 2014-11-06 395 AWS Systems Manager API Reference Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: Yes VersionName An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document and can't be changed. Type: String Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Required: No Response Syntax { "AttachmentsContent": [ { "Hash": "string", "HashType": "string", "Name": "string", "Size": number, "Url": "string" } ], "Content": "string", "CreatedDate": number, "DisplayName": "string", "DocumentFormat": "string", "DocumentType": "string", "DocumentVersion": "string", "Name": "string", "Requires": [ { "Name": "string", "RequireType": "string", "Version": "string", "VersionName": "string" } ], "ReviewStatus": "string", Response Syntax API Version 2014-11-06 396 AWS Systems Manager API Reference "Status": "string", "StatusInformation": "string", "VersionName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AttachmentsContent A description of the document attachments, including names, locations, sizes, and so on. Type: Array of AttachmentContent objects Content The contents of the SSM document. Type: String Length Constraints: Minimum length of 1. CreatedDate The date the SSM document was created. Type: Timestamp DisplayName The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument. Type: String Length Constraints: Maximum length of 1024. Pattern: ^[\w\.\-\:\/ ]*$ DocumentFormat The document format, either JSON or YAML. Type: String Response Elements API Version 2014-11-06 397 AWS Systems Manager API Reference Valid Values: YAML | JSON | TEXT DocumentType The document type. Type: String Valid Values: Command | Policy | Automation | Session | Package | ApplicationConfiguration | ApplicationConfigurationSchema | DeploymentStrategy | ChangeCalendar | Automation.ChangeTemplate | ProblemAnalysis | ProblemAnalysisTemplate | CloudFormation | ConformancePackTemplate | QuickSetup | ManualApprovalPolicy | AutoApprovalPolicy DocumentVersion The document version. Type: String Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) Name The name of the SSM document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Requires A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document. Type: Array of DocumentRequires objects Array Members: Minimum number of 1 item. ReviewStatus The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document. Response Elements API Version 2014-11-06 398 AWS Systems Manager API Reference Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED. Only one version of an SSM document can be in review, or PENDING, at a time. Type: String Valid Values: APPROVED | NOT_REVIEWED | PENDING | REJECTED Status The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting. Type: String Valid Values: Creating | Active | Updating | Deleting | Failed StatusInformation A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct." Type: String VersionName The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed. Type: String Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Errors API Version 2014-11-06 399 API Reference AWS Systems Manager InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentVersion The document version isn't valid or doesn't exist. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetDocument. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetDocument Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T190721Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
|
systems-manager-api-079
|
systems-manager-api.pdf
| 79 |
Type: String Pattern: ^[a-zA-Z0-9_\-.]{1,128}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Errors API Version 2014-11-06 399 API Reference AWS Systems Manager InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentVersion The document version isn't valid or doesn't exist. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetDocument. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetDocument Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T190721Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 30 { "Name": "AWS-UpdateSSMAgent" } Sample Response { "Content":"{\n \"schemaVersion\": \"1.2\",\n \"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",--truncated--n", "DocumentFormat":"JSON", Examples API Version 2014-11-06 400 AWS Systems Manager API Reference "DocumentType":"Command", "DocumentVersion":"1", "Name":"AWS-UpdateSSMAgent", "Status":"Active" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 401 AWS Systems Manager API Reference GetExecutionPreview Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources. Request Syntax { "ExecutionPreviewId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ExecutionPreviewId The ID of the existing execution preview. Type: String Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} Required: Yes Response Syntax { "EndedAt": number, "ExecutionPreview": { ... }, "ExecutionPreviewId": "string", "Status": "string", "StatusMessage": "string" } GetExecutionPreview API Version 2014-11-06 402 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. EndedAt A UTC timestamp indicating when the execution preview operation ended. Type: Timestamp ExecutionPreview Information about the changes that would be made if an execution were run. Type: ExecutionPreview object Note: This object is a Union. Only one member of this object can be specified or returned. ExecutionPreviewId The generated ID for the existing execution preview. Type: String Length Constraints: Fixed length of 36. Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA- F0-9]{12} Status The current status of the execution preview operation. Type: String Valid Values: Pending | InProgress | Success | Failed StatusMessage Supplemental information about the current status of the execution preview. Type: String Response Elements API Version 2014-11-06 403 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 ResourceNotFoundException The specified parameter to be shared could not be found. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetExecutionPreview. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetExecutionPreview Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20241125T162110Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 86 { "ExecutionPreviewId": "2f27d6e5-9676-4708-b8bd-aef0aEXAMPLE" } Example This example illustrates one usage of GetExecutionPreview. Errors API Version 2014-11-06 404 AWS Systems Manager Sample Response { "ExecutionPreviewId": "2f27d6e5-9676-4708-b8bd-aef0EXAMPLE", "EndedAt": "2024-11-25T01:50:39.424000+00:00", API Reference "Status": "Success", "ExecutionPreview": { "Automation": { "StepPreviews": { "Undetermined": 1 }, "Regions": [ "us-east-2" ], "TotalAccounts": 7 } } } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 405 AWS Systems Manager GetInventory API Reference Query inventory information. This includes managed node status, such as Stopped or Terminated. Request Syntax { "Aggregators": [ { "Aggregators": [ "InventoryAggregator" ], "Expression": "string", "Groups": [ { "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "Name": "string" } ] } ], "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ResultAttributes": [ { "TypeName": "string" } ] GetInventory API Version 2014-11-06 406 AWS Systems Manager } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Aggregators Returns counts of inventory types based on one or more expressions. For
|
systems-manager-api-080
|
systems-manager-api.pdf
| 80 |
[ "InventoryAggregator" ], "Expression": "string", "Groups": [ { "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "Name": "string" } ] } ], "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ResultAttributes": [ { "TypeName": "string" } ] GetInventory API Version 2014-11-06 406 AWS Systems Manager } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Aggregators Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried fleet. Type: Array of InventoryAggregator objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: No Filters One or more filters. Use a filter to return a more specific list of results. Type: Array of InventoryFilter objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Request Parameters API Version 2014-11-06 407 API Reference AWS Systems Manager Type: String Required: No ResultAttributes The list of inventory item types to return. Type: Array of ResultAttribute objects Array Members: Fixed number of 1 item. Required: No Response Syntax { "Entities": [ { "Data": { "string" : { "CaptureTime": "string", "Content": [ { "string" : "string" } ], "ContentHash": "string", "SchemaVersion": "string", "TypeName": "string" } }, "Id": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2014-11-06 408 AWS Systems Manager Entities API Reference Collection of inventory entities such as a collection of managed node inventory. Type: Array of InventoryResultEntity objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidAggregatorException The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported. HTTP Status Code: 400 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidInventoryGroupException The specified inventory group isn't valid. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. Errors API Version 2014-11-06 409 API Reference AWS Systems Manager HTTP Status Code: 400 InvalidResultAttributeException The specified inventory item result attribute isn't valid. HTTP Status Code: 400 InvalidTypeNameException The parameter type name isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetInventory. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetInventory Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240330T145054Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "Entities": [ { "Data": { "Id": "i-04bf6ad63bEXAMPLE", "AWS:InstanceInformation": { "TypeName": "AWS:InstanceInformation", Examples API Version 2014-11-06 410 AWS Systems Manager API Reference "SchemaVersion": "1.0", "CaptureTime": "2024-03-30T14:00:57Z", "Content": [ { "AgentType": "amazon-ssm-agent", "AgentVersion": "2.3.930.0", "ComputerName": "EC2AMAZ-EXAMPLE.WORKGROUP", "InstanceId": "i-04bf6ad63bEXAMPLE", "InstanceStatus": "Stopped", "IpAddress": "172.16.0.4", "PlatformName": "Microsoft Windows Server 2016 Datacenter", "PlatformType": "Windows", "PlatformVersion": "10.0.14393", "ResourceType": "EC2Instance" } ] } } } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 411 AWS Systems Manager API Reference GetInventorySchema Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type. Request Syntax { "Aggregator": boolean, "MaxResults": number, "NextToken": "string", "SubType": boolean, "TypeName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Aggregator Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType,
|
systems-manager-api-081
|
systems-manager-api.pdf
| 81 |
Ruby V3 See Also API Version 2014-11-06 411 AWS Systems Manager API Reference GetInventorySchema Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type. Request Syntax { "Aggregator": boolean, "MaxResults": number, "NextToken": "string", "SubType": boolean, "TypeName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Aggregator Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes. Type: Boolean Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 50. Maximum value of 200. Required: No GetInventorySchema API Version 2014-11-06 412 AWS Systems Manager NextToken API Reference The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No SubType Returns the sub-type schema for a specified inventory type. Type: Boolean Required: No TypeName The type of inventory item to return. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Required: No Response Syntax { "NextToken": "string", "Schemas": [ { "Attributes": [ { "DataType": "string", "Name": "string" } ], "DisplayName": "string", "TypeName": "string", "Version": "string" } ] Response Syntax API Version 2014-11-06 413 AWS Systems Manager } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Schemas Inventory schemas returned by the request. Type: Array of InventoryItemSchema objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 InvalidTypeNameException The parameter type name isn't valid. HTTP Status Code: 400 Response Elements API Version 2014-11-06 414 API Reference AWS Systems Manager Examples Example This example illustrates one usage of GetInventorySchema. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetInventorySchema Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240330T150040Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "Schemas":[ { "Attributes":[ { "DataType":"STRING", "Name":"Name" }, { "DataType":"STRING", "Name":"ApplicationType" }, { "DataType":"STRING", "Name":"Publisher" }, { "DataType":"STRING", "Name":"Version" }, { Examples API Version 2014-11-06 415 AWS Systems Manager API Reference "DataType":"STRING", "Name":"InstalledTime" }, { "DataType":"STRING", "Name":"Architecture" }, { "DataType":"STRING", "Name":"URL" } ], "TypeName":"AWS:AWSComponent", "Version":"1.0" },--truncated-- { "Attributes":[ { "DataType":"STRING", "Name":"Name" }, { "DataType":"STRING", "Name":"DisplayName" }, { "DataType":"STRING", "Name":"ServiceType" }, { "DataType":"STRING", "Name":"Status" }, { "DataType":"STRING", "Name":"DependentServices" }, { "DataType":"STRING", "Name":"ServicesDependedOn" }, { "DataType":"STRING", "Name":"StartType" Examples API Version 2014-11-06 416 AWS Systems Manager } ], "TypeName":"AWS:Service", "Version":"1.0" }--truncated-- ] } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 417 AWS Systems Manager API Reference GetMaintenanceWindow Retrieves a maintenance window. Request Syntax { "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WindowId The ID of the maintenance window for which you want to retrieve information. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes Response Syntax { "AllowUnassociatedTargets": boolean, "CreatedDate": number, "Cutoff": number, "Description": "string", "Duration": number, "Enabled": boolean, "EndDate": "string", "ModifiedDate": number, "Name": "string", "NextExecutionTime": "string", GetMaintenanceWindow API Version 2014-11-06 418 AWS Systems Manager API Reference "Schedule": "string", "ScheduleOffset": number, "ScheduleTimezone": "string", "StartDate": "string", "WindowId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AllowUnassociatedTargets Whether targets must be registered with the maintenance window before tasks can be defined for those targets. Type: Boolean CreatedDate The date the maintenance window was created. Type: Timestamp Cutoff The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution. Type: Integer Valid Range: Minimum value of 0. Maximum value of 23. Description The description of the maintenance
|
systems-manager-api-082
|
systems-manager-api.pdf
| 82 |
"string", "WindowId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AllowUnassociatedTargets Whether targets must be registered with the maintenance window before tasks can be defined for those targets. Type: Boolean CreatedDate The date the maintenance window was created. Type: Timestamp Cutoff The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution. Type: Integer Valid Range: Minimum value of 0. Maximum value of 23. Description The description of the maintenance window. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Duration The duration of the maintenance window in hours. Response Elements API Version 2014-11-06 419 API Reference AWS Systems Manager Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Enabled Indicates whether the maintenance window is enabled. Type: Boolean EndDate The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time. Type: String ModifiedDate The date the maintenance window was last modified. Type: Timestamp Name The name of the maintenance window. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ NextExecutionTime The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive. Type: String Schedule The schedule of the maintenance window in the form of a cron or rate expression. Type: String Response Elements API Version 2014-11-06 420 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 256. ScheduleOffset The number of days to wait to run a maintenance window after the scheduled cron expression date and time. Type: Integer Valid Range: Minimum value of 1. Maximum value of 6. ScheduleTimezone The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. Type: String StartDate The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time. Type: String WindowId The ID of the created maintenance window. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Errors For information about the errors that are common to all actions, see Common Errors. DoesNotExistException Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist. Errors API Version 2014-11-06 421 AWS Systems Manager API Reference For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of GetMaintenanceWindow. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 36 X-Amz-Target: AmazonSSM.GetMaintenanceWindow X-Amz-Date: 20240312T203140Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "WindowId": "mw-0c50858d01EXAMPLE" } Sample Response { "AllowUnassociatedTargets": true, "CreatedDate": 1515006912.957, "Cutoff": 1, "Duration": 6, Examples API Version 2014-11-06 422 AWS Systems Manager "Enabled": true, "ModifiedDate": "2024-01-01T10:04:04.099Z", "Name": "My-Maintenance-Window", "Schedule": "rate(3 days)", "WindowId": "mw-0c50858d01EXAMPLE", "NextExecutionTime": "2024-02-25T00:08:15.099Z" } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 423 AWS Systems Manager API Reference GetMaintenanceWindowExecution Retrieves details about a specific a maintenance window execution. Request Syntax { "WindowExecutionId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WindowExecutionId The ID of the maintenance window execution that includes the task. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "EndTime": number, "StartTime": number, "Status": "string", "StatusDetails": "string", "TaskIds": [ "string" ], "WindowExecutionId": "string" } GetMaintenanceWindowExecution API Version 2014-11-06 424 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. EndTime The time the maintenance window finished running. Type: Timestamp StartTime The time the maintenance window started running. Type: Timestamp Status The status of the maintenance window execution. Type: String Valid Values: PENDING |
|
systems-manager-api-083
|
systems-manager-api.pdf
| 83 |
String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "EndTime": number, "StartTime": number, "Status": "string", "StatusDetails": "string", "TaskIds": [ "string" ], "WindowExecutionId": "string" } GetMaintenanceWindowExecution API Version 2014-11-06 424 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. EndTime The time the maintenance window finished running. Type: Timestamp StartTime The time the maintenance window started running. Type: Timestamp Status The status of the maintenance window execution. Type: String Valid Values: PENDING | IN_PROGRESS | SUCCESS | FAILED | TIMED_OUT | CANCELLING | CANCELLED | SKIPPED_OVERLAPPING StatusDetails The details explaining the status. Not available for all status values. Type: String Length Constraints: Minimum length of 0. Maximum length of 250. TaskIds The ID of the task executions from the maintenance window execution. Type: Array of strings Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Response Elements API Version 2014-11-06 425 AWS Systems Manager WindowExecutionId The ID of the maintenance window execution. Type: String Length Constraints: Fixed length of 36. API Reference Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of GetMaintenanceWindowExecution. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Errors API Version 2014-11-06 426 AWS Systems Manager Accept-Encoding: identity Content-Length: 61 X-Amz-Target: AmazonSSM.GetMaintenanceWindowExecution X-Amz-Date: 20240312T205830Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE" } Sample Response { "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE", "TaskIds": [ "4b9f371e-a820-422d-b432-8dec9EXAMPLE" ], "Status": "SUCCESS", "StartTime": "2024-08-04T11:45:34.994000-07:00", "EndTime": "2024-08-04T11:48:09.123000-07:00" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2014-11-06 427 AWS Systems Manager • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 428 AWS Systems Manager API Reference GetMaintenanceWindowExecutionTask Retrieves the details about a specific task run as part of a maintenance window execution. Request Syntax { "TaskId": "string", "WindowExecutionId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. TaskId The ID of the specific task execution in the maintenance window task that should be retrieved. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes WindowExecutionId The ID of the maintenance window execution that includes the task. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes GetMaintenanceWindowExecutionTask API Version 2014-11-06 429 API Reference AWS Systems Manager Response Syntax { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "EndTime": number, "MaxConcurrency": "string", "MaxErrors": "string", "Priority": number, "ServiceRole": "string", "StartTime": number, "Status": "string", "StatusDetails": "string", "TaskArn": "string", "TaskExecutionId": "string", "TaskParameters": [ { "string" : { "Values": [ "string" ] } } ], "TriggeredAlarms": [ { "Name": "string", "State": "string" } ], "Type": "string", "WindowExecutionId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2014-11-06 430 AWS Systems Manager AlarmConfiguration API Reference The details for the CloudWatch alarm you applied to your maintenance window task. Type: AlarmConfiguration object EndTime The time the task execution completed. Type: Timestamp MaxConcurrency The defined maximum number of task executions that could be run in parallel. Type: String Length Constraints: Minimum length of 1. Maximum length of 7. Pattern: ^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$ MaxErrors The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped. Type: String Length Constraints: Minimum length of 1. Maximum length of 7. Pattern: ^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$ Priority The priority of the task. Type: Integer Valid Range: Minimum value of 0. ServiceRole The role that was assumed when running the task. Type: String StartTime The time the task execution started. Response Elements API Version 2014-11-06 431 AWS Systems Manager Type: Timestamp Status The status of the task. Type: String API Reference Valid Values: PENDING | IN_PROGRESS | SUCCESS | FAILED | TIMED_OUT | CANCELLING | CANCELLED | SKIPPED_OVERLAPPING StatusDetails
|
systems-manager-api-084
|
systems-manager-api.pdf
| 84 |
task execution errors allowed before scheduling of the task execution would have been stopped. Type: String Length Constraints: Minimum length of 1. Maximum length of 7. Pattern: ^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$ Priority The priority of the task. Type: Integer Valid Range: Minimum value of 0. ServiceRole The role that was assumed when running the task. Type: String StartTime The time the task execution started. Response Elements API Version 2014-11-06 431 AWS Systems Manager Type: Timestamp Status The status of the task. Type: String API Reference Valid Values: PENDING | IN_PROGRESS | SUCCESS | FAILED | TIMED_OUT | CANCELLING | CANCELLED | SKIPPED_OVERLAPPING StatusDetails The details explaining the status. Not available for all status values. Type: String Length Constraints: Minimum length of 0. Maximum length of 250. TaskArn The Amazon Resource Name (ARN) of the task that ran. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. TaskExecutionId The ID of the specific task execution in the maintenance window task that was retrieved. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ TaskParameters The parameters passed to the task when it was run. Note TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the Response Elements API Version 2014-11-06 432 AWS Systems Manager API Reference TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. The map has the following format: • Key: string, between 1 and 255 characters • Value: an array of strings, each between 1 and 255 characters Type: Array of string to MaintenanceWindowTaskParameterValueExpression object maps Key Length Constraints: Minimum length of 1. Maximum length of 255. TriggeredAlarms The CloudWatch alarms that were invoked by the maintenance window task. Type: Array of AlarmStateInformation objects Array Members: Fixed number of 1 item. Type The type of task that was run. Type: String Valid Values: RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA WindowExecutionId The ID of the maintenance window execution that includes the task. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2014-11-06 433 AWS Systems Manager DoesNotExistException API Reference 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of GetMaintenanceWindowExecutionTask. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetMaintenanceWindowExecutionTask Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T001515Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 111 { "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef436EXAMPLE", "TaskId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE" } Examples API Version 2014-11-06 434 AWS Systems Manager Sample Response { API Reference "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef436EXAMPLE", "TaskExecutionId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE", "TaskArn": "AWS-RunPatchBaseline", "ServiceRole": "arn:aws:iam::111122223333:role/aws-service-role/ssm.amazonaws.com/ AWSServiceRoleForAmazonSSM", "Type": "RUN_COMMAND", "TaskParameters": [ { "BaselineOverride": { "Values": [ "" ] }, "InstallOverrideList": { "Values": [ "" ] }, "Operation": { "Values": [ "Scan" ] }, "RebootOption": { "Values": [ "RebootIfNeeded" ] }, "SnapshotId": { "Values": [ "{{ aws:ORCHESTRATION_ID }}" ] }, "aws:InstanceId": { "Values": [ "i-02573cafcfEXAMPLE", "i-0471e04240EXAMPLE", "i-07782c72faEXAMPLE" ] } } Examples API Version 2014-11-06 435 API Reference AWS Systems Manager ], "Priority": 1, "MaxConcurrency": "1", "MaxErrors": "3", "Status": "SUCCESS", "StartTime": "2024-08-04T11:45:35.088000-07:00", "EndTime": "2024-08-04T11:48:09.079000-07:00" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 436 AWS Systems Manager API Reference GetMaintenanceWindowExecutionTaskInvocation Retrieves information about a specific task running on a specific target. Request Syntax { "InvocationId": "string", "TaskId": "string", "WindowExecutionId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. InvocationId The invocation ID to retrieve. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes TaskId The ID of the specific task in the maintenance window task that should be retrieved. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes GetMaintenanceWindowExecutionTaskInvocation API Version 2014-11-06 437 AWS Systems Manager WindowExecutionId API Reference The ID of the maintenance window execution for which the task is a part. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "EndTime": number, "ExecutionId": "string", "InvocationId": "string", "OwnerInformation":
|
systems-manager-api-085
|
systems-manager-api.pdf
| 85 |
data in JSON format. InvocationId The invocation ID to retrieve. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes TaskId The ID of the specific task in the maintenance window task that should be retrieved. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes GetMaintenanceWindowExecutionTaskInvocation API Version 2014-11-06 437 AWS Systems Manager WindowExecutionId API Reference The ID of the maintenance window execution for which the task is a part. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "EndTime": number, "ExecutionId": "string", "InvocationId": "string", "OwnerInformation": "string", "Parameters": "string", "StartTime": number, "Status": "string", "StatusDetails": "string", "TaskExecutionId": "string", "TaskType": "string", "WindowExecutionId": "string", "WindowTargetId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. EndTime The time that the task finished running on the target. Type: Timestamp Response Syntax API Version 2014-11-06 438 API Reference AWS Systems Manager ExecutionId The execution ID. Type: String InvocationId The invocation ID. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ OwnerInformation User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Parameters The parameters used at the time that the task ran. Type: String StartTime The time that the task started running on the target. Type: Timestamp Status The task status for an invocation. Type: String Valid Values: PENDING | IN_PROGRESS | SUCCESS | FAILED | TIMED_OUT | CANCELLING | CANCELLED | SKIPPED_OVERLAPPING Response Elements API Version 2014-11-06 439 AWS Systems Manager StatusDetails API Reference The details explaining the status. Details are only available for certain status values. Type: String Length Constraints: Minimum length of 0. Maximum length of 250. TaskExecutionId The task execution ID. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ TaskType Retrieves the task type for a maintenance window. Type: String Valid Values: RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA WindowExecutionId The maintenance window execution ID. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ WindowTargetId The maintenance window target ID. Type: String Length Constraints: Maximum length of 36. Response Elements API Version 2014-11-06 440 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of GetMaintenanceWindowExecutionTaskInvocation. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetMaintenanceWindowExecutionTaskInvocation Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T001923Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 167 { "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE", Errors API Version 2014-11-06 441 AWS Systems Manager API Reference "TaskId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE", "InvocationId": "0e466033-290b-4d74-9ae0-f33e3EXAMPLE" } Sample Response { "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE", "TaskExecutionId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE", "InvocationId": "0e466033-290b-4d74-9ae0-f33e3EXAMPLE", "ExecutionId": "1203cf98-5a79-4ec3-97e9-12e0bEXAMPLE", "TaskType": "RUN_COMMAND", "Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-ApplyPatchBaseline\", \"instanceIds\":[\"i-02573cafcfEXAMPLE\",\"i-0471e04240EXAMPLE\"],\"maxConcurrency \":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"SnapshotId\":[\"\"],\"Operation\": [\"Install\"]},\"timeoutSeconds\":600}", "Status": "SUCCESS", "StatusDetails": "Success", "StartTime": "2024-08-04T11:45:35.141000-07:00", "EndTime": "2024-08-04T11:48:08.960000-07:00" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 442 AWS Systems Manager API Reference GetMaintenanceWindowTask Retrieves the details of a maintenance window task. Note 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. To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command. Request Syntax { "WindowId": "string", "WindowTaskId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WindowId The maintenance window ID that includes the task to retrieve. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes GetMaintenanceWindowTask API Version 2014-11-06 443 AWS Systems Manager WindowTaskId The maintenance window task ID to retrieve. Type: String Length Constraints: Fixed length of 36. API Reference Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "AlarmConfiguration": { "Alarms":
|
systems-manager-api-086
|
systems-manager-api.pdf
| 86 |
maintenance window, instead use the DescribeMaintenanceWindowTasks command. Request Syntax { "WindowId": "string", "WindowTaskId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WindowId The maintenance window ID that includes the task to retrieve. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes GetMaintenanceWindowTask API Version 2014-11-06 443 AWS Systems Manager WindowTaskId The maintenance window task ID to retrieve. Type: String Length Constraints: Fixed length of 36. API Reference Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Required: Yes Response Syntax { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "CutoffBehavior": "string", "Description": "string", "LoggingInfo": { "S3BucketName": "string", "S3KeyPrefix": "string", "S3Region": "string" }, "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "Priority": number, "ServiceRoleArn": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TaskArn": "string", Response Syntax API Version 2014-11-06 444 AWS Systems Manager API Reference "TaskInvocationParameters": { "Automation": { "DocumentVersion": "string", "Parameters": { "string" : [ "string" ] } }, "Lambda": { "ClientContext": "string", "Payload": blob, "Qualifier": "string" }, "RunCommand": { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "string", "CloudWatchOutputEnabled": boolean }, "Comment": "string", "DocumentHash": "string", "DocumentHashType": "string", "DocumentVersion": "string", "NotificationConfig": { "NotificationArn": "string", "NotificationEvents": [ "string" ], "NotificationType": "string" }, "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "Parameters": { "string" : [ "string" ] }, "ServiceRoleArn": "string", "TimeoutSeconds": number }, "StepFunctions": { "Input": "string", "Name": "string" } }, "TaskParameters": { "string" : { "Values": [ "string" ] } }, Response Syntax API Version 2014-11-06 445 AWS Systems Manager API Reference "TaskType": "string", "WindowId": "string", "WindowTaskId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AlarmConfiguration The details for the CloudWatch alarm you applied to your maintenance window task. Type: AlarmConfiguration object CutoffBehavior The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, AWS Lambda, AWS Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation. Type: String Valid Values: CONTINUE_TASK | CANCEL_TASK Description The retrieved task description. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. LoggingInfo The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged. Note LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and Response Elements API Version 2014-11-06 446 AWS Systems Manager API Reference OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how AWS Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. Type: LoggingInfo object MaxConcurrency The maximum number of targets allowed to run this task in parallel. Note For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored. Type: String Length Constraints: Minimum length of 1. Maximum length of 7. Pattern: ^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$ MaxErrors The maximum number of errors allowed before the task stops being scheduled. Note For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored. Type: String Length Constraints: Minimum length of 1. Maximum length of 7. Response Elements API Version 2014-11-06 447 AWS Systems Manager API Reference Pattern: ^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$ Name The retrieved task name. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Priority The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. Type: Integer Valid Range: Minimum value of 0. ServiceRoleArn The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow. However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS
|
systems-manager-api-087
|
systems-manager-api.pdf
| 87 |
Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow. However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide. Type: String Targets The targets where the task should run. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Response Elements API Version 2014-11-06 448 AWS Systems Manager TaskArn API Reference The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. TaskInvocationParameters The parameters to pass to the task when it runs. Type: MaintenanceWindowTaskInvocationParameters object TaskParameters The parameters to pass to the task when it runs. Note TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. Type: String to MaintenanceWindowTaskParameterValueExpression object map Key Length Constraints: Minimum length of 1. Maximum length of 255. TaskType The type of task to run. Type: String Valid Values: RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA WindowId The retrieved maintenance window ID. Response Elements API Version 2014-11-06 449 API Reference AWS Systems Manager Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ WindowTaskId The retrieved maintenance window task ID. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of GetMaintenanceWindowTask. Errors API Version 2014-11-06 450 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity API Reference X-Amz-Target: AmazonSSM.GetMaintenanceWindowTask Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T002532Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 92 { "WindowId": "mw-0c50858d01EXAMPLE", "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE" } Sample Response { "WindowId": "mw-0c50858d01EXAMPLE", "WindowTaskId": "50772993-c6b5-4a2a-8d04-7bfd7EXAMPLE", "Name": "MyRunCommandTask", "Targets": [ { "Key": "WindowTargetIds", "Values": [ "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE" ] } ], "TaskArn": "AWS-ApplyPatchBaseline", "ServiceRoleArn": "arn:aws:iam::111122223333:role/aws-service-role/ ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", "TaskType": "RUN_COMMAND", "TaskParameters": {}, "Priority": 1, "TaskInvocationParameters": { "RunCommand": { "Comment": "", "Parameters": { Examples API Version 2014-11-06 451 AWS Systems Manager API Reference "Operation": [ "Install" ], "SnapshotId": [ "" ] }, "TimeoutSeconds": 600 } }, "MaxConcurrency": "1", "MaxErrors": "1" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 452 AWS Systems Manager GetOpsItem API Reference Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use AWS Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide. Request Syntax { "OpsItemArn": "string", "OpsItemId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OpsItemArn The OpsItem Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[0-9]{12}:opsitem.* Required: No OpsItemId The ID of the OpsItem that you want to get. Type: String GetOpsItem API Version 2014-11-06 453 AWS Systems Manager API Reference Pattern: ^(oi)-[0-9a-f]{12}$ Required: Yes Response Syntax { "OpsItem": { "ActualEndTime": number, "ActualStartTime": number, "Category": "string", "CreatedBy": "string",
|
systems-manager-api-088
|
systems-manager-api.pdf
| 88 |
Systems Manager User Guide. Request Syntax { "OpsItemArn": "string", "OpsItemId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OpsItemArn The OpsItem Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[0-9]{12}:opsitem.* Required: No OpsItemId The ID of the OpsItem that you want to get. Type: String GetOpsItem API Version 2014-11-06 453 AWS Systems Manager API Reference Pattern: ^(oi)-[0-9a-f]{12}$ Required: Yes Response Syntax { "OpsItem": { "ActualEndTime": number, "ActualStartTime": number, "Category": "string", "CreatedBy": "string", "CreatedTime": number, "Description": "string", "LastModifiedBy": "string", "LastModifiedTime": number, "Notifications": [ { "Arn": "string" } ], "OperationalData": { "string" : { "Type": "string", "Value": "string" } }, "OpsItemArn": "string", "OpsItemId": "string", "OpsItemType": "string", "PlannedEndTime": number, "PlannedStartTime": number, "Priority": number, "RelatedOpsItems": [ { "OpsItemId": "string" } ], "Severity": "string", "Source": "string", "Status": "string", "Title": "string", "Version": "string" Response Syntax API Version 2014-11-06 454 AWS Systems Manager } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference OpsItem The OpsItem. Type: OpsItem object Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 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 AWS Organizations management account. HTTP Status Code: 400 OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again. HTTP Status Code: 400 Response Elements API Version 2014-11-06 455 API Reference AWS Systems Manager Examples Example This example illustrates one usage of GetOpsItem. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetOpsItem Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240330T153712Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 32 { "OpsItemId": "oi-f99f2EXAMPLE" } Sample Response { "OpsItem": { "Category": "Availability", "CreatedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/ af3935bb93783f02aeea51784EXAMPLE", "CreatedTime": 1582701517.193, "Description": "CloudWatch Event Rule SSMOpsItems-SSM-maintenance-window- execution-failed was triggered. Your SSM Maintenance Window execution has failed. See below for more details.", "LastModifiedBy": "arn:aws:sts::111122223333:assumed-role/OpsCenterRole/ af3935bb93783f02aeea51784EXAMPLE", "LastModifiedTime": 1582701517.193, "Notifications": [], "OperationalData": { "/aws/dedup": { "Type": "SearchableString", Examples API Version 2014-11-06 456 AWS Systems Manager API Reference "Value": "{\"dedupString\":\"SSMOpsItems-SSM-maintenance-window- execution-failed\"}" }, "/aws/resources": { "Type": "SearchableString", "Value": "[{\"arn\":\"arn:aws:ssm:us- east-2:111122223333:maintenancewindow/mw-0e357ebdc6EXAMPLE\"}]" }, "window-execution-id": { "Type": "String", "Value": "e79e904b-0e42-43b8-a83d-b2aedEXAMPLE" }, "window-id": { "Type": "String", "Value": "mw-0e357ebdc6EXAMPLE" } }, "OpsItemId": "oi-f99f2EXAMPLE", "RelatedOpsItems": [], "Severity": "3", "Source": "SSM", "Status": "Open", "Title": "SSM Maintenance Window execution failed" } } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2014-11-06 457 AWS Systems Manager • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 458 AWS Systems Manager GetOpsMetadata API Reference View operational metadata related to an application in Application Manager. Request Syntax { "MaxResults": number, "NextToken": "string", "OpsMetadataArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. Required: No NextToken A token to start the list. Use this token to get the next set of results. Type: String Required: No OpsMetadataArn The Amazon Resource Name (ARN) of an OpsMetadata Object to view. Type: String GetOpsMetadata API Version 2014-11-06 459 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.] {0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*) Required: Yes Response Syntax { "Metadata": { "string" : { "Value": "string" } }, "NextToken": "string", "ResourceId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Metadata OpsMetadata for an Application Manager application. Type: String to MetadataValue object map Map Entries: Maximum number of 5 items. Key Length Constraints: Minimum length of 1. Maximum length of 256. Key Pattern: ^(?!\s*$).+ NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Response Syntax API Version 2014-11-06 460 AWS Systems Manager ResourceId API Reference The resource ID of
|
systems-manager-api-089
|
systems-manager-api.pdf
| 89 |
} Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Metadata OpsMetadata for an Application Manager application. Type: String to MetadataValue object map Map Entries: Maximum number of 5 items. Key Length Constraints: Minimum length of 1. Maximum length of 256. Key Pattern: ^(?!\s*$).+ NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Response Syntax API Version 2014-11-06 460 AWS Systems Manager ResourceId API Reference The resource ID of the Application Manager application. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^(?!\s*$).+ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 OpsMetadataInvalidArgumentException One of the arguments passed is invalid. HTTP Status Code: 400 OpsMetadataNotFoundException The OpsMetadata object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2014-11-06 461 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 462 AWS Systems Manager GetOpsSummary API Reference View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about AWS Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any AWS resource or service configured to report OpsData to AWS Systems Manager Explorer. Request Syntax { "Aggregators": [ { "Aggregators": [ "OpsAggregator" ], "AggregatorType": "string", "AttributeName": "string", "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "TypeName": "string", "Values": { "string" : "string" } } ], "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ResultAttributes": [ { "TypeName": "string" GetOpsSummary API Version 2014-11-06 463 AWS Systems Manager } ], "SyncName": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Aggregators Optional aggregators that return counts of OpsData based on one or more expressions. Type: Array of OpsAggregator objects Array Members: Minimum number of 1 item. Maximum number of 12 items. Required: No Filters Optional filters used to scope down the returned OpsData. Type: Array of OpsFilter objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken A token to start the list. Use this token to get the next set of results. Request Parameters API Version 2014-11-06 464 API Reference AWS Systems Manager Type: String Required: No ResultAttributes The OpsData data type to return. Type: Array of OpsResultAttribute objects Array Members: Minimum number of 1 item. Required: No SyncName Specify the name of a resource data sync to get. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax { "Entities": [ { "Data": { "string" : { "CaptureTime": "string", "Content": [ { "string" : "string" } ] } }, "Id": "string" } ], "NextToken": "string" } Response Syntax API Version 2014-11-06 465 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Entities The list of aggregated details and filtered OpsData. Type: Array of OpsEntity objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidAggregatorException The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported. HTTP Status Code: 400 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. Response Elements API Version 2014-11-06 466 API Reference AWS Systems Manager HTTP Status Code: 400 InvalidTypeNameException The parameter type name isn't valid. HTTP Status Code: 400 ResourceDataSyncNotFoundException The specified
|
systems-manager-api-090
|
systems-manager-api.pdf
| 90 |
the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidAggregatorException The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported. HTTP Status Code: 400 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. Response Elements API Version 2014-11-06 466 API Reference AWS Systems Manager HTTP Status Code: 400 InvalidTypeNameException The parameter type name isn't valid. HTTP Status Code: 400 ResourceDataSyncNotFoundException The specified sync name wasn't found. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetOpsSummary. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetOpsSummary Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240330T152044Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "Entities": [ { "Data": { "AWS:OpsItem": { "CaptureTime": "2024-02-26T05:59:57.430Z", "Content": [ Examples API Version 2014-11-06 467 AWS Systems Manager { API Reference "AccountId": "111122223333", "Category": "Availability", "CreatedBy": "arn:aws:sts::111122223333:assumed-role/ OpsCenterRole/af3935bb93783f02aeea51784EXAMPLE", "CreatedTime": "2024-02-26T07:18:37.193Z", "Description": "CloudWatch Event Rule SSMOpsItems-SSM- maintenance-window-execution-failed was triggered. Your SSM Maintenance Window execution has failed. See below for more details.", "LastModifiedBy": "arn:aws:sts::111122223333:assumed-role/ OpsCenterRole/af3935bb93783f02aeea51784EXAMPLE", "LastModifiedTime": "2024-02-26T07:18:37.193Z", "Notifications": "", "OperationalData": "{\"/aws/resources\":{\"type \":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ssm:us- east-2:111122223333:maintenancewindow/mw-0e357ebdc6EXAMPLE\\\"}]\"},\"/aws/dedup\": {\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-SSM- maintenance-window-execution-failed\\\"}\"}}", "OpsItemId": "oi-f99f2EXAMPLE", "RelatedItems": "", "Severity": "3", "Source": "SSM", "Status": "Open", "Title": "SSM Maintenance Window execution failed" } ] } }, "Id": "oi-f99f2EXAMPLE" },---truncated--- ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2014-11-06 468 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 469 AWS Systems Manager GetParameter API Reference Get information about a single parameter by specifying the parameter name. Note To get information about more than one parameter at a time, use the GetParameters operation. Request Syntax { "Name": "string", "WithDecryption": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Name The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN. To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version". For more information about shared parameters, see Working with shared parameters in the AWS Systems Manager User Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes GetParameter API Version 2014-11-06 470 AWS Systems Manager WithDecryption API Reference Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. Type: Boolean Required: No Response Syntax { "Parameter": { "ARN": "string", "DataType": "string", "LastModifiedDate": number, "Name": "string", "Selector": "string", "SourceResult": "string", "Type": "string", "Value": "string", "Version": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Parameter Information about a parameter. Type: Parameter object Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2014-11-06 471 API Reference AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidKeyId The query key ID isn't valid. HTTP Status Code: 400 ParameterNotFound The parameter couldn't be found. Verify the name and try again. Note For the DeleteParameter and GetParameter actions, if the specified parameter doesn't exist, the ParameterNotFound exception is not recorded in AWS CloudTrail event logs. HTTP Status Code: 400 ParameterVersionNotFound The specified parameter version wasn't found. Verify the parameter name and version, and try again. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetParameter. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Examples API Version 2014-11-06 472 AWS Systems Manager API Reference Accept-Encoding: identity Content-Length: 29 X-Amz-Target: AmazonSSM.GetParameter X-Amz-Date: 20240316T005724Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Name": "MyGitHubPassword" } Sample Response { "Parameter": { "ARN": "arn:aws:ssm:us-east-2:111122223333:parameter/MyGitHubPassword", "DataType": "text", "LastModifiedDate": 1582657288.8, "Name": "MyGitHubPassword", "Type": "SecureString", "Value": "AYA39c3b3042cd2aEXAMPLE/AKIAIOSFODNN7EXAMPLE/fh983hg9awEXAMPLE==", "Version": 3 } } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for
|
systems-manager-api-091
|
systems-manager-api.pdf
| 91 |
Content-Length: 29 X-Amz-Target: AmazonSSM.GetParameter X-Amz-Date: 20240316T005724Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Name": "MyGitHubPassword" } Sample Response { "Parameter": { "ARN": "arn:aws:ssm:us-east-2:111122223333:parameter/MyGitHubPassword", "DataType": "text", "LastModifiedDate": 1582657288.8, "Name": "MyGitHubPassword", "Type": "SecureString", "Value": "AYA39c3b3042cd2aEXAMPLE/AKIAIOSFODNN7EXAMPLE/fh983hg9awEXAMPLE==", "Version": 3 } } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2014-11-06 473 AWS Systems Manager • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 474 AWS Systems Manager API Reference GetParameterHistory Retrieves the history of all changes to a parameter. Important If you change the AWS 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, GetParameterHistory retrieves whatever the original key alias was referencing. Request Syntax { "MaxResults": number, "Name": "string", "NextToken": "string", "WithDecryption": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No Name The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN. GetParameterHistory API Version 2014-11-06 475 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No WithDecryption Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. Type: Boolean Required: No Response Syntax { "NextToken": "string", "Parameters": [ { "AllowedPattern": "string", "DataType": "string", "Description": "string", "KeyId": "string", "Labels": [ "string" ], "LastModifiedDate": number, "LastModifiedUser": "string", "Name": "string", "Policies": [ { "PolicyStatus": "string", "PolicyText": "string", "PolicyType": "string" } Response Syntax API Version 2014-11-06 476 AWS Systems Manager API Reference ], "Tier": "string", "Type": "string", "Value": "string", "Version": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Parameters A list of parameters returned by the request. Type: Array of ParameterHistory objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidKeyId The query key ID isn't valid. HTTP Status Code: 400 Response Elements API Version 2014-11-06 477 AWS Systems Manager InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 ParameterNotFound API Reference The parameter couldn't be found. Verify the name and try again. Note For the DeleteParameter and GetParameter actions, if the specified parameter doesn't exist, the ParameterNotFound exception is not recorded in AWS CloudTrail event logs. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetParameterHistory. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 29 X-Amz-Target: AmazonSSM.GetParameterHistory X-Amz-Date: 20240316T005206Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Name": "EC2TestServerType" } Examples API Version 2014-11-06 478 AWS Systems Manager Sample Response { "Parameters": [ { API Reference "Description": "Instance type for Test servers", "LastModifiedDate": 1521158745.607, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "EC2TestServerType", "Policies": [], "Type": "String", "Value": "t2.nano", "Version": 1 }, { "Description": "Instance type for Test servers", "LastModifiedDate": 1521158834.467, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "EC2TestServerType", "Policies": [], "Type": "String", "Value": "t2.micro", "Version": 2 }, { "Description": "Instance type for Test servers", "LastModifiedDate": 1521158912.828, "LastModifiedUser": "arn:aws:iam::111122223333:user/Jane.Roe", "Name": "EC2TestServerType", "Policies": [], "Type": "String", "Value": "t2.large", "Version": 3 } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2014-11-06 479 API Reference AWS Systems Manager • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS
|
systems-manager-api-092
|
systems-manager-api.pdf
| 92 |
{ "Description": "Instance type for Test servers", "LastModifiedDate": 1521158912.828, "LastModifiedUser": "arn:aws:iam::111122223333:user/Jane.Roe", "Name": "EC2TestServerType", "Policies": [], "Type": "String", "Value": "t2.large", "Version": 3 } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2014-11-06 479 API Reference AWS Systems Manager • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 480 AWS Systems Manager GetParameters API Reference Get information about one or more parameters by specifying multiple parameter names. Note To get information about a single parameter, you can use the GetParameter operation instead. Request Syntax { "Names": [ "string" ], "WithDecryption": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Names The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs. To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version". Note The results for GetParameters requests are listed in alphabetical order in query responses. For information about shared parameters, see Working with shared parameters in the AWS Systems Manager User Guide. GetParameters API Version 2014-11-06 481 AWS Systems Manager Type: Array of strings API Reference Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes WithDecryption Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. Type: Boolean Required: No Response Syntax { "InvalidParameters": [ "string" ], "Parameters": [ { "ARN": "string", "DataType": "string", "LastModifiedDate": number, "Name": "string", "Selector": "string", "SourceResult": "string", "Type": "string", "Value": "string", "Version": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2014-11-06 482 AWS Systems Manager InvalidParameters API Reference A list of parameters that aren't formatted correctly or don't run during an execution. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 2048. Parameters A list of details for a parameter. Type: Array of Parameter objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidKeyId The query key ID isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetParameters. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Errors API Version 2014-11-06 483 AWS Systems Manager API Reference Accept-Encoding: identity Content-Length: 73 X-Amz-Target: AmazonSSM.GetParameters X-Amz-Date: 20240316T001029Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Names": [ "EC2DevServerTypo", "EC2DevServerType", "EC2TestServerType", "EC2ProdServerType" ] } Sample Response { "InvalidParameters": [ { "Name": "EC2DevServerTypo" } ], "Parameters": [ { "Name": "EC2DevServerType", "Type": "String", "Value": "t2.micro", "Version": 2 }, { "Name": "EC2ProdServerType", "Type": "String", "Value": "m4.large", "Version": 1 }, { "Name": "EC2TestServerType", "Type": "String", Examples API Version 2014-11-06 484 AWS Systems Manager API Reference "Value": "t2.large", "Version": 3 } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 485 AWS Systems Manager API Reference GetParametersByPath Retrieve information about one or more parameters under a specified level in a hierarchy. Request results are returned on a best-effort basis. If you specify 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. Request Syntax { "MaxResults": number, "NextToken": "string", "ParameterFilters": [ { "Key": "string", "Option": "string", "Values": [ "string" ] } ], "Path": "string", "Recursive":
|
systems-manager-api-093
|
systems-manager-api.pdf
| 93 |
a best-effort basis. If you specify 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. Request Syntax { "MaxResults": number, "NextToken": "string", "ParameterFilters": [ { "Key": "string", "Option": "string", "Values": [ "string" ] } ], "Path": "string", "Recursive": boolean, "WithDecryption": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. GetParametersByPath API Version 2014-11-06 486 AWS Systems Manager Required: No NextToken A token to start the list. Use this token to get the next set of results. API Reference Type: String Required: No ParameterFilters Filters to limit the request results. Note The following Key values are supported for GetParametersByPath: Type, KeyId, and Label. The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier. Type: Array of ParameterStringFilter objects Required: No Path The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/ WinServ2016/license33 Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Recursive Retrieve all parameters within a hierarchy. Request Parameters API Version 2014-11-06 487 AWS Systems Manager API Reference Important If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b. Type: Boolean Required: No WithDecryption Retrieve all parameters in a hierarchy with their value decrypted. Type: Boolean Required: No Response Syntax { "NextToken": "string", "Parameters": [ { "ARN": "string", "DataType": "string", "LastModifiedDate": number, "Name": "string", "Selector": "string", "SourceResult": "string", "Type": "string", "Value": "string", "Version": number } ] } Response Syntax API Version 2014-11-06 488 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Parameters A list of parameters found in the specified hierarchy. Type: Array of Parameter objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidFilterOption The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel. HTTP Status Code: 400 InvalidFilterValue The filter value isn't valid. Verify the value and try again. Response Elements API Version 2014-11-06 489 API Reference AWS Systems Manager HTTP Status Code: 400 InvalidKeyId The query key ID isn't valid. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetParametersByPath. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 46 X-Amz-Target: AmazonSSM.GetParametersByPath X-Amz-Date: 20240316T004724Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Path": "/Branch312/Dev/", "Recursive": true } Sample Response { "Parameters": [ Examples API Version 2014-11-06 490 API Reference AWS Systems Manager { "Name": "/Branch312/Dev/Engineer1", "Type": "String", "Value": "Saanvi Sarkar", "Version": 1 }, { "Name": "/Branch312/Dev/Engineer2", "Type": "String", "Value": "Zhang Wei", "Version": 1 }, { "Name": "/Branch312/Dev/Engineer3", "Type": "String", "Value": "Alejandro Rosalez", "Version": 1 }, { "Name": "/Branch312/Dev/Intern", "Type": "String", "Value": "Nikhil Jayashankar", "Version": 1 }, { "Name": "/Branch312/Dev/TeamLead", "Type": "String", "Value": "Jane Roe", "Version": 1 } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API
|
systems-manager-api-094
|
systems-manager-api.pdf
| 94 |
{ "Name": "/Branch312/Dev/Engineer1", "Type": "String", "Value": "Saanvi Sarkar", "Version": 1 }, { "Name": "/Branch312/Dev/Engineer2", "Type": "String", "Value": "Zhang Wei", "Version": 1 }, { "Name": "/Branch312/Dev/Engineer3", "Type": "String", "Value": "Alejandro Rosalez", "Version": 1 }, { "Name": "/Branch312/Dev/Intern", "Type": "String", "Value": "Nikhil Jayashankar", "Version": 1 }, { "Name": "/Branch312/Dev/TeamLead", "Type": "String", "Value": "Jane Roe", "Version": 1 } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2014-11-06 491 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 492 API Reference AWS Systems Manager GetPatchBaseline Retrieves information about a patch baseline. Request Syntax { "BaselineId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BaselineId The ID of the patch baseline to retrieve. Note To retrieve information about an AWS managed patch baseline, specify the full Amazon Resource Name (ARN) of the baseline. For example, for the baseline AWS-AmazonLinuxDefaultPatchBaseline, specify arn:aws:ssm:us- east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7 instead of pb-0e392de35e7c563b7. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Required: Yes Response Syntax { GetPatchBaseline API Version 2014-11-06 493 AWS Systems Manager API Reference "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": number, "ApproveUntilDate": "string", "ComplianceLevel": "string", "EnableNonSecurity": boolean, "PatchFilterGroup": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] } ] } } ] }, "ApprovedPatches": [ "string" ], "ApprovedPatchesComplianceLevel": "string", "ApprovedPatchesEnableNonSecurity": boolean, "AvailableSecurityUpdatesComplianceStatus": "string", "BaselineId": "string", "CreatedDate": number, "Description": "string", "GlobalFilters": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] } ] }, "ModifiedDate": number, "Name": "string", "OperatingSystem": "string", "PatchGroups": [ "string" ], "RejectedPatches": [ "string" ], "RejectedPatchesAction": "string", "Sources": [ { "Configuration": "string", "Name": "string", "Products": [ "string" ] Response Syntax API Version 2014-11-06 494 API Reference AWS Systems Manager } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ApprovalRules A set of rules used to include patches in the baseline. Type: PatchRuleGroup object ApprovedPatches A list of explicitly approved patches for the baseline. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 100. ApprovedPatchesComplianceLevel Returns the specified compliance severity level for approved patches in the patch baseline. Type: String Valid Values: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED ApprovedPatchesEnableNonSecurity Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only. Type: Boolean AvailableSecurityUpdatesComplianceStatus Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. This preference is specified when the CreatePatchBaseline or UpdatePatchBaseline commands are run. Response Elements API Version 2014-11-06 495 AWS Systems Manager API Reference Applies to Windows Server managed nodes only. Type: String Valid Values: COMPLIANT | NON_COMPLIANT BaselineId The ID of the retrieved patch baseline. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ CreatedDate The date the patch baseline was created. Type: Timestamp Description A description of the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. GlobalFilters A set of global filters used to exclude patches from the baseline. Type: PatchFilterGroup object ModifiedDate The date the patch baseline was last modified. Type: Timestamp Name The name of the patch baseline. Response Elements API Version 2014-11-06 496 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ OperatingSystem Returns the operating system specified for the patch baseline. Type: String Valid Values: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023 PatchGroups Patch groups included in the patch baseline. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ RejectedPatches A list of explicitly rejected patches for the baseline. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 100. RejectedPatchesAction The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with
|
systems-manager-api-095
|
systems-manager-api.pdf
| 95 |
| RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023 PatchGroups Patch groups included in the patch baseline. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ RejectedPatches A list of explicitly rejected patches for the baseline. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 100. RejectedPatchesAction The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency. Type: String Response Elements API Version 2014-11-06 497 AWS Systems Manager API Reference Valid Values: ALLOW_AS_DEPENDENCY | BLOCK Sources Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only. Type: Array of PatchSource objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Errors For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidResourceId The resource ID isn't valid. Verify that you entered the correct ID and try again. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetPatchBaseline. Errors API Version 2014-11-06 498 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 38 X-Amz-Target: AmazonSSM.GetPatchBaseline X-Amz-Date: 20240309T020232Z API Reference User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "BaselineId": "pb-0c10e65780EXAMPLE" } Sample Response { "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": 1, "ComplianceLevel": "UNSPECIFIED", "EnableNonSecurity": false, "PatchFilterGroup": { "PatchFilters": [ { "Key": "PRODUCT", "Values": [ "WindowsServer2012R2" ] }, { "Key": "CLASSIFICATION", "Values": [ "SecurityUpdates" ] }, { "Key": "MSRC_SEVERITY", Examples API Version 2014-11-06 499 AWS Systems Manager API Reference "Values": [ "Important", "Critical", "Moderate" ] } ] } } ] }, "ApprovedPatches": [], "ApprovedPatchesComplianceLevel": "HIGH", "ApprovedPatchesEnableNonSecurity": false, "BaselineId": "pb-0c10e65780EXAMPLE", "Description": "My Moderate, Important, and Critical security updates for Windows Server 2012 R2", "GlobalFilters": { "PatchFilters": [] }, "CreatedDate": 1520561435.87, "ModifiedDate": 1520561435.869, "Name": "my-Windows-Server-2012R2", "OperatingSystem": "WINDOWS", "PatchGroups": [ "mypatchgroup" ], "RejectedPatches": [ "KB3452678" ], "RejecteddPatchesAction": "ALLOW_AS_DEPENDENCY", "Sources": [] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2014-11-06 500 AWS Systems Manager • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 501 AWS Systems Manager API Reference GetPatchBaselineForPatchGroup Retrieves the patch baseline that should be used for the specified patch group. Request Syntax { "OperatingSystem": "string", "PatchGroup": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. OperatingSystem Returns the operating system rule specified for patch groups using the patch baseline. Type: String Valid Values: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023 Required: No PatchGroup The name of the patch group whose patch baseline should be retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes GetPatchBaselineForPatchGroup API Version 2014-11-06 502 API Reference AWS Systems Manager Response Syntax { "BaselineId": "string", "OperatingSystem": "string", "PatchGroup": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BaselineId The ID of the patch baseline that should be used for the patch group. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ OperatingSystem The operating system rule specified for patch groups using the patch baseline. Type: String Valid Values: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023 PatchGroup The name of the patch group. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Response Syntax API Version 2014-11-06 503 AWS Systems Manager Errors API Reference For information about the errors that are common to
|
systems-manager-api-096
|
systems-manager-api.pdf
| 96 |
Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ OperatingSystem The operating system rule specified for patch groups using the patch baseline. Type: String Valid Values: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX | AMAZON_LINUX_2023 PatchGroup The name of the patch group. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Response Syntax API Version 2014-11-06 503 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Examples Example This example illustrates one usage of GetPatchBaselineForPatchGroup. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 66 X-Amz-Target: AmazonSSM.GetPatchBaselineForPatchGroup X-Amz-Date: 20240309T060906Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "PatchGroup": "mypatchgroup", "OperatingSystem": "WINDOWS" } Sample Response { "BaselineId": "pb-0c10e65780EXAMPLE", "OperatingSystem": "WINDOWS", "PatchGroup": "mypatchgroup" Errors API Version 2014-11-06 504 AWS Systems Manager } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 505 AWS Systems Manager API Reference GetResourcePolicies Returns an array of the Policy object. Request Syntax { "MaxResults": number, "NextToken": "string", "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken A token to start the list. Use this token to get the next set of results. Type: String Required: No ResourceArn Amazon Resource Name (ARN) of the resource to which the policies are attached. Type: String GetResourcePolicies API Version 2014-11-06 506 AWS Systems Manager API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Required: Yes Response Syntax { "NextToken": "string", "Policies": [ { "Policy": "string", "PolicyHash": "string", "PolicyId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Policies An array of the Policy object. Type: Array of GetResourcePoliciesResponseEntry objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. Response Syntax API Version 2014-11-06 507 AWS Systems Manager HTTP Status Code: 500 ResourceNotFoundException The specified parameter to be shared could not be found. HTTP Status Code: 400 ResourcePolicyInvalidParameterException API Reference One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 508 AWS Systems Manager GetServiceSetting API Reference ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS 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. Services map a SettingId object to a setting value. AWS 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
|
systems-manager-api-097
|
systems-manager-api.pdf
| 97 |
AWS 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. Services map a SettingId object to a setting value. AWS 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 AWS service team. Query the current service setting for the AWS account. Request Syntax { "SettingId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. SettingId The ID of the service setting to get. The setting ID can be one of the following. • /ssm/appmanager/appmanager-enabled • /ssm/automation/customer-script-log-destination • /ssm/automation/customer-script-log-group-name • /ssm/automation/enable-adaptive-concurrency • /ssm/documents/console/public-sharing-permission • /ssm/managed-instance/activation-tier GetServiceSetting API Version 2014-11-06 509 AWS Systems Manager API Reference • /ssm/managed-instance/default-ec2-instance-management-role • /ssm/opsinsights/opscenter • /ssm/parameter-store/default-parameter-tier • /ssm/parameter-store/high-throughput-enabled Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Required: Yes Response Syntax { "ServiceSetting": { "ARN": "string", "LastModifiedDate": number, "LastModifiedUser": "string", "SettingId": "string", "SettingValue": "string", "Status": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ServiceSetting The query result of the current service setting. Type: ServiceSetting object Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2014-11-06 510 AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 ServiceSettingNotFound API Reference The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the AWS service team. HTTP Status Code: 400 Examples Example This example illustrates one usage of GetServiceSetting. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.GetServiceSetting Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240324T203339Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 54 { "SettingId": "/ssm/managed-instance/activation-tier" } Sample Response { "ServiceSetting": { "ARN": "arn:aws:ssm:us-east-2:111122223333:servicesetting/ssm/managed-instance/ activation-tier", Examples API Version 2014-11-06 511 AWS Systems Manager API Reference "LastModifiedDate": 1579136114.275, "LastModifiedUser": "System", "SettingId": "/ssm/managed-instance/activation-tier", "SettingValue": "standard", "Status": "Default" } } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 512 AWS Systems Manager API Reference LabelParameterVersion A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, AWS 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, "aws" 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. Request Syntax { "Labels": [ "string" ], "Name": "string", "ParameterVersion": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. LabelParameterVersion API Version 2014-11-06 513 AWS Systems Manager Labels API Reference One or more labels to attach to the specified parameter version. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of
|
systems-manager-api-098
|
systems-manager-api.pdf
| 98 |
label isn't associated with a parameter and the system displays it in the list of InvalidLabels. Request Syntax { "Labels": [ "string" ], "Name": "string", "ParameterVersion": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. LabelParameterVersion API Version 2014-11-06 513 AWS Systems Manager Labels API Reference One or more labels to attach to the specified parameter version. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes Name The parameter name on which you want to attach one or more labels. Note You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ParameterVersion The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version. Type: Long Required: No Response Syntax { "InvalidLabels": [ "string" ], "ParameterVersion": number } Response Syntax API Version 2014-11-06 514 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. InvalidLabels The label doesn't meet the requirements. For information about parameter label requirements, see Working with parameter labels in the AWS Systems Manager User Guide. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 100. ParameterVersion The version of the parameter that has been labeled. Type: Long Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 ParameterNotFound The parameter couldn't be found. Verify the name and try again. Note For the DeleteParameter and GetParameter actions, if the specified parameter doesn't exist, the ParameterNotFound exception is not recorded in AWS CloudTrail event logs. Response Elements API Version 2014-11-06 515 AWS Systems Manager HTTP Status Code: 400 ParameterVersionLabelLimitExceeded A parameter version can have a maximum of ten labels. HTTP Status Code: 400 ParameterVersionNotFound API Reference The specified parameter version wasn't found. Verify the parameter name and version, and try again. HTTP Status Code: 400 TooManyUpdates There are concurrent updates for a resource that supports one update at a time. HTTP Status Code: 400 Examples Example This example illustrates one usage of LabelParameterVersion. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.LabelParameterVersion Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T191052Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240229/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 76 { "Name": "MyGitHubPassword", "ParameterVersion": 3, Examples API Version 2014-11-06 516 API Reference AWS Systems Manager "Labels": [ "March-2020" ] } Sample Response { "InvalidLabels": [], "ParameterVersion": 3 } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 517 AWS Systems Manager ListAssociations API Reference Returns all State Manager associations in the current AWS account and AWS Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a tool in AWS Systems Manager. Request Syntax { "AssociationFilterList": [ { "key": "string", "value": "string" } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationFilterList One or more filters. Use a filter to return a more specific list of results. Note Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the managed node that are part of the Target Attributes ResourceGroup or Tags aren't returned. Type: Array of AssociationFilter objects Array Members: Minimum number of 1 item. Required: No ListAssociations API Version 2014-11-06 518 AWS Systems Manager MaxResults API Reference The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required:
|
systems-manager-api-099
|
systems-manager-api.pdf
| 99 |
the Target Attributes ResourceGroup or Tags aren't returned. Type: Array of AssociationFilter objects Array Members: Minimum number of 1 item. Required: No ListAssociations API Version 2014-11-06 518 AWS Systems Manager MaxResults API Reference The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "Associations": [ { "AssociationId": "string", "AssociationName": "string", "AssociationVersion": "string", "DocumentVersion": "string", "Duration": number, "InstanceId": "string", "LastExecutionDate": number, "Name": "string", "Overview": { "AssociationStatusAggregatedCount": { "string" : number }, "DetailedStatus": "string", "Status": "string" }, "ScheduleExpression": "string", "ScheduleOffset": number, "TargetMaps": [ { Response Syntax API Version 2014-11-06 519 AWS Systems Manager API Reference "string" : [ "string" ] } ], "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Associations The associations. Type: Array of Association objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Response Elements API Version 2014-11-06 520 API Reference AWS Systems Manager InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListAssociations. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListAssociations Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240325T143814Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "Associations": [ { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "AssociationVersion": "1", "LastExecutionDate": 1582037438.692, "Name": "AWS-UpdateSSMAgent", "Overview": { "AssociationStatusAggregatedCount": { "Success": 3 }, "DetailedStatus": "Success", "Status": "Success" }, Examples API Version 2014-11-06 521 AWS Systems Manager API Reference "Targets": [ { "Key": "tag:ssm", "Values": [ "true" ] } ] } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 522 AWS Systems Manager API Reference ListAssociationVersions Retrieves all versions of an association for a specific association ID. Request Syntax { "AssociationId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationId The association ID for which you want to view all versions. Type: String Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a- fA-F]{12} Required: Yes MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken A token to start the list. Use this token to get the next set of results. ListAssociationVersions API Version 2014-11-06 523 API Reference AWS Systems Manager Type: String Required: No Response Syntax { "AssociationVersions": [ { "ApplyOnlyAtCronInterval": boolean, "AssociationId": "string", "AssociationName": "string", "AssociationVersion": "string", "CalendarNames": [ "string" ], "ComplianceSeverity": "string", "CreatedDate": number, "DocumentVersion": "string", "Duration": number, "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "OutputLocation": { "S3Location": { "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "OutputS3Region": "string" } }, "Parameters": { "string" : [ "string" ] }, "ScheduleExpression": "string", "ScheduleOffset": number, "SyncCompliance": "string", "TargetLocations": [ { "Accounts": [ "string" ], "ExcludeAccounts": [ "string" ], "ExecutionRoleName": "string", "IncludeChildOrganizationUnits": boolean, "Regions": [ "string" ], "TargetLocationAlarmConfiguration": { "Alarms": [ Response Syntax API Version 2014-11-06 524 AWS Systems Manager API Reference { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } ], "TargetMaps": [ { "string" : [ "string" ] } ], "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AssociationVersions Information about all versions of the association for the specified association ID. Response Elements API Version 2014-11-06 525 AWS Systems Manager API Reference Type: Array of
|
systems-manager-api-100
|
systems-manager-api.pdf
| 100 |
"TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } ], "TargetMaps": [ { "string" : [ "string" ] } ], "Targets": [ { "Key": "string", "Values": [ "string" ] } ] } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AssociationVersions Information about all versions of the association for the specified association ID. Response Elements API Version 2014-11-06 525 AWS Systems Manager API Reference Type: Array of AssociationVersionInfo objects Array Members: Minimum number of 1 item. NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AssociationDoesNotExist The specified association doesn't exist. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListAssociationVersions. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Errors API Version 2014-11-06 526 AWS Systems Manager API Reference Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListAssociationVersions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240325T144807Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 57 { "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE" } Sample Response { "AssociationVersions": [ { "ApplyOnlyAtCronInterval": false, "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "AssociationVersion": "1", "CreatedDate": 1561053271.583, "Name": "AWS-UpdateSSMAgent", "Parameters": { "allowDowngrade": [ "false" ], "version": [ "" ] }, "Targets": [ { "Key": "tag:ssm", "Values": [ "true" ] } ] } ] } Examples API Version 2014-11-06 527 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 528 AWS Systems Manager API Reference ListCommandInvocations 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 SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution. Request Syntax { "CommandId": "string", "Details": boolean, "Filters": [ { "key": "string", "value": "string" } ], "InstanceId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CommandId (Optional) The invocations for a specific command ID. Type: String Length Constraints: Fixed length of 36. Required: No ListCommandInvocations API Version 2014-11-06 529 AWS Systems Manager Details API Reference (Optional) If set this returns the response of the command executions and any command output. The default value is false. Type: Boolean Required: No Filters (Optional) One or more filters. Use a filter to return a more specific list of results. Type: Array of CommandFilter objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No InstanceId (Optional) The command execution details for a specific managed node ID. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: No MaxResults (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken (Optional) The token for the next set of items to return. (You received this token from a previous call.) Request Parameters API Version 2014-11-06 530 API Reference AWS Systems Manager Type: String Required: No Response Syntax { "CommandInvocations": [ { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "string", "CloudWatchOutputEnabled": boolean }, "CommandId": "string", "CommandPlugins": [ { "Name": "string", "Output": "string", "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "OutputS3Region": "string", "ResponseCode": number, "ResponseFinishDateTime": number, "ResponseStartDateTime": number, "StandardErrorUrl": "string", "StandardOutputUrl": "string", "Status": "string", "StatusDetails": "string" } ], "Comment": "string", "DocumentName": "string", "DocumentVersion": "string", "InstanceId": "string", "InstanceName": "string", "NotificationConfig": { "NotificationArn": "string", "NotificationEvents": [ "string" ], "NotificationType": "string" }, "RequestedDateTime": number, "ServiceRole": "string", "StandardErrorUrl": "string", Response Syntax API Version 2014-11-06 531 AWS Systems Manager API Reference "StandardOutputUrl": "string", "Status": "string", "StatusDetails": "string", "TraceOutput": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CommandInvocations (Optional) A list of all invocations. Type: Array of CommandInvocation objects NextToken (Optional)
|
systems-manager-api-101
|
systems-manager-api.pdf
| 101 |
"string", "StandardOutputUrl": "string", "Status": "string", "StatusDetails": "string" } ], "Comment": "string", "DocumentName": "string", "DocumentVersion": "string", "InstanceId": "string", "InstanceName": "string", "NotificationConfig": { "NotificationArn": "string", "NotificationEvents": [ "string" ], "NotificationType": "string" }, "RequestedDateTime": number, "ServiceRole": "string", "StandardErrorUrl": "string", Response Syntax API Version 2014-11-06 531 AWS Systems Manager API Reference "StandardOutputUrl": "string", "Status": "string", "StatusDetails": "string", "TraceOutput": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CommandInvocations (Optional) A list of all invocations. Type: Array of CommandInvocation objects NextToken (Optional) The token for the next set of items to return. (You received this token from a previous call.) Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidCommandId The specified command ID isn't valid. Verify the ID and try again. HTTP Status Code: 400 Response Elements API Version 2014-11-06 532 AWS Systems Manager InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidInstanceId API Reference The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListCommandInvocations. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListCommandInvocations Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240221T000322Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 53 Examples API Version 2014-11-06 533 AWS Systems Manager API Reference { "CommandId": "4171bb3b-fe26-48ea-94fe-d1727b4d58e5" } Sample Response { "CommandInvocations": [ { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", "CloudWatchOutputEnabled": false }, "CommandId": "4171bb3b-fe26-48ea-94fe-d1727EXAMPLE", "CommandPlugins": [], "Comment": "", "DocumentName": "AWS-FindWindowsUpdates", "DocumentVersion": "1", "InstanceId": "i-02573cafcfEXAMPLE", "InstanceName": "EXAMPLE-4J5FVEG.WORKGROUP", "NotificationConfig": { "NotificationArn": "arn:aws:sns:us-east-2:111122223333:my-us-east-2- notification-arn", "NotificationEvents": [ "All" ], "NotificationType": "Invocation" }, "RequestedDateTime": 1579893879.775, "ServiceRole": "arn:aws:iam::111122223333:role/my-SNS-notifications-role", "StandardErrorUrl": "https://s3.us-east-2.amazonaws.com/amzn-s3- demo-bucket/my-output/1231bb3b-fe26-48ea-94fe-d1727EXAMPLE/i-02573cafcfEXAMPLE/ awsrunPowerShellScript/0.awsrunPowerShellScript/stderr", "StandardOutputUrl": "https://s3.us-east-2.amazonaws.com/amzn-s3- demo-bucket/my-output/1231bb3b-fe26-48ea-94fe-d1727EXAMPLE/i-02573cafcfEXAMPLE/ awsrunPowerShellScript/0.awsrunPowerShellScript/stdout", "Status": "Success", "StatusDetails": "Success" }, { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "", Examples API Version 2014-11-06 534 AWS Systems Manager API Reference "CloudWatchOutputEnabled": false }, "CommandId": "4171bb3b-fe26-48ea-94fe-d1727EXAMPLE", "CommandPlugins": [], "Comment": "", "DocumentName": "AWS-FindWindowsUpdates", "DocumentVersion": "1", "InstanceId": "i-0471e04240EXAMPLE", "InstanceName": "EXAMPLE-A1PDOM8.WORKGROUP", "NotificationConfig": { "NotificationArn": "arn:aws:sns:us-east-2:111122223333:my-us-east-2- notification-arn", "NotificationEvents": [ "All" ], "NotificationType": "Invocation" }, "RequestedDateTime": 1579893879.6, "ServiceRole": "arn:aws:iam::111122223333:role/my-SNS-notifications-role", "StandardErrorUrl": "https://s3.us-east-2.amazonaws.com/amzn-s3- demo-bucket/my-output/4171bb3b-fe26-48ea-94fe-d1727EXAMPLE/i-0471e04240EXAMPLE/ awsrunPowerShellScript/0.awsrunPowerShellScript/stderr", "StandardOutputUrl": "https://s3.us-east-2.amazonaws.com/amzn-s3- demo-bucket/my-output/4171bb3b-fe26-48ea-94fe-d1727EXAMPLE/i-0471e04240EXAMPLE/ awsrunPowerShellScript/0.awsrunPowerShellScript/stdout", "Status": "Success", "StatusDetails": "Success" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2014-11-06 535 AWS Systems Manager • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 536 AWS Systems Manager ListCommands Lists the commands requested by users of the AWS account. API Reference Request Syntax { "CommandId": "string", "Filters": [ { "key": "string", "value": "string" } ], "InstanceId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CommandId (Optional) If provided, lists only the specified command. Type: String Length Constraints: Fixed length of 36. Required: No Filters (Optional) One or more filters. Use a filter to return a more specific list of results. Type: Array of CommandFilter objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No ListCommands API Version 2014-11-06 537 AWS Systems Manager InstanceId API Reference (Optional) Lists commands issued against this managed node ID. Note You can't specify a managed node ID in the same command that you specify Status = Pending. This is because the command hasn't reached the managed node yet. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: No MaxResults (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken (Optional) The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "Commands": [ { "AlarmConfiguration": { "Alarms": [ { Response Syntax API Version 2014-11-06 538 AWS Systems Manager API Reference "Name": "string" } ], "IgnorePollAlarmFailure": boolean
|
systems-manager-api-102
|
systems-manager-api.pdf
| 102 |
No MaxResults (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken (Optional) The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "Commands": [ { "AlarmConfiguration": { "Alarms": [ { Response Syntax API Version 2014-11-06 538 AWS Systems Manager API Reference "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "string", "CloudWatchOutputEnabled": boolean }, "CommandId": "string", "Comment": "string", "CompletedCount": number, "DeliveryTimedOutCount": number, "DocumentName": "string", "DocumentVersion": "string", "ErrorCount": number, "ExpiresAfter": number, "InstanceIds": [ "string" ], "MaxConcurrency": "string", "MaxErrors": "string", "NotificationConfig": { "NotificationArn": "string", "NotificationEvents": [ "string" ], "NotificationType": "string" }, "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "OutputS3Region": "string", "Parameters": { "string" : [ "string" ] }, "RequestedDateTime": number, "ServiceRole": "string", "Status": "string", "StatusDetails": "string", "TargetCount": number, "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TimeoutSeconds": number, "TriggeredAlarms": [ Response Syntax API Version 2014-11-06 539 AWS Systems Manager API Reference { "Name": "string", "State": "string" } ] } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Commands (Optional) The list of commands requested by the user. Type: Array of Command objects NextToken (Optional) The token for the next set of items to return. (You received this token from a previous call.) Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidCommandId The specified command ID isn't valid. Verify the ID and try again. HTTP Status Code: 400 Response Elements API Version 2014-11-06 540 AWS Systems Manager InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidInstanceId API Reference The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListCommands. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListCommands Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240221T002657Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 53 Examples API Version 2014-11-06 541 AWS Systems Manager API Reference { "CommandId": "088e4813-f292-48b3-8180-d8be9EXAMPLE" } Sample Response { "Commands": [ { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "my-log-group", "CloudWatchOutputEnabled": true }, "CommandId": "088e4813-f292-48b3-8180-d8be9EXAMPLE", "Comment": "", "CompletedCount": 0, "DeliveryTimedOutCount": 0, "DocumentName": "AWS-InstallMissingWindowsUpdates", "DocumentVersion": "1", "ErrorCount": 0, "ExpiresAfter": 1582248743.188, "InstanceIds": [], "Interactive": false, "MaxConcurrency": "2", "MaxErrors": "3", "NotificationConfig": { "NotificationArn": "arn:aws:sns:us-east-2:111122223333:my-us-east-2- notification-arn", "NotificationEvents": [ "All" ], "NotificationType": "Command" }, "OutputS3BucketName": "amzn-s3-demo-bucket", "OutputS3KeyPrefix": "my-prefix", "Parameters": { "ExcludeKbArticleIds": [ "" ], "UpdateLevel": [ "All" ] Examples API Version 2014-11-06 542 AWS Systems Manager }, API Reference "RequestedDateTime": 1582244543.188, "ServiceRole": "arn:aws:iam::111122223333:role/my-SNS-notifications-role", "Status": "InProgress", "StatusDetails": "InProgress", "TargetCount": 5, "Targets": [ { "Key": "InstanceIds", "Values": [ "i-09c350ed76EXAMPLE", "i-07be1baa4aEXAMPLE", "i-00ec29b21eEXAMPLE", "i-09911ddd90EXAMPLE", "i-017431b35cEXAMPLE" ] } ] } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 543 AWS Systems Manager API Reference ListComplianceItems 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. Request Syntax { "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ResourceIds": [ "string" ], "ResourceTypes": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more compliance filters. Use a filter to return a more specific list of results. Type: Array of ComplianceStringFilter objects Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next
|
systems-manager-api-103
|
systems-manager-api.pdf
| 103 |
"string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ResourceIds": [ "string" ], "ResourceTypes": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more compliance filters. Use a filter to return a more specific list of results. Type: Array of ComplianceStringFilter objects Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer ListComplianceItems API Version 2014-11-06 544 AWS Systems Manager API Reference Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken A token to start the list. Use this token to get the next set of results. Type: String Required: No ResourceIds The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 100. Required: No ResourceTypes The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 50. Required: No Response Syntax { "ComplianceItems": [ { "ComplianceType": "string", "Details": { Response Syntax API Version 2014-11-06 545 AWS Systems Manager API Reference "string" : "string" }, "ExecutionSummary": { "ExecutionId": "string", "ExecutionTime": number, "ExecutionType": "string" }, "Id": "string", "ResourceId": "string", "ResourceType": "string", "Severity": "string", "Status": "string", "Title": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ComplianceItems A list of compliance information for the specified resource ID. Type: Array of ComplianceItem objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. Response Elements API Version 2014-11-06 546 AWS Systems Manager HTTP Status Code: 500 InvalidFilter API Reference The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 InvalidResourceId The resource ID isn't valid. Verify that you entered the correct ID and try again. HTTP Status Code: 400 InvalidResourceType 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. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListComplianceItems. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListComplianceItems Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240401T173645Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Examples API Version 2014-11-06 547 AWS Systems Manager Content-Length: 40 { "ResourceIds": [ "i-0cb99161f6EXAMPLE" ] } Sample Response { "ComplianceItems": [ { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-0cb99161f6EXAMPLE", "Id": "bdf308d4-b431-440d-a2ee-dcca7EXAMPLE", "Title": "", "Status": "COMPLIANT", "Severity": "UNSPECIFIED", "ExecutionSummary": { "ExecutionTime": 1585761335 }, "Details": { "DocumentName": "AWS-GatherSoftwareInventory", "DocumentVersion": "1" } }, { "ComplianceType": "Association", "ResourceType": "ManagedInstance", "ResourceId": "i-0cb99161f6EXAMPLE", "Id": "fa94c678-85c6-4d40-926b-7c791EXAMPLE", "Title": "", "Status": "COMPLIANT", "Severity": "HIGH", "ExecutionSummary": { "ExecutionTime": 1585761335 }, "Details": { "DocumentName": "AWS-UpdateSSMAgent", "DocumentVersion": "1" } Examples API Reference API Version 2014-11-06 548 AWS Systems Manager } ] } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 549 AWS Systems Manager API Reference ListComplianceSummaries 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. Request Syntax { "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more compliance or inventory filters. Use a filter to return a more specific list of results. Type: Array of ComplianceStringFilter objects Required: No MaxResults The maximum number of items to return for this call. Currently, you can specify
|
systems-manager-api-104
|
systems-manager-api.pdf
| 104 |
patches, or custom compliance types according to the filter criteria that you specify. Request Syntax { "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more compliance or inventory filters. Use a filter to return a more specific list of results. Type: Array of ComplianceStringFilter objects Required: No MaxResults The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. ListComplianceSummaries API Version 2014-11-06 550 AWS Systems Manager Required: No NextToken A token to start the list. Use this token to get the next set of results. API Reference Type: String Required: No Response Syntax { "ComplianceSummaryItems": [ { "ComplianceType": "string", "CompliantSummary": { "CompliantCount": number, "SeveritySummary": { "CriticalCount": number, "HighCount": number, "InformationalCount": number, "LowCount": number, "MediumCount": number, "UnspecifiedCount": number } }, "NonCompliantSummary": { "NonCompliantCount": number, "SeveritySummary": { "CriticalCount": number, "HighCount": number, "InformationalCount": number, "LowCount": number, "MediumCount": number, "UnspecifiedCount": number } } } ], "NextToken": "string" } Response Syntax API Version 2014-11-06 551 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ComplianceSummaryItems A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified. Type: Array of ComplianceSummaryItem objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Response Elements API Version 2014-11-06 552 API Reference AWS Systems Manager Examples Example This example illustrates one usage of ListComplianceSummaries. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListComplianceSummaries Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240401T174348Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "ComplianceSummaryItems": [ { "ComplianceType": "FleetTotal", "CompliantSummary": { "CompliantCount": 1, "SeveritySummary": { "CriticalCount": 0, "HighCount": 1, "InformationalCount": 0, "LowCount": 0, "MediumCount": 0, "UnspecifiedCount": 0 } }, "NonCompliantSummary": { "NonCompliantCount": 2, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "InformationalCount": 0, Examples API Version 2014-11-06 553 AWS Systems Manager API Reference "LowCount": 0, "MediumCount": 0, "UnspecifiedCount": 2 } } }, { "ComplianceType": "Association", "CompliantSummary": { "CompliantCount": 3, "SeveritySummary": { "CriticalCount": 0, "HighCount": 2, "InformationalCount": 0, "LowCount": 0, "MediumCount": 0, "UnspecifiedCount": 1 } }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "InformationalCount": 0, "LowCount": 0, "MediumCount": 0, "UnspecifiedCount": 0 } } }, { "ComplianceType": "Patch", "CompliantSummary": { "CompliantCount": 1, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "InformationalCount": 0, "LowCount": 0, "MediumCount": 0, "UnspecifiedCount": 1 } }, Examples API Version 2014-11-06 554 AWS Systems Manager API Reference "NonCompliantSummary": { "NonCompliantCount": 2, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "InformationalCount": 0, "LowCount": 0, "MediumCount": 0, "UnspecifiedCount": 2 } } } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 555 AWS Systems Manager API Reference ListDocumentMetadataHistory Information about approval reviews for a version of a change template in Change Manager. Request Syntax { "DocumentVersion": "string", "MaxResults": number, "Metadata": "string", "Name": "string", "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentVersion The version of the change template. Type: String Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No Metadata The type of data for which details are being requested. Currently, the only supported value is
|
systems-manager-api-105
|
systems-manager-api.pdf
| 105 |
Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentVersion The version of the change template. Type: String Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No Metadata The type of data for which details are being requested. Currently, the only supported value is DocumentReviews. ListDocumentMetadataHistory API Version 2014-11-06 556 API Reference AWS Systems Manager Type: String Valid Values: DocumentReviews Required: Yes Name The name of the change template. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: Yes NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { "Author": "string", "DocumentVersion": "string", "Metadata": { "ReviewerResponse": [ { "Comment": [ { "Content": "string", "Type": "string" } ], "CreateTime": number, "Reviewer": "string", "ReviewStatus": "string", "UpdatedTime": number } ] Response Syntax API Version 2014-11-06 557 AWS Systems Manager }, "Name": "string", "NextToken": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Author The user ID of the person in the organization who requested the review of the change template. Type: String DocumentVersion The version of the change template. Type: String Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) Metadata Information about the response to the change template approval request. Type: DocumentMetadataResponseInfo object Name The name of the change template. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ NextToken The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: String Response Elements API Version 2014-11-06 558 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentVersion The document version isn't valid or doesn't exist. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListDocumentMetadataHistory. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListDocumentMetadataHistory Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240730T154930Z Errors API Version 2014-11-06 559 AWS Systems Manager API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240730/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 68 { "Name": "MyChangeManagerTemplate", "Metadata": "DocumentReviews" } Sample Response { "Name": "MyChangeManagerTemplate", "DocumentVersion": "1", "Author": "arn:aws:iam::111122223333:user/JohnDoe", "Metadata": { "ReviewerResponse": [ { "CreateTime": "2024-07-30T11:58:28.025000-07:00", "UpdatedTime": "2024-07-30T12:01:19.274000-07:00", "ReviewStatus": "APPROVED", "Comment": [ { "Type": "COMMENT", "Content": "I approve this template version" } ], "Reviewer": "arn:aws:iam::111122223333:user/ShirleyRodriguez" }, { "CreateTime": "2024-07-30T11:58:28.025000-07:00", "UpdatedTime": "2024-07-30T11:58:28.025000-07:00", "ReviewStatus": "PENDING" } ] } } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2014-11-06 560 API Reference AWS Systems Manager • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 561 AWS Systems Manager ListDocuments API Reference Returns all Systems Manager (SSM) documents in the current AWS account and AWS Region. You can limit the results of this request by using a filter. Request Syntax { "DocumentFilterList": [ { "key": "string", "value": "string" } ], "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DocumentFilterList This data type is deprecated. Instead, use Filters. Type: Array of DocumentFilter objects Array Members: Minimum number of 1 item. Required: No ListDocuments API Version 2014-11-06 562 AWS Systems Manager Filters API Reference One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName. Note This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2 Type: Array of DocumentKeyValuesFilter objects Array Members: Minimum number of 0 items. Maximum number
|
systems-manager-api-106
|
systems-manager-api.pdf
| 106 |
One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName. Note This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2 Type: Array of DocumentKeyValuesFilter objects Array Members: Minimum number of 0 items. Maximum number of 6 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No Response Syntax { Response Syntax API Version 2014-11-06 563 AWS Systems Manager API Reference "DocumentIdentifiers": [ { "Author": "string", "CreatedDate": number, "DisplayName": "string", "DocumentFormat": "string", "DocumentType": "string", "DocumentVersion": "string", "Name": "string", "Owner": "string", "PlatformTypes": [ "string" ], "Requires": [ { "Name": "string", "RequireType": "string", "Version": "string", "VersionName": "string" } ], "ReviewStatus": "string", "SchemaVersion": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "string", "VersionName": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DocumentIdentifiers The names of the SSM documents. Response Elements API Version 2014-11-06 564 AWS Systems Manager API Reference Type: Array of DocumentIdentifier objects NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilterKey The specified key isn't valid. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListDocuments. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListDocuments Errors API Version 2014-11-06 565 AWS Systems Manager API Reference Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240325T150301Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 97 { "Filters": [ { "Key": "Owner", "Values": [ "Self" ] }, { "Key": "tag:DocUse", "Values": [ "Testing" ] } ] } Sample Response { "DocumentIdentifiers": [ { "CreatedDate": 1486594364.541, "DocumentFormat": "YAML", "DocumentType": "Automation", "DocumentVersion": "1", "DisplayName": "ExampleDoc", "Name": "Example", "Owner": "111122223333", "PlatformTypes": [ "Windows", "Linux" ], "SchemaVersion": "0.3", "Tags": [ Examples API Version 2014-11-06 566 API Reference AWS Systems Manager { "Key": "DocUse", "Value": "Testing" } ] } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 567 AWS Systems Manager API Reference ListDocumentVersions List all versions for a document. Request Syntax { "MaxResults": number, "Name": "string", "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No Name The name of the document. You can specify an Amazon Resource Name (ARN). Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: Yes NextToken The token for the next set of items to return. (You received this token from a previous call.) ListDocumentVersions API Version 2014-11-06 568 API Reference AWS Systems Manager Type: String Required: No Response Syntax { "DocumentVersions": [ { "CreatedDate": number, "DisplayName": "string", "DocumentFormat": "string", "DocumentVersion": "string", "IsDefaultVersion": boolean, "Name": "string", "ReviewStatus": "string", "Status": "string", "StatusInformation": "string", "VersionName": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DocumentVersions The document versions. Type: Array of DocumentVersionInfo objects Array Members: Minimum number of 1 item. NextToken The token to use when requesting the next set of items. If there are no
|
systems-manager-api-107
|
systems-manager-api.pdf
| 107 |
2014-11-06 568 API Reference AWS Systems Manager Type: String Required: No Response Syntax { "DocumentVersions": [ { "CreatedDate": number, "DisplayName": "string", "DocumentFormat": "string", "DocumentVersion": "string", "IsDefaultVersion": boolean, "Name": "string", "ReviewStatus": "string", "Status": "string", "StatusInformation": "string", "VersionName": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DocumentVersions The document versions. Type: Array of DocumentVersionInfo objects Array Members: Minimum number of 1 item. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Response Syntax API Version 2014-11-06 569 AWS Systems Manager Type: String Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListDocumentVersions. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListDocumentVersions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240325T151751Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Errors API Version 2014-11-06 570 API Reference AWS Systems Manager Content-Length: 30 { "Name": "AWS-UpdateSSMAgent" } Sample Response { "DocumentVersions": [ { "CreatedDate": 1486594364.541, "DisplayName": "ExampleDoc", "DocumentFormat": "JSON", "DocumentVersion": "1", "IsDefaultVersion": true, "Name": "AWS-UpdateSSMAgent", "Status": "Active" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 571 AWS Systems Manager API Reference ListInventoryEntries A list of inventory items returned by the request. Request Syntax { "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "InstanceId": "string", "MaxResults": number, "NextToken": "string", "TypeName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more filters. Use a filter to return a more specific list of results. Type: Array of InventoryFilter objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No InstanceId The managed node ID for which you want inventory information. Type: String ListInventoryEntries API Version 2014-11-06 572 AWS Systems Manager API Reference Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No TypeName The type of inventory item for which you want information. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS|Custom):.*$ Required: Yes Response Syntax { "CaptureTime": "string", "Entries": [ { "string" : "string" } Response Syntax API Version 2014-11-06 573 AWS Systems Manager API Reference ], "InstanceId": "string", "NextToken": "string", "SchemaVersion": "string", "TypeName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CaptureTime The time that inventory information was collected for the managed nodes. Type: String Pattern: ^(20)[0-9][0-9]-(0[1-9]|1[012])-([12][0-9]|3[01]|0[1-9])(T) (2[0-3]|[0-1][0-9])(:[0-5][0-9])(:[0-5][0-9])(Z)$ Entries A list of inventory items on the managed nodes. Type: Array of string to string maps Array Members: Minimum number of 0 items. Maximum number of 10000 items. Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 64. Value Length Constraints: Minimum length of 0. Maximum length of 4096. InstanceId The managed node ID targeted by the request to query inventory information. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Response Elements API Version 2014-11-06 574 AWS Systems Manager NextToken API Reference The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String SchemaVersion The inventory schema version used by the managed nodes. Type: String Pattern: ^([0-9]{1,6})(\.[0-9]{1,6})$ TypeName The type of inventory item returned by the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS|Custom):.*$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side.
|
systems-manager-api-108
|
systems-manager-api.pdf
| 108 |
Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Response Elements API Version 2014-11-06 574 AWS Systems Manager NextToken API Reference The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String SchemaVersion The inventory schema version used by the managed nodes. Type: String Pattern: ^([0-9]{1,6})(\.[0-9]{1,6})$ TypeName The type of inventory item returned by the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^(AWS|Custom):.*$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidInstanceId The following problems can cause this exception: • You don't have permission to access the managed node. Errors API Version 2014-11-06 575 AWS Systems Manager API Reference • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 InvalidTypeNameException The parameter type name isn't valid. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListInventoryEntries. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListInventoryEntries Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240330T154930Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 68 { "InstanceId": "i-04bf6ad63bEXAMPLE", "TypeName": "AWS:Application" } Examples API Version 2014-11-06 576 API Reference AWS Systems Manager Sample Response { "CaptureTime": "2020-03-30T15:45:32Z", "Entries": [ { "Architecture": "i386", "InstalledTime": "2020-01-15T00:00:00Z", "Name": "AWS Tools for Windows", "PackageId": "{2088D019-97CC-4349-BA45-9777568EAE94}", "Publisher": "Amazon Web Services Developer Relations", "Version": "3.15.925" }, { "Architecture": "i386", "Name": "Amazon SSM Agent", "PackageId": "{2a4673c2-68c6-4a4c-9be6-c3b1be96fdff}", "Publisher": "Amazon Web Services", "Version": "2.3.930.0" }, { "Architecture": "x86_64", "InstalledTime": "2018-10-14T00:00:00Z", "Name": "aws-cfn-bootstrap", "PackageId": "{34CD0CCF-195B-4BC5-B409-D44EB9A129C8}", "Publisher": "Amazon Web Services", "Version": "1.4.31" }, { "Architecture": "x86_64", "InstalledTime": "2020-03-10T00:00:00Z", "Name": "PowerShell 7-x64", "PackageId": "{B324E508-9AAE-446A-BC4C-BB446E8C2A18}", "Publisher": "Microsoft Corporation", "Version": "7.0.0.0" }, { "Architecture": "x86_64", "InstalledTime": "2019-09-06T00:00:00Z", "Name": "AWS PV Drivers", "PackageId": "{C1F68A8D-F235-4886-87B0-150107C07EDA}", "Publisher": "Amazon Web Services", "Version": "8.3.2" } Examples API Version 2014-11-06 577 AWS Systems Manager ], "InstanceId": "i-04bf6ad63bEXAMPLE", "SchemaVersion": "1.1", "TypeName": "AWS:Application" } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 578 AWS Systems Manager ListNodes API Reference Takes in filters and returns a list of managed nodes matching the filter criteria. Request Syntax { "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "SyncName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more filters. Use a filter to return a more specific list of managed nodes. Type: Array of NodeFilter objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. ListNodes API Version 2014-11-06 579 AWS Systems Manager Required: No NextToken API Reference The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No SyncName The name of the AWS managed resource data sync to retrieve information about. For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is AWS-QuickSetup-ManagedNode. For single account/single-Region configurations, the parameter is not required. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax { "NextToken": "string", "Nodes": [ { "CaptureTime": number, "Id": "string", "NodeType": { ... }, "Owner": { "AccountId": "string", "OrganizationalUnitId": "string", "OrganizationalUnitPath": "string" }, "Region": "string" } ] } Response Syntax API Version 2014-11-06 580 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string
|
systems-manager-api-109
|
systems-manager-api.pdf
| 109 |
Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax { "NextToken": "string", "Nodes": [ { "CaptureTime": number, "Id": "string", "NodeType": { ... }, "Owner": { "AccountId": "string", "OrganizationalUnitId": "string", "OrganizationalUnitPath": "string" }, "Region": "string" } ] } Response Syntax API Version 2014-11-06 580 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Nodes A list of managed nodes that match the specified filter criteria. Type: Array of Node objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 ResourceDataSyncNotFoundException The specified sync name wasn't found. Response Elements API Version 2014-11-06 581 AWS Systems Manager HTTP Status Code: 400 UnsupportedOperationException API Reference This operation is not supported for the current account. You must first enable the Systems Manager integrated experience in your account. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListNodes. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListNodes Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20241119/25T150301Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 97 { "SyncName": "AWS-QuickSetup-ManagedNode", "Filters": [ { "Key": "Region", "Values": [ "us-east-2" ], "Type": "Equal" } ], "MaxResults": 1 } Examples API Version 2014-11-06 582 API Reference AWS Systems Manager Sample Response { "NextToken": "A9lT8CAxj9aDFRi+MNA---truncated---oFq08IEXAMPLE", "Nodes": [ { "CaptureTime": 2024-11-19T22:01:18, "Id": "i-0471e04240EXAMPLE", "NodeType": { "Instance": { "AgentType": "amazon-ssm-agent", "AgentVersion": "3.3.859.0", "ComputerName": "ip-192.0.2.0.ec2.internal", "InstanceStatus": "Active", "IpAddress": "192.0.2.0", "ManagedStatus": "Managed", "PlatformName": "Amazon Linux", "PlatformType": "Linux", "PlatformVersion": "2023", "ResourceType": "EC2Instance" } }, "Owner": { "AccountId": "444455556666", "OrganizationalUnitId": "ou-b8dn-sEXAMPLE", "OrganizationalUnitPath": "r-b8dn/ou-b8dn-sEXAMPLE" }, "Region": "us-east-2" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2014-11-06 583 AWS Systems Manager • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 584 AWS Systems Manager ListNodesSummary API Reference Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify. Request Syntax { "Aggregators": [ { "Aggregators": [ "NodeAggregator" ], "AggregatorType": "string", "AttributeName": "string", "TypeName": "string" } ], "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "SyncName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Aggregators Specify one or more aggregators to return a count of managed nodes that match that expression. For example, a count of managed nodes by operating system. Type: Array of NodeAggregator objects ListNodesSummary API Version 2014-11-06 585 AWS Systems Manager API Reference Array Members: Minimum number of 1 item. Maximum number of 2 items. Required: Yes Filters One or more filters. Use a filter to generate a summary that matches your specified filter criteria. Type: Array of NodeFilter objects Array Members: Minimum number of 1 item. Maximum number of 5 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token for the next set of items to return. (You received this token from a previous call.) The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: String Required: No SyncName The name of the AWS managed resource data sync to retrieve information about. For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is AWS-QuickSetup-ManagedNode. For single account/single-Region configurations, the parameter is not required. Type: String Request Parameters API Version 2014-11-06 586 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax { "NextToken": "string", "Summary": [ { "string" :
|
systems-manager-api-110
|
systems-manager-api.pdf
| 110 |
call also returns a token that you can specify in a subsequent call to get the next set of results. Type: String Required: No SyncName The name of the AWS managed resource data sync to retrieve information about. For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is AWS-QuickSetup-ManagedNode. For single account/single-Region configurations, the parameter is not required. Type: String Request Parameters API Version 2014-11-06 586 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax { "NextToken": "string", "Summary": [ { "string" : "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String Summary A collection of objects reporting information about your managed nodes, such as the count of nodes by operating system. Type: Array of string to string maps Array Members: Minimum number of 0 items. Maximum number of 50 items. Map Entries: Minimum number of 0 items. Maximum number of 3 items. Key Length Constraints: Minimum length of 1. Maximum length of 64. Value Length Constraints: Minimum length of 0. Maximum length of 4096. Response Syntax API Version 2014-11-06 587 AWS Systems Manager Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidAggregatorException The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported. HTTP Status Code: 400 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 ResourceDataSyncNotFoundException The specified sync name wasn't found. HTTP Status Code: 400 UnsupportedOperationException This operation is not supported for the current account. You must first enable the Systems Manager integrated experience in your account. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListNodesSummary. Errors API Version 2014-11-06 588 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListNodesSummary Content-Type: application/x-amz-json-1.1 API Reference User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20241119/25T150301Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 197 { "SyncName": "AWS-QuickSetup-ManagedNode", "Aggregators": [ {"AggregatorType": "Count", "TypeName": "Instance", "AttributeName": "Region"} ], "Filters": [ {"Key": "InstanceStatus", "Values": ["Active"], "Type": "Equal"} ], "MaxResults" : 2, "NextToken": "A9lT8CAxj9aDFRi+MNA---truncated---oFq08IEXAMPLE" } Example This example illustrates one usage of ListNodesSummary. Sample Response { "Summary": [ { "Count": "26", Examples API Version 2014-11-06 589 AWS Systems Manager API Reference "Region": "us-east-1" }, { "Count": "7", "Region": "us-east-2" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 590 AWS Systems Manager ListOpsItemEvents API Reference Returns a list of all OpsItem events in the current AWS Region and AWS account. You can limit the results to events associated with specific OpsItems by specifying a filter. Request Syntax { "Filters": [ { "Key": "string", "Operator": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more OpsItem filters. Use a filter to return a more specific list of results. Type: Array of OpsItemEventFilter objects Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ListOpsItemEvents API Version 2014-11-06 591 AWS Systems Manager NextToken API Reference A token to start the list. Use this token to get the next set of results. Type: String Required: No Response Syntax { "NextToken": "string", "Summaries": [ { "CreatedBy": { "Arn": "string" }, "CreatedTime": number, "Detail": "string", "DetailType": "string", "EventId": "string", "OpsItemId": "string", "Source": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token to get
|
systems-manager-api-111
|
systems-manager-api.pdf
| 111 |
API Version 2014-11-06 591 AWS Systems Manager NextToken API Reference A token to start the list. Use this token to get the next set of results. Type: String Required: No Response Syntax { "NextToken": "string", "Summaries": [ { "CreatedBy": { "Arn": "string" }, "CreatedTime": number, "Detail": "string", "DetailType": "string", "EventId": "string", "OpsItemId": "string", "Source": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Summaries A list of event information for the specified OpsItems. Response Syntax API Version 2014-11-06 592 AWS Systems Manager API Reference Type: Array of OpsItemEventSummary objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again. HTTP Status Code: 400 OpsItemLimitExceededException The request caused OpsItems to exceed one or more quotas. HTTP Status Code: 400 OpsItemNotFoundException The specified OpsItem ID doesn't exist. Verify the ID and try again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 Errors API Version 2014-11-06 593 AWS Systems Manager • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 594 AWS Systems Manager API Reference ListOpsItemRelatedItems Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in AWS Systems Manager. Request Syntax { "Filters": [ { "Key": "string", "Operator": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "OpsItemId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more OpsItem filters. Use a filter to return a more specific list of results. Type: Array of OpsItemRelatedItemsFilter objects Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. ListOpsItemRelatedItems API Version 2014-11-06 595 AWS Systems Manager Required: No NextToken API Reference The token for the next set of items to return. (You received this token from a previous call.) Type: String Required: No OpsItemId The ID of the OpsItem for which you want to list all related-item resources. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: No Response Syntax { "NextToken": "string", "Summaries": [ { "AssociationId": "string", "AssociationType": "string", "CreatedBy": { "Arn": "string" }, "CreatedTime": number, "LastModifiedBy": { "Arn": "string" }, "LastModifiedTime": number, "OpsItemId": "string", "ResourceType": "string", "ResourceUri": "string" } ] } Response Syntax API Version 2014-11-06 596 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Summaries A list of related-item resources for the specified OpsItem. Type: Array of OpsItemRelatedItemSummary objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 OpsItemInvalidParameterException A specified parameter argument isn't valid. Verify the available arguments and try again. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListOpsItemRelatedItems. Sample Request POST / HTTP/1.1 Response Elements API Version 2014-11-06 597 AWS Systems Manager API Reference Host: ssm.us-east-1.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListOpsItemRelatedItems Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/ssm.list-ops-item-related-items X-Amz-Date: 20240910T180314Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240910/us- east-1/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 32 { "OpsItemId": "oi-f99f2EXAMPLE" } Sample Response { "Summaries": [ { "OpsItemId": "oi-f99f2EXAMPLE", "AssociationId": "e2036148-cccb-490e-ac2a-390e5EXAMPLE", "ResourceType": "AWS::SSMIncidents::IncidentRecord", "AssociationType": "IsParentOf", "ResourceUri": "arn:aws:ssm-incidents::111122223333:incident-record/ example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", "CreatedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/ AWSServiceRoleForIncidentManager/IncidentResponse" }, "CreatedTime": "2024-08-11T18:47:14.994000+00:00", "LastModifiedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/ AWSServiceRoleForIncidentManager/IncidentResponse" }, "LastModifiedTime": "2024-08-11T18:47:14.994000+00:00" } ] } Examples API Version 2014-11-06 598 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 •
|
systems-manager-api-112
|
systems-manager-api.pdf
| 112 |
Signature=39c3b3042cd2aEXAMPLE Content-Length: 32 { "OpsItemId": "oi-f99f2EXAMPLE" } Sample Response { "Summaries": [ { "OpsItemId": "oi-f99f2EXAMPLE", "AssociationId": "e2036148-cccb-490e-ac2a-390e5EXAMPLE", "ResourceType": "AWS::SSMIncidents::IncidentRecord", "AssociationType": "IsParentOf", "ResourceUri": "arn:aws:ssm-incidents::111122223333:incident-record/ example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", "CreatedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/ AWSServiceRoleForIncidentManager/IncidentResponse" }, "CreatedTime": "2024-08-11T18:47:14.994000+00:00", "LastModifiedBy": { "Arn": "arn:aws:sts::111122223333:assumed-role/ AWSServiceRoleForIncidentManager/IncidentResponse" }, "LastModifiedTime": "2024-08-11T18:47:14.994000+00:00" } ] } Examples API Version 2014-11-06 598 AWS Systems Manager See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 599 AWS Systems Manager ListOpsMetadata API Reference AWS Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs. Request Syntax { "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more filters to limit the number of OpsMetadata objects returned by the call. Type: Array of OpsMetadataFilter objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. ListOpsMetadata API Version 2014-11-06 600 AWS Systems Manager Required: No NextToken A token to start the list. Use this token to get the next set of results. API Reference Type: String Required: No Response Syntax { "NextToken": "string", "OpsMetadataList": [ { "CreationDate": number, "LastModifiedDate": number, "LastModifiedUser": "string", "OpsMetadataArn": "string", "ResourceId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String OpsMetadataList Returns a list of OpsMetadata objects. Type: Array of OpsMetadata objects Response Syntax API Version 2014-11-06 601 AWS Systems Manager API Reference Array Members: Minimum number of 1 item. Maximum number of 50 items. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 OpsMetadataInvalidArgumentException One of the arguments passed is invalid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2014-11-06 602 AWS Systems Manager API Reference ListResourceComplianceSummaries 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. Request Syntax { "Filters": [ { "Key": "string", "Type": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Filters One or more filters. Use a filter to return a more specific list of results. Type: Array of ComplianceStringFilter objects Required: No MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. ListResourceComplianceSummaries API Version 2014-11-06 603 AWS Systems Manager Required: No NextToken A token to start the list. Use this token to get the next set of results. API Reference Type: String Required: No Response Syntax { "NextToken": "string", "ResourceComplianceSummaryItems": [ { "ComplianceType": "string", "CompliantSummary": { "CompliantCount": number, "SeveritySummary": { "CriticalCount": number, "HighCount": number, "InformationalCount": number, "LowCount": number, "MediumCount": number, "UnspecifiedCount": number } }, "ExecutionSummary": { "ExecutionId": "string", "ExecutionTime": number, "ExecutionType": "string" }, "NonCompliantSummary": { "NonCompliantCount": number, "SeveritySummary": { "CriticalCount": number, "HighCount": number, "InformationalCount": number, "LowCount": number, "MediumCount": number, "UnspecifiedCount": number } Response Syntax API Version 2014-11-06 604 AWS Systems Manager API Reference }, "OverallSeverity": "string", "ResourceId": "string", "ResourceType": "string", "Status": "string" } ] } Response Elements If the action is successful,
|
systems-manager-api-113
|
systems-manager-api.pdf
| 113 |
get the next set of results. API Reference Type: String Required: No Response Syntax { "NextToken": "string", "ResourceComplianceSummaryItems": [ { "ComplianceType": "string", "CompliantSummary": { "CompliantCount": number, "SeveritySummary": { "CriticalCount": number, "HighCount": number, "InformationalCount": number, "LowCount": number, "MediumCount": number, "UnspecifiedCount": number } }, "ExecutionSummary": { "ExecutionId": "string", "ExecutionTime": number, "ExecutionType": "string" }, "NonCompliantSummary": { "NonCompliantCount": number, "SeveritySummary": { "CriticalCount": number, "HighCount": number, "InformationalCount": number, "LowCount": number, "MediumCount": number, "UnspecifiedCount": number } Response Syntax API Version 2014-11-06 604 AWS Systems Manager API Reference }, "OverallSeverity": "string", "ResourceId": "string", "ResourceType": "string", "Status": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String ResourceComplianceSummaryItems A summary count for specified or targeted managed nodes. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify. Type: Array of ResourceComplianceSummaryItem objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidFilter The filter name isn't valid. Verify that you entered the correct name and try again. HTTP Status Code: 400 Response Elements API Version 2014-11-06 605 AWS Systems Manager InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 Examples Example API Reference This example illustrates one usage of ListResourceComplianceSummaries. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListResourceComplianceSummaries Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240401T185225Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "ResourceComplianceSummaryItems": [ { "ComplianceType": "Association", "CompliantSummary": { "CompliantCount": 3, "SeveritySummary": { "CriticalCount": 0, "HighCount": 1, "InformationalCount": 0, "LowCount": 0, "MediumCount": 0, "UnspecifiedCount": 2 } }, Examples API Version 2014-11-06 606 AWS Systems Manager API Reference "ExecutionSummary": { "ExecutionTime": 1585766022 }, "NonCompliantSummary": { "NonCompliantCount": 0, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "InformationalCount": 0, "LowCount": 0, "MediumCount": 0, "UnspecifiedCount": 0 } }, "OverallSeverity": "HIGH", "ResourceId": "i-04bf6ad63bEXAMPLE", "ResourceType": "ManagedInstance", "Status": "COMPLIANT" }, { "ComplianceType": "Patch", "CompliantSummary": { "CompliantCount": 27, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "InformationalCount": 0, "LowCount": 0, "MediumCount": 0, "UnspecifiedCount": 27 } }, "ExecutionSummary": { "ExecutionId": "b95523e7-28e5-488e-a753-fd1d3EXAMPLE", "ExecutionTime": 1585244656, "ExecutionType": "Command" }, "NonCompliantSummary": { "NonCompliantCount": 1, "SeveritySummary": { "CriticalCount": 0, "HighCount": 0, "InformationalCount": 0, "LowCount": 0, Examples API Version 2014-11-06 607 AWS Systems Manager API Reference "MediumCount": 0, "UnspecifiedCount": 1 } }, "OverallSeverity": "UNSPECIFIED", "ResourceId": "i-04bf6ad63bEXAMPLE", "ResourceType": "ManagedInstance", "Status": "NON_COMPLIANT" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 608 AWS Systems Manager API Reference ListResourceDataSync 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. Request Syntax { "MaxResults": number, "NextToken": "string", "SyncType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken A token to start the list. Use this token to get the next set of results. Type: String ListResourceDataSync API Version 2014-11-06 609 AWS Systems Manager Required: No SyncType API Reference View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from AWS Organizations or from multiple AWS Regions. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax { "NextToken": "string", "ResourceDataSyncItems": [ { "LastStatus":
|
systems-manager-api-114
|
systems-manager-api.pdf
| 114 |
50. Required: No NextToken A token to start the list. Use this token to get the next set of results. Type: String ListResourceDataSync API Version 2014-11-06 609 AWS Systems Manager Required: No SyncType API Reference View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from AWS Organizations or from multiple AWS Regions. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax { "NextToken": "string", "ResourceDataSyncItems": [ { "LastStatus": "string", "LastSuccessfulSyncTime": number, "LastSyncStatusMessage": "string", "LastSyncTime": number, "S3Destination": { "AWSKMSKeyARN": "string", "BucketName": "string", "DestinationDataSharing": { "DestinationDataSharingType": "string" }, "Prefix": "string", "Region": "string", "SyncFormat": "string" }, "SyncCreatedTime": number, "SyncLastModifiedTime": number, "SyncName": "string", "SyncSource": { "AwsOrganizationsSource": { "OrganizationalUnits": [ { "OrganizationalUnitId": "string" Response Syntax API Version 2014-11-06 610 API Reference AWS Systems Manager } ], "OrganizationSourceType": "string" }, "EnableAllOpsDataSources": boolean, "IncludeFutureRegions": boolean, "SourceRegions": [ "string" ], "SourceType": "string", "State": "string" }, "SyncType": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String ResourceDataSyncItems A list of your current resource data sync configurations and their statuses. Type: Array of ResourceDataSyncItem objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 Response Elements API Version 2014-11-06 611 API Reference AWS Systems Manager InvalidNextToken The specified token isn't valid. HTTP Status Code: 400 ResourceDataSyncInvalidConfigurationException The specified sync configuration is invalid. HTTP Status Code: 400 Examples Example This example illustrates one usage of ListResourceDataSync. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListResourceDataSync Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240330T143820Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 2 Sample Response { "ResourceDataSyncItems": [ { "LastStatus": "Successful", "LastSuccessfulSyncTime": 1585578819.829, "LastSyncStatusMessage": "The sync was successfully completed", "LastSyncTime": 1585578819.829, "S3Destination": { Examples API Version 2014-11-06 612 AWS Systems Manager API Reference "BucketName": "amzn-s3-demo-bucket", "Prefix": "amzn-s3-demo-bucket-prefix", "Region": "us-east-2", "SyncFormat": "JsonSerDe" }, "SyncCreatedTime": 1585330479.404, "SyncLastModifiedTime": 1585330479.404, "SyncName": "exampleSync" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 613 AWS Systems Manager API Reference ListTagsForResource Returns a list of the tags assigned to the specified resource. For information about the ID format for each supported resource type, see AddTagsToResource. Request Syntax { "ResourceId": "string", "ResourceType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceId The resource ID for which you want to see a list of tags. Type: String Required: Yes ResourceType Returns a list of tags for a specific resource type. Type: String Valid Values: Document | ManagedInstance | MaintenanceWindow | Parameter | PatchBaseline | OpsItem | OpsMetadata | Automation | Association Required: Yes Response Syntax { ListTagsForResource API Version 2014-11-06 614 AWS Systems Manager API Reference "TagList": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TagList A list of tags. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidResourceId The resource ID isn't valid. Verify that you entered the correct ID and try again. HTTP Status Code: 400 InvalidResourceType 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. Response Elements API Version 2014-11-06 615 API Reference AWS Systems Manager HTTP Status Code: 400 Examples Example This example illustrates one usage of ListTagsForResource. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListTagsForResource Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240221T003710Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 71 { "ResourceType": "PatchBaseline", "ResourceId": "pb-0c10e65780EXAMPLE" } Sample Response { "TagList": [ { "Key": "Platform", "Value": "Windows Server" }, { "Key": "Environment", "Value": "Production" }, { "Key": "Region", "Value": "EMEA" Examples
|
systems-manager-api-115
|
systems-manager-api.pdf
| 115 |
example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node. Response Elements API Version 2014-11-06 615 API Reference AWS Systems Manager HTTP Status Code: 400 Examples Example This example illustrates one usage of ListTagsForResource. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ListTagsForResource Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240221T003710Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 71 { "ResourceType": "PatchBaseline", "ResourceId": "pb-0c10e65780EXAMPLE" } Sample Response { "TagList": [ { "Key": "Platform", "Value": "Windows Server" }, { "Key": "Environment", "Value": "Production" }, { "Key": "Region", "Value": "EMEA" Examples API Version 2014-11-06 616 AWS Systems Manager } ] } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 617 AWS Systems Manager API Reference ModifyDocumentPermission Shares a AWS 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. Request Syntax { "AccountIdsToAdd": [ "string" ], "AccountIdsToRemove": [ "string" ], "Name": "string", "PermissionType": "string", "SharedDocumentVersion": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AccountIdsToAdd The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All. You must specify a value for this parameter or the AccountIdsToRemove parameter. Type: Array of strings Array Members: Maximum number of 20 items. Pattern: (?i)all|[0-9]{12} Required: No AccountIdsToRemove The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the ModifyDocumentPermission API Version 2014-11-06 618 AWS Systems Manager API Reference system removes access to the document. You must specify a value for this parameter or the AccountIdsToAdd parameter. Type: Array of strings Array Members: Maximum number of 20 items. Pattern: (?i)all|[0-9]{12} Required: No Name The name of the document that you want to share. Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: Yes PermissionType The permission type for the document. The permission type can be Share. Type: String Valid Values: Share Required: Yes SharedDocumentVersion (Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share. Type: String Length Constraints: Maximum length of 8. Pattern: ([$]LATEST|[$]DEFAULT|[$]ALL) Required: No Request Parameters API Version 2014-11-06 619 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DocumentLimitExceeded You can have at most 500 active SSM documents. HTTP Status Code: 400 DocumentPermissionLimit The document can't be shared with more AWS 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 AWS Support. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The specified SSM document doesn't exist. HTTP Status Code: 400 InvalidPermissionType The permission type isn't supported. Share is the only supported permission type. HTTP Status Code: 400 Response Elements API Version 2014-11-06 620 AWS Systems Manager Examples Example API Reference This example illustrates one usage of ModifyDocumentPermission. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ModifyDocumentPermission Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240325T152441Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 78 { "Name": "Example", "PermissionType": "Share", "AccountIdsToAdd": [ "444455556666" ] } Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Examples API Version 2014-11-06 621 AWS Systems Manager • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for
|
systems-manager-api-116
|
systems-manager-api.pdf
| 116 |
Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.ModifyDocumentPermission Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240325T152441Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 78 { "Name": "Example", "PermissionType": "Share", "AccountIdsToAdd": [ "444455556666" ] } Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Examples API Version 2014-11-06 621 AWS Systems Manager • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 622 AWS Systems Manager API Reference PutComplianceItems 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:string. • 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, approved for patches, or Failed for associations. • Severity: A patch severity. For example, Critical. • DocumentName: An SSM document name. For example, AWS-RunPatchBaseline. • DocumentVersion: An SSM document version number. For example, 4. • Classification: A patch classification. For example, security updates. • PatchBaselineId: A patch baseline ID. • PatchSeverity: A patch severity. For example, Critical. • PatchState: A patch state. For example, InstancesWithFailedPatches. • 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' Request Syntax { "ComplianceType": "string", "ExecutionSummary": { PutComplianceItems API Version 2014-11-06 623 AWS Systems Manager API Reference "ExecutionId": "string", "ExecutionTime": number, "ExecutionType": "string" }, "ItemContentHash": "string", "Items": [ { "Details": { "string" : "string" }, "Id": "string", "Severity": "string", "Status": "string", "Title": "string" } ], "ResourceId": "string", "ResourceType": "string", "UploadType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ComplianceType Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\-]\w+|Custom:[a-zA-Z0-9_\-]\w+ Required: Yes Request Parameters API Version 2014-11-06 624 AWS Systems Manager ExecutionSummary API Reference A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z' Type: ComplianceExecutionSummary object Required: Yes ItemContentHash MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored. Type: String Length Constraints: Maximum length of 256. Required: No Items Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, and so on. Type: Array of ComplianceItemEntry objects Array Members: Minimum number of 0 items. Maximum number of 10000 items. Required: Yes ResourceId Specify an ID for this resource. For a managed node, this is the node ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes ResourceType Specify the type of resource. ManagedInstance is currently the only supported resource type. Request Parameters API Version 2014-11-06 625 AWS Systems Manager Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 50. Required: Yes UploadType The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request. In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode. Note This attribute is only valid for association compliance. Type: String Valid Values: COMPLETE | PARTIAL Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ComplianceTypeCountLimitExceededException You specified too many custom
|
systems-manager-api-117
|
systems-manager-api.pdf
| 117 |
a full list of compliance items each time you send the request. In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode. Note This attribute is only valid for association compliance. Type: String Valid Values: COMPLETE | PARTIAL Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ComplianceTypeCountLimitExceededException You specified too many custom compliance types. You can specify a maximum of 10 different types. HTTP Status Code: 400 Response Elements API Version 2014-11-06 626 API Reference AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidItemContentException One or more content items isn't valid. HTTP Status Code: 400 InvalidResourceId The resource ID isn't valid. Verify that you entered the correct ID and try again. HTTP Status Code: 400 InvalidResourceType 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. HTTP Status Code: 400 ItemSizeLimitExceededException The inventory item size has exceeded the size limit. HTTP Status Code: 400 TotalSizeLimitExceededException The size of inventory data has exceeded the total size limit for the resource. HTTP Status Code: 400 Examples Example This example illustrates one usage of PutComplianceItems. Sample Request POST / HTTP/1.1 Examples API Version 2014-11-06 627 AWS Systems Manager API Reference Host: ssm.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.PutComplianceItems Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.2.27 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ ssm.put-compliance-items X-Amz-Date: 20240811T170036Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240811/us-west-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 260 { "ResourceId": "i-02573cafcfEXAMPLE", "ResourceType": "ManagedInstance", "ComplianceType": "Custom:AVCheck", "ExecutionSummary": { "ExecutionTime": 1628697600 }, "Items": [ { "Id": "Version2.0", "Title": "ScanHost", "Severity": "CRITICAL", "Status": "COMPLIANT" } ] } Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2014-11-06 628 AWS Systems Manager • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 629 AWS Systems Manager PutInventory API Reference 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. Request Syntax { "InstanceId": "string", "Items": [ { "CaptureTime": "string", "Content": [ { "string" : "string" } ], "ContentHash": "string", "Context": { "string" : "string" }, "SchemaVersion": "string", "TypeName": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. InstanceId An managed node ID where you want to add or update inventory items. Type: String Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) Required: Yes PutInventory API Version 2014-11-06 630 AWS Systems Manager Items API Reference The inventory items that you want to add or update on managed nodes. Type: Array of InventoryItem objects Array Members: Minimum number of 1 item. Maximum number of 30 items. Required: Yes Response Syntax { "Message": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Message Information about the request. Type: String Errors For information about the errors that are common to all actions, see Common Errors. CustomSchemaCountLimitExceededException You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again. HTTP Status Code: 400 InternalServerError An error occurred on the server side. Response Syntax API Version 2014-11-06 631 AWS Systems Manager HTTP Status Code: 500 InvalidInstanceId API Reference The following problems can cause this exception: • You don't have permission to access the managed node. • AWS 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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidInventoryItemContextException You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again. HTTP Status Code: 400 InvalidItemContentException One or more content items isn't valid. HTTP Status Code: 400 InvalidTypeNameException The parameter type name isn't valid. HTTP Status Code: 400 ItemContentMismatchException The inventory item has invalid content. HTTP Status Code: 400 ItemSizeLimitExceededException The inventory item size has exceeded the size
|
systems-manager-api-118
|
systems-manager-api.pdf
| 118 |
endpoint. Try reinstalling SSM Agent. • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated. HTTP Status Code: 400 InvalidInventoryItemContextException You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again. HTTP Status Code: 400 InvalidItemContentException One or more content items isn't valid. HTTP Status Code: 400 InvalidTypeNameException The parameter type name isn't valid. HTTP Status Code: 400 ItemContentMismatchException The inventory item has invalid content. HTTP Status Code: 400 ItemSizeLimitExceededException The inventory item size has exceeded the size limit. HTTP Status Code: 400 SubTypeCountLimitExceededException The sub-type count exceeded the limit for the inventory type. Errors API Version 2014-11-06 632 AWS Systems Manager API Reference HTTP Status Code: 400 TotalSizeLimitExceededException The size of inventory data has exceeded the total size limit for the resource. HTTP Status Code: 400 UnsupportedInventoryItemContextException The 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. HTTP Status Code: 400 UnsupportedInventorySchemaVersionException Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type. HTTP Status Code: 400 Examples Example This example illustrates one usage of PutInventory. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.PutInventory Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20240401T181858Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240401/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 180 { Examples API Version 2014-11-06 633 AWS Systems Manager API Reference "InstanceId": "i-0cb99161f6EXAMPLE", "Items": [ { "TypeName": "Custom:StageInfo", "SchemaVersion": "1.0", "CaptureTime": "2020-03-31T08:00:00Z", "Content": [ { "Stage": "PreProd" } ] } ] } Sample Response {} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 634 AWS Systems Manager PutParameter Create or update a parameter in Parameter Store. Request Syntax API Reference { "AllowedPattern": "string", "DataType": "string", "Description": "string", "KeyId": "string", "Name": "string", "Overwrite": boolean, "Policies": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Tier": "string", "Type": "string", "Value": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AllowedPattern A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$ Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No PutParameter API Version 2014-11-06 635 AWS Systems Manager DataType API Reference The data type for a String parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs. The following data type values are supported. • text • aws:ec2:image • aws:ssm:integration When you create a String parameter and specify aws:ec2:image, AWS Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. Note If the action is successful, the service sends back an HTTP 200 response which indicates a successful PutParameter call for all cases except for data type aws:ec2:image. If you call PutParameter with aws:ec2:image data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The aws:ec2:image value is validated asynchronously, and the PutParameter call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your aws:ec2:image parameters are created successfully, see Setting up notifications or trigger actions based on Parameter Store events. For more information about AMI format validation , see Native parameter support for Amazon Machine Image IDs. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Required: No Description Information about the parameter that you want to add to the system. Optional but recommended. Request Parameters API Version 2014-11-06 636 AWS Systems Manager API Reference Important Don't enter personally identifiable information in this field. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No KeyId The AWS Key Management Service (AWS KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the SecureString data type. If you don't specify a key ID, the system uses the default key associated
|
systems-manager-api-119
|
systems-manager-api.pdf
| 119 |
Required: No Description Information about the parameter that you want to add to the system. Optional but recommended. Request Parameters API Version 2014-11-06 636 AWS Systems Manager API Reference Important Don't enter personally identifiable information in this field. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No KeyId The AWS Key Management Service (AWS KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account, which is not as secure as using a custom key. • To use a custom AWS KMS key, choose the SecureString data type with the Key ID parameter. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([a-zA-Z0-9:/_-]+)$ Required: No Name The fully qualified name of the parameter that you want to create or update. Note You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13 Request Parameters API Version 2014-11-06 637 AWS Systems Manager Naming Constraints: API Reference • Parameter names are case sensitive. • A parameter name must be unique within an AWS Region • A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive). • Parameter names can include only the following symbols and letters: a-zA-Z0-9_.- In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: /Dev/Production/East/Project-ABC/MyParameter • A parameter name can't include spaces. • Parameter hierarchies are limited to a maximum depth of fifteen levels. For additional information about valid values for parameter names, see Creating Systems Manager parameters in the AWS Systems Manager User Guide. Note The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name that you specify is 1011 characters. This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: arn:aws:ssm:us- east-2:111122223333:parameter/. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Overwrite Overwrite an existing parameter. The default value is false. Type: Boolean Required: No Request Parameters API Version 2014-11-06 638 AWS Systems Manager Policies API Reference One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in AWS Systems Manager supports the following policy types: Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter. ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours. NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed. All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies. Type: String Length Constraints: Minimum length of 1. Maximum length of 4096. Required: No Tags Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs: • Key=Resource,Value=S3bucket • Key=OS,Value=Windows • Key=ParameterType,Value=LicenseKey Request Parameters API Version 2014-11-06 639 AWS Systems Manager Note API Reference To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No Tier The parameter tier to assign to a parameter. Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content
|
systems-manager-api-120
|
systems-manager-api.pdf
| 120 |
type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs: • Key=Resource,Value=S3bucket • Key=OS,Value=Windows • Key=ParameterType,Value=LicenseKey Request Parameters API Version 2014-11-06 639 AWS Systems Manager Note API Reference To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No Tier The parameter tier to assign to a parameter. Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost. Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see Managing parameter tiers in the AWS Systems Manager User Guide. You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters. If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. Using the Default Tier Configuration In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration. Request Parameters API Version 2014-11-06 640 AWS Systems Manager API Reference The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default: • Advanced: With this option, Parameter Store evaluates all requests as advanced parameters. • Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced. If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced- parameter tier. This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary. Options that require an advanced parameter include the following: • The content size of the parameter is more than 4 KB. • The parameter uses a parameter policy. • More than 10,000 parameters already exist in your AWS account in the current AWS Region. For more information about configuring the default tier option, see Specifying a default parameter tier in the AWS Systems Manager User Guide. Type: String Valid Values: Standard | Advanced | Intelligent-Tiering Required: No Type The type of parameter that you want to create. Note SecureString isn't currently supported for AWS CloudFormation templates. Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type. Request Parameters API Version 2014-11-06 641 AWS Systems Manager API Reference Important Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter. Type: String Valid Values: String | StringList | SecureString Required: No Value The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB. Note Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets {{}} or {{ssm:parameter-name}} in a parameter value. Type: String Required: Yes Response Syntax { "Tier": "string", "Version": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2014-11-06 642 AWS Systems Manager Tier The tier assigned to the parameter. Type: String API Reference Valid Values: Standard | Advanced | Intelligent-Tiering Version The new version number
|
systems-manager-api-121
|
systems-manager-api.pdf
| 121 |
8 KB. Note Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets {{}} or {{ssm:parameter-name}} in a parameter value. Type: String Required: Yes Response Syntax { "Tier": "string", "Version": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2014-11-06 642 AWS Systems Manager Tier The tier assigned to the parameter. Type: String API Reference Valid Values: Standard | Advanced | Intelligent-Tiering Version The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API operations or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called. Type: Long Errors For information about the errors that are common to all actions, see Common Errors. HierarchyLevelLimitExceededException A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the AWS Systems Manager User Guide. HTTP Status Code: 400 HierarchyTypeMismatchException Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter. HTTP Status Code: 400 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. HTTP Status Code: 400 Errors API Version 2014-11-06 643 AWS Systems Manager InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidAllowedPatternException The request doesn't meet the regular expression requirement. API Reference HTTP Status Code: 400 InvalidKeyId The query key ID isn't valid. HTTP Status Code: 400 InvalidPolicyAttributeException A policy attribute or its value is invalid. HTTP Status Code: 400 InvalidPolicyTypeException The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification. HTTP Status Code: 400 ParameterAlreadyExists The parameter already exists. You can't create duplicate parameters. HTTP Status Code: 400 ParameterLimitExceeded You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try again. HTTP Status Code: 400 ParameterMaxVersionLimitExceeded 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 Errors API Version 2014-11-06 644 AWS Systems Manager API Reference 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 AWS Systems Manager User Guide. HTTP Status Code: 400 ParameterPatternMismatchException The parameter name isn't valid. HTTP Status Code: 400 PoliciesLimitExceededException You specified more than the maximum number of allowed policies for the parameter. The maximum is 10. HTTP Status Code: 400 TooManyUpdates There are concurrent updates for a resource that supports one update at a time. HTTP Status Code: 400 UnsupportedParameterType The parameter type isn't supported. HTTP Status Code: 400 Errors API Version 2014-11-06 645 API Reference AWS Systems Manager Examples Example This example illustrates one usage of PutParameter. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 136 X-Amz-Target: AmazonSSM.PutParameter X-Amz-Date: 20240316T000626Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Overwrite": true, "Type": "String", "Name": "EC2TestServerType", "Value": "t2.large", "Description": "Instance type for Test servers" } Sample Response { "Version": 2 } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Examples API Version 2014-11-06 646 API Reference AWS Systems Manager • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python •
|
systems-manager-api-122
|
systems-manager-api.pdf
| 122 |
"Overwrite": true, "Type": "String", "Name": "EC2TestServerType", "Value": "t2.large", "Description": "Instance type for Test servers" } Sample Response { "Version": 2 } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Examples API Version 2014-11-06 646 API Reference AWS Systems Manager • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 647 AWS Systems Manager PutResourcePolicy API Reference Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an AWS account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies. • OpsItemGroup - The resource policy for OpsItemGroup enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). • Parameter - The resource policy is used to share a parameter with other accounts using AWS Resource Access Manager (AWS RAM). To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter. To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through AWS Key Management Service. AWS managed keys cannot be shared. Parameters encrypted with the default AWS managed key can be updated to use a customer managed key instead. For AWS KMS key definitions, see AWS KMS concepts in the AWS Key Management Service Developer Guide. Important While you can share a parameter using the Systems Manager PutResourcePolicy operation, we recommend using AWS Resource Access Manager (AWS RAM) instead. This is because using PutResourcePolicy requires the extra step of promoting the parameter to a standard AWS RAM Resource Share using the AWS RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the --shared option. For more information, see Sharing a parameter in the AWS Systems Manager User Guide Request Syntax { "Policy": "string", PutResourcePolicy API Version 2014-11-06 648 AWS Systems Manager API Reference "PolicyHash": "string", "PolicyId": "string", "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Policy A policy you want to associate with a resource. Type: String Pattern: ^(?!\s*$).+ Required: Yes PolicyHash ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy. Type: String Required: No PolicyId The policy ID. Type: String Required: No ResourceArn Amazon Resource Name (ARN) of the resource to which you want to attach a policy. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Request Parameters API Version 2014-11-06 649 API Reference AWS Systems Manager Required: Yes Response Syntax { "PolicyHash": "string", "PolicyId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. PolicyHash ID of the current policy version. Type: String PolicyId The policy ID. To update a policy, you must specify PolicyId and PolicyHash. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An error occurred on the server side. HTTP Status Code: 500 MalformedResourcePolicyDocumentException The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made. Response Syntax API Version 2014-11-06 650 AWS Systems Manager HTTP Status Code: 400 ResourceNotFoundException The specified parameter to be shared could not be found. HTTP Status Code: 400 ResourcePolicyConflictException API Reference 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. HTTP Status Code: 400 ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again. HTTP Status Code: 400 ResourcePolicyLimitExceededException The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to OpsItemGroup. Verify these limits and try again. HTTP Status Code: 400 ResourcePolicyNotFoundException No policies with the specified policy ID and hash could be found. HTTP Status Code: 400 See Also For more information about using this API in one of the
|
systems-manager-api-123
|
systems-manager-api.pdf
| 123 |
update a policy are sent. HTTP Status Code: 400 ResourcePolicyInvalidParameterException One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again. HTTP Status Code: 400 ResourcePolicyLimitExceededException The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to OpsItemGroup. Verify these limits and try again. HTTP Status Code: 400 ResourcePolicyNotFoundException No policies with the specified policy ID and hash could be found. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2014-11-06 651 API Reference AWS Systems Manager • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 652 AWS Systems Manager API Reference RegisterDefaultPatchBaseline Defines the default patch baseline for the relevant operating system. To reset the AWS-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 arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed. Request Syntax { "BaselineId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BaselineId The ID of the patch baseline that should be the default patch baseline. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Required: Yes Response Syntax { "BaselineId": "string" } RegisterDefaultPatchBaseline API Version 2014-11-06 653 AWS Systems Manager Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BaselineId The ID of the default patch baseline. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Errors For information about the errors that are common to all actions, see Common Errors. 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidResourceId The resource ID isn't valid. Verify that you entered the correct ID and try again. HTTP Status Code: 400 Response Elements API Version 2014-11-06 654 AWS Systems Manager Examples Example API Reference This example illustrates one usage of RegisterDefaultPatchBaseline. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 38 X-Amz-Target: AmazonSSM.RegisterDefaultPatchBaseline X-Amz-Date: 20240309T025821Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "BaselineId": "pb-0c10e65780EXAMPLE" } Sample Response { "BaselineId": "pb-0c10e65780EXAMPLE" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Examples API Version 2014-11-06 655 AWS Systems Manager • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 656 AWS Systems Manager API Reference RegisterPatchBaselineForPatchGroup Registers a patch baseline for a patch group. Request Syntax { "BaselineId": "string", "PatchGroup": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BaselineId The ID of the patch baseline to register with the patch group. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ Required: Yes PatchGroup The name of the patch group to be registered with the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes RegisterPatchBaselineForPatchGroup API Version 2014-11-06 657 API Reference AWS Systems Manager Response Syntax { "BaselineId": "string", "PatchGroup": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BaselineId The ID of the patch baseline the patch group was registered with. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ PatchGroup The name of the patch group registered with the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Errors For information about the errors
|
systems-manager-api-124
|
systems-manager-api.pdf
| 124 |
2014-11-06 657 API Reference AWS Systems Manager Response Syntax { "BaselineId": "string", "PatchGroup": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BaselineId The ID of the patch baseline the patch group was registered with. Type: String Length Constraints: Minimum length of 20. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ PatchGroup The name of the patch group registered with the patch baseline. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Errors For information about the errors that are common to all actions, see Common Errors. AlreadyExistsException Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline. Response Syntax API Version 2014-11-06 658 AWS Systems Manager HTTP Status Code: 400 DoesNotExistException API Reference 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidResourceId The resource ID isn't valid. Verify that you entered the correct ID and try again. HTTP Status Code: 400 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. HTTP Status Code: 400 Examples Example This example illustrates one usage of RegisterPatchBaselineForPatchGroup. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Examples API Version 2014-11-06 659 AWS Systems Manager Accept-Encoding: identity Content-Length: 74 X-Amz-Target: AmazonSSM.RegisterPatchBaselineForPatchGroup X-Amz-Date: 20240309T060234Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "PatchGroup": "mypatchgroup", "BaselineId": "pb-0c10e65780EXAMPLE" } Sample Response { "PatchGroup": "mypatchgroup", "BaselineId": "pb-0c10e65780EXAMPLE" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2014-11-06 660 AWS Systems Manager API Reference RegisterTargetWithMaintenanceWindow Registers a target with a maintenance window. Request Syntax { "ClientToken": "string", "Description": "string", "Name": "string", "OwnerInformation": "string", "ResourceType": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ClientToken User-provided idempotency token. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Description An optional description for the target. Type: String RegisterTargetWithMaintenanceWindow API Version 2014-11-06 661 AWS Systems Manager API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Name An optional name for the target. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No OwnerInformation User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ResourceType The type of target being registered with the maintenance window. Type: String Valid Values: INSTANCE | RESOURCE_GROUP Required: Yes Targets The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs. Note If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple Request Parameters API Version 2014-11-06 662 AWS Systems Manager API Reference targets at the same time, register a task for each target individually and assign each task the same priority level. You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes. Example 1: Specify managed node IDs Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3> Example 2: Use tag key-pairs applied to managed nodes Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2> Example 3: Use tag-keys applied to managed nodes Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2> Example 4: Use resource group names Key=resource-groups:Name,Values=<resource-group-name> Example 5: Use filters for resource group types Key=resource-groups:ResourceTypeFilters,Values=<resource- type-1>,<resource-type-2> Note For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format Key=resource- groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide. Type:
|
systems-manager-api-125
|
systems-manager-api.pdf
| 125 |
node IDs, resource group names, or tags that have been applied to managed nodes. Example 1: Specify managed node IDs Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3> Example 2: Use tag key-pairs applied to managed nodes Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2> Example 3: Use tag-keys applied to managed nodes Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2> Example 4: Use resource group names Key=resource-groups:Name,Values=<resource-group-name> Example 5: Use filters for resource group types Key=resource-groups:ResourceTypeFilters,Values=<resource- type-1>,<resource-type-2> Note For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format Key=resource- groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide. Type: Array of Target objects Request Parameters API Version 2014-11-06 663 AWS Systems Manager API Reference Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: Yes WindowId The ID of the maintenance window the target should be registered with. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Required: Yes Response Syntax { "WindowTargetId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WindowTargetId The ID of the target definition in this maintenance window. Type: String Length Constraints: Fixed length of 36. Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\- [0-9a-fA-F]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2014-11-06 664 AWS Systems Manager DoesNotExistException API Reference 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 AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference. HTTP Status Code: 400 IdempotentParameterMismatch 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. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 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. HTTP Status Code: 400 Examples Example This example illustrates one usage of RegisterTargetWithMaintenanceWindow. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Examples API Version 2014-11-06 665 AWS Systems Manager API Reference X-Amz-Target: AmazonSSM.RegisterTargetWithMaintenanceWindow Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240225T003144Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240225/us-east-2/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target,Signature=39c3b3042cd2aEXAMPLE Content-Length: 191 { "WindowId": "mw-0c50858d01EXAMPLE", "ResourceType": "INSTANCE", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-07782c72faEXAMPLE" ] } ], "ClientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE" } Sample Response { "WindowTargetId": "7f4813bb-df25-4e59-b34f-c9e83EXAMPLE" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2014-11-06 666 AWS Systems Manager • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 667 AWS Systems Manager API Reference RegisterTaskWithMaintenanceWindow Adds a new task to a maintenance window. Request Syntax { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "ClientToken": "string", "CutoffBehavior": "string", "Description": "string", "LoggingInfo": { "S3BucketName": "string", "S3KeyPrefix": "string", "S3Region": "string" }, "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "Priority": number, "ServiceRoleArn": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TaskArn": "string", "TaskInvocationParameters": { "Automation": { "DocumentVersion": "string", "Parameters": { "string" : [ "string" ] } }, "Lambda": { RegisterTaskWithMaintenanceWindow API Version 2014-11-06 668 AWS Systems Manager API Reference "ClientContext": "string", "Payload": blob, "Qualifier": "string" }, "RunCommand": { "CloudWatchOutputConfig": { "CloudWatchLogGroupName": "string", "CloudWatchOutputEnabled": boolean }, "Comment": "string", "DocumentHash": "string", "DocumentHashType": "string", "DocumentVersion": "string", "NotificationConfig": { "NotificationArn": "string", "NotificationEvents": [ "string" ], "NotificationType": "string" }, "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "Parameters": { "string" : [ "string" ] }, "ServiceRoleArn": "string", "TimeoutSeconds": number }, "StepFunctions": { "Input": "string", "Name": "string" } }, "TaskParameters": { "string" : { "Values": [ "string" ] } }, "TaskType": "string", "WindowId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. Request Parameters API Version 2014-11-06 669 AWS Systems Manager API Reference The request accepts the following data in JSON format. AlarmConfiguration The CloudWatch alarm you want to apply to your maintenance window task. Type: AlarmConfiguration object Required: No ClientToken User-provided idempotency token. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No CutoffBehavior Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. • CONTINUE_TASK: When the cutoff time is reached, any
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.