Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
sync-dg-169	sync-dg.pdf	169	Parameters. The request accepts the following data in JSON format. DiscoveryJobArn Speciﬁes the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system. Type: String Length Constraints: Maximum length of 256. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}- [a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: Yes EndTime Speciﬁes a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with StartTime. DescribeStorageSystemResourceMetrics 624 User Guide AWS DataSync Type: Timestamp Required: No MaxResults Speciﬁes how many results that you want in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken Speciﬁes an opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Required: No ResourceId Speciﬁes the universally unique identiﬁer (UUID) of the storage system resource that you want information about. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes ResourceType Speciﬁes the kind of storage system resource that you want information about. Type: String Valid Values: SVM \| VOLUME \| CLUSTER DescribeStorageSystemResourceMetrics 625 AWS DataSync Required: Yes StartTime User Guide Speciﬁes a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with EndTime. Type: Timestamp Required: No Response Syntax { "Metrics": [ { "Capacity": { "ClusterCloudStorageUsed": number, "LogicalUsed": number, "Provisioned": number, "Used": number }, "P95Metrics": { "IOPS": { "Other": number, "Read": number, "Total": number, "Write": number }, "Latency": { "Other": number, "Read": number, "Write": number }, "Throughput": { "Other": number, "Read": number, "Total": number, "Write": number } }, "ResourceId": "string", "ResourceType": "string", DescribeStorageSystemResourceMetrics 626 AWS DataSync User Guide "Timestamp": 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. Metrics The details that your discovery job collected about your storage system resource. Type: Array of ResourceMetrics objects NextToken The opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Errors For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 DescribeStorageSystemResourceMetrics 627 AWS DataSync Examples Sample Request User Guide The following example requests information about a volume in an on-premises storage system. { "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system- abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6", "ResourceType": "VOLUME", "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } Sample Response The following example response includes performance and capacity information about the volume. { "Metrics": [ { "Timestamp": "2023-01-10T13:54:11-05:00", "P95Metrics": { "IOPS": { "Read": 251.0, "Write": 44.0, "Other": 17.0, "Total": 345.0 }, "Throughput": { "Read": 2.06, "Write": 0.88, "Other": 0.11, "Total": 2.17 }, "Latency": { "Read": 0.06, "Write": 0.07, "Other": 0.13 } }, "Capacity": { "Used": 409600, "Provisioned": 1099511627776 DescribeStorageSystemResourceMetrics 628 AWS DataSync }, "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "ResourceType": "VOLUME" User Guide } ] } See Also For more information about using this API in one of the language-speciﬁc 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 DescribeStorageSystemResourceMetrics 629 AWS DataSync User Guide DescribeStorageSystemResources Returns information that DataSync Discovery collects about resources in your on-premises storage system. Request Syntax { "DiscoveryJobArn": "string", "Filter": { "string" : [ "string" ] }, "MaxResults": number, "NextToken": "string", "ResourceIds": [ "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. DiscoveryJobArn Speciﬁes the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system. Type: String Length Constraints: Maximum length of 256. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}- [a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: Yes DescribeStorageSystemResources 630 AWS DataSync Filter User Guide Filters the storage system resources that you want returned. For example, this might be volumes associated with a speciﬁc storage virtual machine (SVM). Type: String to array of strings map Valid Keys: SVM Length Constraints: Maximum length of 1024. Pattern: ^.{0,1024}$ Required: No MaxResults Speciﬁes the maximum number of storage system resources that you want to list in a response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken Speciﬁes an opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535.
sync-dg-170	sync-dg.pdf	170	the storage system resources that you want returned. For example, this might be volumes associated with a speciﬁc storage virtual machine (SVM). Type: String to array of strings map Valid Keys: SVM Length Constraints: Maximum length of 1024. Pattern: ^.{0,1024}$ Required: No MaxResults Speciﬁes the maximum number of storage system resources that you want to list in a response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken Speciﬁes an opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Required: No ResourceIds Speciﬁes the universally unique identiﬁers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the Filter parameter. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. DescribeStorageSystemResources 631 AWS DataSync User Guide Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: No ResourceType Speciﬁes what kind of storage system resources that you want information about. Type: String Valid Values: SVM \| VOLUME \| CLUSTER Required: Yes Response Syntax { "NextToken": "string", "ResourceDetails": { "NetAppONTAPClusters": [ { "CifsShareCount": number, "ClusterBlockStorageLogicalUsed": number, "ClusterBlockStorageSize": number, "ClusterBlockStorageUsed": number, "ClusterCloudStorageUsed": number, "ClusterName": "string", "LunCount": number, "MaxP95Performance": { "IopsOther": number, "IopsRead": number, "IopsTotal": number, "IopsWrite": number, "LatencyOther": number, "LatencyRead": number, "LatencyWrite": number, "ThroughputOther": number, "ThroughputRead": number, "ThroughputTotal": number, "ThroughputWrite": number }, "NfsExportedVolumes": number, "Recommendations": [ { DescribeStorageSystemResources 632 AWS DataSync User Guide "EstimatedMonthlyStorageCost": "string", "StorageConfiguration": { "string" : "string" }, "StorageType": "string" } ], "RecommendationStatus": "string", "ResourceId": "string" } ], "NetAppONTAPSVMs": [ { "CifsShareCount": number, "ClusterUuid": "string", "EnabledProtocols": [ "string" ], "LunCount": number, "MaxP95Performance": { "IopsOther": number, "IopsRead": number, "IopsTotal": number, "IopsWrite": number, "LatencyOther": number, "LatencyRead": number, "LatencyWrite": number, "ThroughputOther": number, "ThroughputRead": number, "ThroughputTotal": number, "ThroughputWrite": number }, "NfsExportedVolumes": number, "Recommendations": [ { "EstimatedMonthlyStorageCost": "string", "StorageConfiguration": { "string" : "string" }, "StorageType": "string" } ], "RecommendationStatus": "string", "ResourceId": "string", "SvmName": "string", "TotalCapacityProvisioned": number, DescribeStorageSystemResources 633 AWS DataSync User Guide "TotalCapacityUsed": number, "TotalLogicalCapacityUsed": number, "TotalSnapshotCapacityUsed": number } ], "NetAppONTAPVolumes": [ { "CapacityProvisioned": number, "CapacityUsed": number, "CifsShareCount": number, "LogicalCapacityUsed": number, "LunCount": number, "MaxP95Performance": { "IopsOther": number, "IopsRead": number, "IopsTotal": number, "IopsWrite": number, "LatencyOther": number, "LatencyRead": number, "LatencyWrite": number, "ThroughputOther": number, "ThroughputRead": number, "ThroughputTotal": number, "ThroughputWrite": number }, "NfsExported": boolean, "Recommendations": [ { "EstimatedMonthlyStorageCost": "string", "StorageConfiguration": { "string" : "string" }, "StorageType": "string" } ], "RecommendationStatus": "string", "ResourceId": "string", "SecurityStyle": "string", "SnapshotCapacityUsed": number, "SvmName": "string", "SvmUuid": "string", "VolumeName": "string" } ] DescribeStorageSystemResources 634 AWS DataSync } } Response Elements User Guide 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 opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ ResourceDetails The information collected about your storage system's resources. A response can also include AWS storage service recommendations. For more information, see storage resource information collected by and recommendations provided by DataSync Discovery. Type: ResourceDetails object Errors For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 DescribeStorageSystemResources 635 AWS DataSync Examples Sample Request User Guide The following example requests information about volumes in an on-premises storage system. { "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system- abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6", "ResourceType": "VOLUME" } Sample Response The following example response includes information about volumes in the on-premises storage system, including recommendations about where to transfer the volume data to in AWS (such as Amazon FSx for NetApp ONTAP or Amazon EFS). { "ResourceDetails": { "NetAppONTAPVolumes": [ { "VolumeName": "vol1", "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CifsShareCount": 0, "SecurityStyle": "unix", "SvmUuid": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "SvmName": "my-svm", "CapacityUsed": 409600, "CapacityProvisioned": 1099511627776, "LogicalCapacityUsed": 409600, "NfsExported": true, "SnapshotCapacityUsed": 573440, "MaxP95Performance": { "IopsRead": 251.0, "IopsWrite": 44.0, "IopsOther": 17.0, "IopsTotal": 345.0, "ThroughputRead": 2.06, "ThroughputWrite": 0.88, "ThroughputOther": 0.11, "ThroughputTotal": 2.17, "LatencyRead": 0.06, DescribeStorageSystemResources 636 AWS DataSync User Guide "LatencyWrite": 0.07, "LatencyOther": 0.13 }, "Recommendations": [ { "StorageType": "fsxOntap", "StorageConfiguration": { "StorageCapacityGB": "1024", "ProvisionedIOpsMode": "AUTOMATIC", "CapacityPoolGB": "0", "TotalIOps": "0", "DeploymentType": "Multi-AZ", "ThroughputCapacity": "128" }, "EstimatedMonthlyStorageCost": "410.0" }, { "StorageType": "efs", "StorageConfiguration": { "InfrequentAccessStorageGB": "1", "StandardStorageGB": "1", "InfrequentAccessRequests": "0", "ProvisionedThroughputMBps": "0", "PerformanceMode": "General Purpose", "ThroughputMode": "Bursting" }, "EstimatedMonthlyStorageCost": "1.0" } ], "RecommendationStatus": "COMPLETED" }, { "VolumeName": "root_vol", "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "CifsShareCount": 0, "SecurityStyle": "unix", "SvmUuid": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "SvmName": "my-svm", "CapacityUsed": 462848, "CapacityProvisioned": 1073741824, "LogicalCapacityUsed": 462848, "NfsExported": true, "SnapshotCapacityUsed": 421888, "MaxP95Performance": { DescribeStorageSystemResources 637 AWS DataSync User Guide "IopsRead": 261.0, "IopsWrite": 53.0, "IopsOther": 23.0, "IopsTotal": 360.0, "ThroughputRead": 10.0, "ThroughputWrite": 2.0, "ThroughputOther": 4.0, "ThroughputTotal": 12.0, "LatencyRead": 0.25, "LatencyWrite": 0.3, "LatencyOther": 0.55 }, "Recommendations": [ { "StorageType": "fsxOntap", "StorageConfiguration": { "StorageCapacityGB": "1024", "ProvisionedIOpsMode": "AUTOMATIC", "CapacityPoolGB": "0", "TotalIOps": "0", "DeploymentType": "Multi-AZ", "ThroughputCapacity":
sync-dg-171	sync-dg.pdf	171	"410.0" }, { "StorageType": "efs", "StorageConfiguration": { "InfrequentAccessStorageGB": "1", "StandardStorageGB": "1", "InfrequentAccessRequests": "0", "ProvisionedThroughputMBps": "0", "PerformanceMode": "General Purpose", "ThroughputMode": "Bursting" }, "EstimatedMonthlyStorageCost": "1.0" } ], "RecommendationStatus": "COMPLETED" }, { "VolumeName": "root_vol", "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "CifsShareCount": 0, "SecurityStyle": "unix", "SvmUuid": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "SvmName": "my-svm", "CapacityUsed": 462848, "CapacityProvisioned": 1073741824, "LogicalCapacityUsed": 462848, "NfsExported": true, "SnapshotCapacityUsed": 421888, "MaxP95Performance": { DescribeStorageSystemResources 637 AWS DataSync User Guide "IopsRead": 261.0, "IopsWrite": 53.0, "IopsOther": 23.0, "IopsTotal": 360.0, "ThroughputRead": 10.0, "ThroughputWrite": 2.0, "ThroughputOther": 4.0, "ThroughputTotal": 12.0, "LatencyRead": 0.25, "LatencyWrite": 0.3, "LatencyOther": 0.55 }, "Recommendations": [ { "StorageType": "fsxOntap", "StorageConfiguration": { "StorageCapacityGB": "1024", "ProvisionedIOpsMode": "AUTOMATIC", "CapacityPoolGB": "0", "TotalIOps": "0", "DeploymentType": "Multi-AZ", "ThroughputCapacity": "128" }, "EstimatedMonthlyStorageCost": "410.0" }, { "StorageType": "efs", "StorageConfiguration": { "InfrequentAccessStorageGB": "1", "StandardStorageGB": "1", "InfrequentAccessRequests": "0", "ProvisionedThroughputMBps": "0", "PerformanceMode": "General Purpose", "ThroughputMode": "Bursting" }, "EstimatedMonthlyStorageCost": "1.0" } ], "RecommendationStatus": "COMPLETED" } ] } } DescribeStorageSystemResources 638 AWS DataSync See Also User Guide For more information about using this API in one of the language-speciﬁc 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 DescribeStorageSystemResources 639 AWS DataSync DescribeTask User Guide Provides information about a task, which deﬁnes where and how AWS DataSync transfers your data. Request Syntax { "TaskArn": "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. TaskArn Speciﬁes the Amazon Resource Name (ARN) of the transfer task that you want information about. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]:[0-9]{12}:task/task-[0-9a-f]{17}$ Required: Yes Response Syntax { "CloudWatchLogGroupArn": "string", "CreationTime": number, "CurrentTaskExecutionArn": "string", "DestinationLocationArn": "string", "DestinationNetworkInterfaceArns": [ "string" ], "ErrorCode": "string", "ErrorDetail": "string", "Excludes": [ DescribeTask 640 AWS DataSync User Guide { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } }, "Name": "string", "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "Schedule": { "ScheduleExpression": "string", "Status": "string" DescribeTask 641 User Guide AWS DataSync }, "ScheduleDetails": { "DisabledBy": "string", "DisabledReason": "string", "StatusUpdateTime": number }, "SourceLocationArn": "string", "SourceNetworkInterfaceArns": [ "string" ], "Status": "string", "TaskArn": "string", "TaskMode": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "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. DescribeTask 642 AWS DataSync CloudWatchLogGroupArn User Guide The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task. For more information, see Monitoring data transfers with CloudWatch Logs. Type: String Length Constraints: Maximum length of 562. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):logs:[a-z\-0-9]+: [0-9]{12}:log-group:([^:\])(:\)?$ CreationTime The time that the task was created. Type: Timestamp CurrentTaskExecutionArn The ARN of the most recent task execution. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$ DestinationLocationArn The ARN of your transfer's destination location. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ DestinationNetworkInterfaceArns The ARNs of the network interfaces that DataSync created for your destination location. DescribeTask 643 AWS DataSync Type: Array of strings Length Constraints: Maximum length of 128. User Guide Pattern: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]:[0-9]{12}:network-interface/ eni-[0-9a-f]+$ ErrorCode If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers. Type: String ErrorDetail If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers. Type: String Excludes The exclude ﬁlters that deﬁne the ﬁles, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using ﬁlters. Type: Array of FilterRule objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Includes The include ﬁlters that deﬁne the ﬁles, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using ﬁlters. Type: Array of FilterRule objects Array Members: Minimum number of 0 items. Maximum number of 1 item. ManifestConﬁg The conﬁguration of the manifest that lists the ﬁles
sync-dg-172	sync-dg.pdf	172	source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using ﬁlters. Type: Array of FilterRule objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Includes The include ﬁlters that deﬁne the ﬁles, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using ﬁlters. Type: Array of FilterRule objects Array Members: Minimum number of 0 items. Maximum number of 1 item. ManifestConﬁg The conﬁguration of the manifest that lists the ﬁles or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest. DescribeTask 644 AWS DataSync Type: ManifestConﬁg object Name The name of your task. Type: String User Guide Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ Options The task's settings. For example, what ﬁle metadata gets preserved, how data integrity gets veriﬁed at the end of your transfer, bandwidth limits, among other options. Type: Options object Schedule The schedule for when you want your task to run. For more information, see Scheduling your task. Type: TaskSchedule object ScheduleDetails The details about your task schedule. Type: TaskScheduleDetails object SourceLocationArn The ARN of your transfer's source location. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ SourceNetworkInterfaceArns The ARNs of the network interfaces that DataSync created for your source location. DescribeTask 645 AWS DataSync Type: Array of strings Length Constraints: Maximum length of 128. User Guide Pattern: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]:[0-9]{12}:network-interface/ eni-[0-9a-f]+$ Status The status of your task. For information about what each status means, see Task statuses. Type: String Valid Values: AVAILABLE \| CREATING \| QUEUED \| RUNNING \| UNAVAILABLE TaskArn The ARN of your task. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]:[0-9]{12}:task/task-[0-9a-f]{17}$ TaskMode The task mode that you're using. For more information, see Choosing a task mode for your data transfer. Type: String Valid Values: BASIC \| ENHANCED TaskReportConﬁg The conﬁguration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports. Type: TaskReportConﬁg object Errors For information about the errors that are common to all actions, see Common Errors. DescribeTask 646 AWS DataSync InternalException User Guide This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 Examples Sample Request The following example speciﬁes the ARN of a DataSync task to get information about. { "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" } Sample Response The following example shows a DescribeTask response. { "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026", "Name": "MyTask", "TaskMode": "BASIC", "Status": "RUNNING", "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/ loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/ loc-0000zzzz1111yyyy2", "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/ task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f", "CreationTime": 1532660733.39, "Options": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", DescribeTask 647 AWS DataSync User Guide "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group- name:" } See Also For more information about using this API in one of the language-speciﬁc 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 DescribeTask 648 AWS DataSync DescribeTaskExecution User Guide Provides information about an execution of your AWS DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer. Note Some DescribeTaskExecution response elements are only relevant to a speciﬁc task mode. For information, see Understanding task mode diﬀerences and Understanding data transfer performance counters. Request Syntax { "TaskExecutionArn": "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. TaskExecutionArn Speciﬁes the Amazon Resource Name (ARN) of the task execution that you want information about. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$ Required: Yes Response Syntax { DescribeTaskExecution 649 AWS DataSync User Guide "BytesCompressed": number, "BytesTransferred": number, "BytesWritten": number, "EstimatedBytesToTransfer": number, "EstimatedFilesToDelete": number, "EstimatedFilesToTransfer": number, "Excludes": [ { "FilterType": "string", "Value": "string" } ], "FilesDeleted": number, "FilesFailed": { "Delete": number, "Prepare": number, "Transfer": number, "Verify": number }, "FilesListed": { "AtDestinationForDelete": number, "AtSource": number }, "FilesPrepared": number, "FilesSkipped": number, "FilesTransferred": number, "FilesVerified": number, "Includes": [ { "FilterType": "string", "Value": "string" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } DescribeTaskExecution 650 User Guide AWS DataSync }, "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string",
sync-dg-173	sync-dg.pdf	173	{ DescribeTaskExecution 649 AWS DataSync User Guide "BytesCompressed": number, "BytesTransferred": number, "BytesWritten": number, "EstimatedBytesToTransfer": number, "EstimatedFilesToDelete": number, "EstimatedFilesToTransfer": number, "Excludes": [ { "FilterType": "string", "Value": "string" } ], "FilesDeleted": number, "FilesFailed": { "Delete": number, "Prepare": number, "Transfer": number, "Verify": number }, "FilesListed": { "AtDestinationForDelete": number, "AtSource": number }, "FilesPrepared": number, "FilesSkipped": number, "FilesTransferred": number, "FilesVerified": number, "Includes": [ { "FilterType": "string", "Value": "string" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } DescribeTaskExecution 650 User Guide AWS DataSync }, "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "ReportResult": { "ErrorCode": "string", "ErrorDetail": "string", "Status": "string" }, "Result": { "ErrorCode": "string", "ErrorDetail": "string", "PrepareDuration": number, "PrepareStatus": "string", "TotalDuration": number, "TransferDuration": number, "TransferStatus": "string", "VerifyDuration": number, "VerifyStatus": "string" }, "StartTime": number, "Status": "string", "TaskExecutionArn": "string", "TaskMode": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" DescribeTaskExecution 651 User Guide AWS DataSync } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "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. BytesCompressed The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible. Type: Long BytesTransferred The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed. Type: Long DescribeTaskExecution 652 AWS DataSync BytesWritten User Guide The number of logical bytes that DataSync actually writes to the destination location. Type: Long EstimatedBytesToTransfer The number of logical bytes that DataSync expects to write to the destination location. Type: Long EstimatedFilesToDelete The number of ﬁles, objects, and directories that DataSync expects to delete in your destination location. If you don't conﬁgure your task to delete data in the destination that isn't in the source, the value is always 0. Type: Long EstimatedFilesToTransfer The number of ﬁles, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer. How this gets calculated depends primarily on your task’s transfer mode conﬁguration: • If TranserMode is set to CHANGED - The calculation is based on comparing the content of the source and destination locations and determining the diﬀerence that needs to be transferred. The diﬀerence can include: • Anything that's added or modiﬁed at the source location. • Anything that's in both locations and modiﬁed at the destination after an initial transfer (unless OverwriteMode is set to NEVER). • (Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to REMOVE). • If TranserMode is set to ALL - The calculation is based only on the items that DataSync ﬁnds at the source location. Type: Long Excludes A list of ﬁlter rules that exclude speciﬁc data during your transfer. For more information and examples, see Filtering data transferred by DataSync. DescribeTaskExecution 653 AWS DataSync User Guide Type: Array of FilterRule objects Array Members: Minimum number of 0 items. Maximum number of 1 item. FilesDeleted The number of ﬁles, objects, and directories that DataSync actually deletes in your destination location. If you don't conﬁgure your task to delete data in the destination that isn't in the source, the value is always 0. Type: Long FilesFailed The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution. Note Applies only to Enhanced mode tasks. Type: TaskExecutionFilesFailedDetail object FilesListed The number of objects that DataSync ﬁnds at your locations. Note Applies only to Enhanced mode tasks. Type: TaskExecutionFilesListedDetail object FilesPrepared The number of objects that DataSync will attempt to transfer after comparing your source and destination locations. Note Applies only to Enhanced mode tasks. DescribeTaskExecution 654 AWS DataSync User Guide This counter isn't applicable if you conﬁgure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing diﬀerences between the locations. Type: Long FilesSkipped The number of ﬁles, objects, and directories that DataSync skips during your transfer. Type: Long FilesTransferred The number of ﬁles, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network. If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value
sync-dg-174	sync-dg.pdf	174	applicable if you conﬁgure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing diﬀerences between the locations. Type: Long FilesSkipped The number of ﬁles, objects, and directories that DataSync skips during your transfer. Type: Long FilesTransferred The number of ﬁles, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network. If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-speciﬁc for some location types, so don't use it as an exact indication of what's transferring or to monitor your task execution. Type: Long FilesVeriﬁed The number of ﬁles, objects, and directories that DataSync veriﬁes during your transfer. Note When you conﬁgure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or ﬁles that fail to transfer. Type: Long Includes A list of ﬁlter rules that include speciﬁc data during your transfer. For more information and examples, see Filtering data transferred by DataSync. Type: Array of FilterRule objects DescribeTaskExecution 655 AWS DataSync User Guide Array Members: Minimum number of 0 items. Maximum number of 1 item. ManifestConﬁg The conﬁguration of the manifest that lists the ﬁles or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest. Type: ManifestConﬁg object Options Indicates how your transfer task is conﬁgured. These options include how DataSync handles ﬁles, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options. Each option has a default value. Unless you need to, you don't have to conﬁgure any option before calling StartTaskExecution. You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution. Type: Options object ReportResult Indicates whether DataSync generated a complete task report for your transfer. Type: ReportResult object Result The result of the task execution. Type: TaskExecutionResultDetail object StartTime The time when the task execution started. Type: Timestamp Status The status of the task execution. For detailed information about task execution statuses, see Task execution statuses. Type: String DescribeTaskExecution 656 AWS DataSync User Guide Valid Values: QUEUED \| CANCELLING \| LAUNCHING \| PREPARING \| TRANSFERRING \| VERIFYING \| SUCCESS \| ERROR TaskExecutionArn The ARN of the task execution that you wanted information about. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed. For example, a TaskExecution value with the ARN arn:aws:datasync:us- east-1:111222333444:task/task-0208075f79cedf4a2/execution/ exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us- east-1:111222333444:task/task-0208075f79cedf4a2. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$ TaskMode The task mode that you're using. For more information, see Choosing a task mode for your data transfer. Type: String Valid Values: BASIC \| ENHANCED TaskReportConﬁg The conﬁguration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report. Type: TaskReportConﬁg object Errors For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 DescribeTaskExecution 657 AWS DataSync InvalidRequestException User Guide This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 Examples Sample Request This example illustrates a DescribeTaskExecution request. { "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task- aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1" } Sample Response 1 for an Enhanced mode task execution The following example describes a DataSync task execution that uses Enhanced mode. The execution is also transferring speciﬁc data by using exclude and include ﬁlters. { "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task- aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "Status": "SUCCESS", "Options": { "VerifyMode": "ONLY_FILES_TRANSFERRED", "OverwriteMode": "ALWAYS", "Atime": "BEST_EFFORT", "Mtime": "PRESERVE", "Uid": "NONE", "Gid": "NONE", "PreserveDeletedFiles": "PRESERVE", "PreserveDevices": "NONE", "PosixPermissions": "NONE", "BytesPerSecond": -1, "TaskQueueing": "ENABLED", "LogLevel": "BASIC", "TransferMode": "CHANGED", "SecurityDescriptorCopyFlags": "NONE", "ObjectTags": "PRESERVE" }, DescribeTaskExecution 658 User Guide AWS DataSync "Excludes": [{ "FilterType": "SIMPLE_PATTERN", "Value": "/archive-files" }], "Includes": [{ "FilterType": "SIMPLE_PATTERN", "Value": "/files" }], "StartTime": "2024-10-16T11:19:56.844000-04:00", "EstimatedFilesToTransfer": 7, "EstimatedBytesToTransfer": 30, "FilesTransferred": 7, "BytesWritten": 30, "BytesTransferred": 30, "BytesCompressed": 30, "Result": { "PrepareDuration": 0, "PrepareStatus": "SUCCESS", "TotalDuration": 3310, "TransferDuration": 0, "TransferStatus": "SUCCESS", "VerifyDuration": 0, "VerifyStatus": "SUCCESS" }, "FilesDeleted": 0, "FilesSkipped": 0, "FilesVerified": 7, "EstimatedFilesToDelete": 0, "TaskMode": "ENHANCED", "FilesPrepared": 7, "FilesListed": { "AtSource": 7, "AtDestinationForDelete": 0 }, "FilesFailed": { "Prepare": 0, "Transfer": 0, "Verify": 0, "Delete": 0 } } DescribeTaskExecution 659 AWS DataSync User Guide Sample Response 2 for an Enhanced mode task execution The following example describes another DataSync task execution that uses Enhanced mode. In this situation, the execution is transferring speciﬁc data by using a manifest instead of ﬁlters. { "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task- aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "Status": "SUCCESS", "Options": { "VerifyMode":
sync-dg-175	sync-dg.pdf	175	"Result": { "PrepareDuration": 0, "PrepareStatus": "SUCCESS", "TotalDuration": 3310, "TransferDuration": 0, "TransferStatus": "SUCCESS", "VerifyDuration": 0, "VerifyStatus": "SUCCESS" }, "FilesDeleted": 0, "FilesSkipped": 0, "FilesVerified": 7, "EstimatedFilesToDelete": 0, "TaskMode": "ENHANCED", "FilesPrepared": 7, "FilesListed": { "AtSource": 7, "AtDestinationForDelete": 0 }, "FilesFailed": { "Prepare": 0, "Transfer": 0, "Verify": 0, "Delete": 0 } } DescribeTaskExecution 659 AWS DataSync User Guide Sample Response 2 for an Enhanced mode task execution The following example describes another DataSync task execution that uses Enhanced mode. In this situation, the execution is transferring speciﬁc data by using a manifest instead of ﬁlters. { "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task- aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "Status": "SUCCESS", "Options": { "VerifyMode": "ONLY_FILES_TRANSFERRED", "OverwriteMode": "ALWAYS", "Atime": "BEST_EFFORT", "Mtime": "PRESERVE", "Uid": "NONE", "Gid": "NONE", "PreserveDeletedFiles": "PRESERVE", "PreserveDevices": "NONE", "PosixPermissions": "NONE", "BytesPerSecond": -1, "TaskQueueing": "ENABLED", "LogLevel": "TRANSFER", "TransferMode": "CHANGED", "SecurityDescriptorCopyFlags": "NONE", "ObjectTags": "PRESERVE" }, "Excludes": [], "Includes": [], "ManifestConfig": { "Action": "TRANSFER", "Format": "CSV", "S3AccessRoleArn": "arn:aws:iam::111222333444:role/service-role/ DataSyncS3ManifestAccess", "S3Bucket": "arn:aws:s3:::manifests-datasync", "VersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG", "Source": { "S3": { "ManifestObjectPath": "manifest-folder/manifest-versioned-files", "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-manifest- role/DataSyncS3ManifestAccess", "S3BucketArn": "arn:aws:s3:::manifests-datasync", "ManifestObjectVersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG" } } DescribeTaskExecution 660 AWS DataSync }, "StartTime": "2024-10-16T09:29:56.757000-04:00", "EstimatedFilesToTransfer": 1, "EstimatedBytesToTransfer": 6, User Guide "FilesTransferred": 1, "BytesWritten": 6, "BytesTransferred": 6, "BytesCompressed": 6, "Result": { "PrepareDuration": 0, "PrepareStatus": "SUCCESS", "TotalDuration": 3089, "TransferDuration": 0, "TransferStatus": "SUCCESS", "VerifyDuration": 0, "VerifyStatus": "SUCCESS" }, "TaskReportConfig": { "Destination": { "S3": { "Subdirectory": "reports/", "S3BucketArn": "arn:aws:s3:::my-task-report", "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-task-report- role/DataSyncTaskReportS3BucketAccess" } }, "OutputType": "STANDARD", "ReportLevel": "SUCCESSES_AND_ERRORS", "ObjectVersionIds": "INCLUDE" }, "FilesDeleted": 0, "FilesSkipped": 0, "FilesVerified": 1, "ReportResult": { "Status": "SUCCESS" }, "EstimatedFilesToDelete": 0, "TaskMode": "ENHANCED", "FilesPrepared": 1, "FilesListed": { "AtSource": 1, "AtDestinationForDelete": 0 }, "FilesFailed": { DescribeTaskExecution 661 AWS DataSync "Prepare": 0, "Transfer": 0, "Verify": 0, "Delete": 0 } } Sample Response for a Basic mode task execution The following example describes a DataSync task execution that uses Basic mode. { "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task- aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "BytesCompressed": 3500, "BytesTransferred": 5000, "BytesWritten": 5000, "EstimatedBytesToTransfer": 5000, "EstimatedFilesToDelete": 10, "EstimatedFilesToTransfer": 100, "FilesDeleted": 10, "FilesSkipped": 0, "FilesTransferred": 100, "FilesVerified": 100, "Result": { "PrepareDuration": 100, "PrepareStatus": "SUCCESS", "TransferDuration": 60, "TransferStatus": "SUCCESS", "VerifyDuration": 30, "VerifyStatus": "SUCCESS" }, "StartTime": "2024-10-16T11:19:56.844000-04:00", "Status": "SUCCESS", "OverrideOptions": { "Atime": "BEST_EFFORT", "BytesPerSecond": "1000", "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, DescribeTaskExecution User Guide 662 AWS DataSync "TaskReportConfig": { "Destination": { "S3": { User Guide "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-datasync- role", "S3BucketArn": "arn:aws:s3:::my-task-reports-bucket/*", "Subdirectory": "reports" } }, "ObjectVersionIds": "INCLUDE", "OutputType": "STANDARD", "Overrides": { "Deleted": { "ReportLevel": "ERRORS_ONLY" }, "Skipped": { "ReportLevel": "SUCCESSES_AND_ERRORS" }, "Transferred": { "ReportLevel": "ERRORS_ONLY" }, "Verified": { "ReportLevel": "ERRORS_ONLY" } }, "ReportLevel": "ERRORS_ONLY" } } See Also For more information about using this API in one of the language-speciﬁc 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 DescribeTaskExecution 663 AWS DataSync • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 User Guide DescribeTaskExecution 664 AWS DataSync User Guide GenerateRecommendations Creates recommendations about where to migrate your data to in AWS. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery. Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation. Request Syntax { "DiscoveryJobArn": "string", "ResourceIds": [ "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. DiscoveryJobArn Speciﬁes the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system. Type: String Length Constraints: Maximum length of 256. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}- [a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: Yes ResourceIds Speciﬁes the universally unique identiﬁers (UUIDs) of the resources in your storage system that you want recommendations on. GenerateRecommendations 665 AWS DataSync Type: Array of strings User Guide Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes ResourceType Speciﬁes the type of resource in your storage system that you want recommendations on. Type: String Valid Values: SVM \| VOLUME \| CLUSTER 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 Examples Sample Request The following example generates AWS storage recommendations for a volume in an on-premises storage system. GenerateRecommendations 666 AWS DataSync User Guide { "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system- abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6", "ResourceIds": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ], "ResourceType": "VOLUME" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS
sync-dg-176	sync-dg.pdf	176	errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 Examples Sample Request The following example generates AWS storage recommendations for a volume in an on-premises storage system. GenerateRecommendations 666 AWS DataSync User Guide { "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system- abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6", "ResourceIds": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ], "ResourceType": "VOLUME" } See Also For more information about using this API in one of the language-speciﬁc 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 GenerateRecommendations 667 AWS DataSync ListAgents User Guide Returns a list of AWS DataSync agents that belong to an AWS account in the AWS Region speciﬁed in the request. With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents. ListAgents is eventually consistent. This means the result of running the operation might not reﬂect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always conﬁrm whether an agent has been created (or deleted) by using DescribeAgent. Request Syntax { "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. MaxResults Speciﬁes the maximum number of DataSync agents to list in a response. By default, a response shows a maximum of 100 agents. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No NextToken Speciﬁes an opaque string that indicates the position to begin the next list of results in the response. ListAgents 668 AWS DataSync Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ User Guide Required: No Response Syntax { "Agents": [ { "AgentArn": "string", "Name": "string", "Platform": { "Version": "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. Agents A list of DataSync agents in your AWS account in the AWS Region speciﬁed in the request. The list is ordered by the agents' Amazon Resource Names (ARNs). Type: Array of AgentListEntry objects NextToken The opaque string that indicates the position to begin the next list of results in the response. Type: String ListAgents 669 AWS DataSync User Guide Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Errors For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 ListAgents 670 AWS DataSync ListDiscoveryJobs User Guide Provides a list of the existing discovery jobs in the AWS Region and AWS account where you're using DataSync Discovery. Request Syntax { "MaxResults": number, "NextToken": "string", "StorageSystemArn": "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 Speciﬁes how many results you want in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken Speciﬁes an opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Required: No ListDiscoveryJobs 671 AWS DataSync StorageSystemArn User Guide Speciﬁes the Amazon Resource Name (ARN) of an on-premises storage system. Use this parameter if you only want to list the discovery jobs that are associated with a speciﬁc storage system. Type: String Length Constraints: Maximum length of
sync-dg-177	sync-dg.pdf	177	MaxResults Speciﬁes how many results you want in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken Speciﬁes an opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Required: No ListDiscoveryJobs 671 AWS DataSync StorageSystemArn User Guide Speciﬁes the Amazon Resource Name (ARN) of an on-premises storage system. Use this parameter if you only want to list the discovery jobs that are associated with a speciﬁc storage system. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: No Response Syntax { "DiscoveryJobs": [ { "DiscoveryJobArn": "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. DiscoveryJobs The discovery jobs that you've run. Type: Array of DiscoveryJobListEntry objects NextToken The opaque string that indicates the position to begin the next list of results in the response. ListDiscoveryJobs 672 AWS DataSync Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Errors User Guide For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 ListDiscoveryJobs 673 AWS DataSync ListLocations Returns a list of source and destination locations. User Guide If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations. Request Syntax { "Filters": [ { "Name": "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 You can use API ﬁlters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a speciﬁc source location, you can use ListLocations with ﬁlter name LocationType S3 and Operator Equals. Type: Array of LocationFilter objects Required: No MaxResults The maximum number of locations to return. Type: Integer ListLocations 674 AWS DataSync User Guide Valid Range: Minimum value of 0. Maximum value of 100. Required: No NextToken An opaque string that indicates the position at which to begin the next list of locations. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Required: No Response Syntax { "Locations": [ { "LocationArn": "string", "LocationUri": "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. Locations An array that contains a list of locations. Type: Array of LocationListEntry objects NextToken An opaque string that indicates the position at which to begin returning the next list of locations. ListLocations 675 AWS DataSync Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Errors User Guide For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 ListLocations 676 AWS DataSync ListStorageSystems User Guide Lists the on-premises storage systems that you're using with DataSync Discovery. Request Syntax { "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. MaxResults Speciﬁes how many results you want in the response. Type: Integer Valid
sync-dg-178	sync-dg.pdf	178	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 ListLocations 676 AWS DataSync ListStorageSystems User Guide Lists the on-premises storage systems that you're using with DataSync Discovery. Request Syntax { "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. MaxResults Speciﬁes how many results you want in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken Speciﬁes an opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Required: No Response Syntax { ListStorageSystems 677 AWS DataSync User Guide "NextToken": "string", "StorageSystems": [ { "Name": "string", "StorageSystemArn": "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 opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ StorageSystems The Amazon Resource Names ARNs) of the on-premises storage systems that you're using with DataSync Discovery. Type: Array of StorageSystemListEntry objects Errors For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. ListStorageSystems 678 AWS DataSync HTTP Status Code: 400 See Also User Guide For more information about using this API in one of the language-speciﬁc 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 ListStorageSystems 679 AWS DataSync ListTagsForResource Returns all the tags associated with an AWS resource. User Guide 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 Speciﬁes how many results that you want in the response. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No NextToken Speciﬁes an opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Required: No ResourceArn Speciﬁes the Amazon Resource Name (ARN) of the resource that you want tag information on. ListTagsForResource 680 AWS DataSync Type: String Length Constraints: Maximum length of 128. User Guide Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:(agent\|task\|location\|system)/((agent\|task\|loc)-[a- f0-9]{17}\|storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{12})(/execution/exec-[a-f0-9]{17})?$ Required: Yes Response Syntax { "NextToken": "string", "Tags": [ { "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. NextToken The opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Tags An array of tags applied to the speciﬁed resource. ListTagsForResource 681 AWS DataSync User Guide Type: Array of TagListEntry objects Array Members: Minimum number of 0 items. Maximum number of 55 items. Errors For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 ListTagsForResource 682 AWS DataSync ListTaskExecutions Returns a list of executions for an AWS DataSync transfer task. User Guide Request Syntax { "MaxResults": number, "NextToken": "string", "TaskArn": "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 Speciﬁes how many results you want in the response.
sync-dg-179	sync-dg.pdf	179	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 ListTagsForResource 682 AWS DataSync ListTaskExecutions Returns a list of executions for an AWS DataSync transfer task. User Guide Request Syntax { "MaxResults": number, "NextToken": "string", "TaskArn": "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 Speciﬁes how many results you want in the response. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No NextToken Speciﬁes an opaque string that indicates the position at which to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Required: No TaskArn Speciﬁes the Amazon Resource Name (ARN) of the task that you want execution information about. ListTaskExecutions 683 AWS DataSync Type: String Length Constraints: Maximum length of 128. User Guide Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$ Required: No Response Syntax { "NextToken": "string", "TaskExecutions": [ { "Status": "string", "TaskExecutionArn": "string", "TaskMode": "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 opaque string that indicates the position to begin the next list of results in the response. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ TaskExecutions A list of the task's executions. Type: Array of TaskExecutionListEntry objects ListTaskExecutions 684 AWS DataSync Errors User Guide For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 ListTaskExecutions 685 AWS DataSync ListTasks Returns a list of the AWS DataSync tasks you created. User Guide Request Syntax { "Filters": [ { "Name": "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 You can use API ﬁlters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a speciﬁc source location, you can use ListTasks with ﬁlter name LocationId and Operator Equals with the ARN for the location. Type: Array of TaskFilter objects Required: No MaxResults The maximum number of tasks to return. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListTasks 686 AWS DataSync NextToken User Guide An opaque string that indicates the position at which to begin the next list of tasks. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ Required: No Response Syntax { "NextToken": "string", "Tasks": [ { "Name": "string", "Status": "string", "TaskArn": "string", "TaskMode": "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 An opaque string that indicates the position at which to begin returning the next list of tasks. Type: String Length Constraints: Maximum length of 65535. Pattern: [a-zA-Z0-9=_-]+ ListTasks 687 AWS DataSync Tasks A list of all the tasks that are returned. Type: Array of TaskListEntry objects Errors User Guide For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 ListTasks 688 AWS DataSync RemoveStorageSystem User Guide Permanently removes a storage system resource from DataSync Discovery, including the
sync-dg-180	sync-dg.pdf	180	submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 ListTasks 688 AWS DataSync RemoveStorageSystem User Guide Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations. Request Syntax { "StorageSystemArn": "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. StorageSystemArn Speciﬁes the Amazon Resource Name (ARN) of the storage system that you want to permanently remove from DataSync Discovery. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{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. RemoveStorageSystem 689 AWS DataSync InternalException User Guide This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 RemoveStorageSystem 690 AWS DataSync StartDiscoveryJob User Guide Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this ﬁrst by using the AddStorageSystem operation. Request Syntax { "ClientToken": "string", "CollectionDurationMinutes": number, "StorageSystemArn": "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. ClientToken Speciﬁes a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes CollectionDurationMinutes Speciﬁes in minutes how long you want the discovery job to run. StartDiscoveryJob 691 AWS DataSync Note User Guide For more accurate recommendations, we recommend a duration of at least 14 days. Longer durations allow time to collect a suﬃcient number of data points and provide a realistic representation of storage performance and utilization. Type: Integer Valid Range: Minimum value of 60. Maximum value of 44640. Required: Yes StorageSystemArn Speciﬁes the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: Yes Tags Speciﬁes labels that help you categorize, ﬁlter, and search for your AWS resources. Type: Array of TagListEntry objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No Response Syntax { "DiscoveryJobArn": "string" StartDiscoveryJob 692 User Guide AWS DataSync } 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. DiscoveryJobArn The ARN of the discovery job that you started. Type: String Length Constraints: Maximum length of 256. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}- [a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: StartDiscoveryJob 693 User Guide AWS DataSync • 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 StartDiscoveryJob 694 AWS DataSync StartTaskExecution User Guide Starts an AWS DataSync transfer task. For each task, you can only run one task execution at a time. There are several steps to a task execution. For more information, see
sync-dg-181	sync-dg.pdf	181	following: StartDiscoveryJob 693 User Guide AWS DataSync • 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 StartDiscoveryJob 694 AWS DataSync StartTaskExecution User Guide Starts an AWS DataSync transfer task. For each task, you can only run one task execution at a time. There are several steps to a task execution. For more information, see Task execution statuses. Important If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can aﬀect your S3 request charges and the DataSync pricing page before you begin. Request Syntax { "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } }, "OverrideOptions": { "Atime": "string", "BytesPerSecond": number, StartTaskExecution 695 AWS DataSync User Guide "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "TaskArn": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } StartTaskExecution 696 AWS DataSync }, "ReportLevel": "string" } } Request Parameters User Guide For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Excludes Speciﬁes a list of ﬁlter rules that determines which ﬁles to exclude from a task. The list contains a single ﬁlter string that consists of the patterns to exclude. The patterns are delimited by "\|" (that is, a pipe), for example, "/folder1\|/folder2". Type: Array of FilterRule objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No Includes Speciﬁes a list of ﬁlter rules that determines which ﬁles to include when running a task. The pattern should contain a single ﬁlter string that consists of the patterns to include. The patterns are delimited by "\|" (that is, a pipe), for example, "/folder1\|/folder2". Type: Array of FilterRule objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No ManifestConﬁg Conﬁgures a manifest, which is a list of ﬁles or objects that you want DataSync to transfer. For more information and conﬁguration examples, see Specifying what DataSync transfers by using a manifest. When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission. StartTaskExecution 697 AWS DataSync User Guide To remove a manifest conﬁguration, specify this parameter with an empty value. Type: ManifestConﬁg object Required: No OverrideOptions Indicates how your transfer task is conﬁgured. These options include how DataSync handles ﬁles, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options. Each option has a default value. Unless you need to, you don't have to conﬁgure any option before calling StartTaskExecution. You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution. Type: Options object Required: No Tags Speciﬁes the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution. Tags are key-value pairs that help you manage, ﬁlter, and search for your DataSync resources. Type: Array of TagListEntry objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No TaskArn Speciﬁes the Amazon Resource Name (ARN) of the task that you want to start. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$ StartTaskExecution 698 AWS DataSync Required: Yes TaskReportConﬁg User Guide Speciﬁes how you want to conﬁgure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports. When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission. To remove a task report conﬁguration, specify this parameter as empty. Type: TaskReportConﬁg object Required: No Response Syntax { "TaskExecutionArn": "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. TaskExecutionArn The ARN of the running task execution. Type: String Length Constraints:
sync-dg-182	sync-dg.pdf	182	about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports. When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission. To remove a task report conﬁguration, specify this parameter as empty. Type: TaskReportConﬁg object Required: No Response Syntax { "TaskExecutionArn": "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. TaskExecutionArn The ARN of the running task execution. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$ StartTaskExecution 699 AWS DataSync Errors User Guide For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 Examples Sample Request The following example starts a task execution using the default options for the speciﬁed task. { "OverrideOptions": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" } Sample Response This example illustrates one usage of StartTaskExecution. { StartTaskExecution 700 AWS DataSync User Guide "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/ task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f" } See Also For more information about using this API in one of the language-speciﬁc 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 StartTaskExecution 701 AWS DataSync StopDiscoveryJob Stops a running DataSync discovery job. User Guide You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation. Request Syntax { "DiscoveryJobArn": "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. DiscoveryJobArn Speciﬁes the Amazon Resource Name (ARN) of the discovery job that you want to stop. Type: String Length Constraints: Maximum length of 256. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}- [a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{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. StopDiscoveryJob 702 AWS DataSync InternalException User Guide This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 StopDiscoveryJob 703 AWS DataSync TagResource User Guide Applies a tag to an AWS resource. Tags are key-value pairs that can help you manage, ﬁlter, and search for your resources. These include AWS DataSync resources, such as locations, tasks, and task executions. Request Syntax { "ResourceArn": "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. ResourceArn Speciﬁes the Amazon Resource Name (ARN) of the resource to apply the tag to. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:(agent\|task\|location\|system)/((agent\|task\|loc)-[a- f0-9]{17}\|storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{12})(/execution/exec-[a-f0-9]{17})?$ Required: Yes Tags Speciﬁes the tags that you want to apply to the resource. TagResource 704 AWS DataSync User Guide Type: Array of TagListEntry objects Array Members: Minimum number of 0 items. Maximum number of 50 items. 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:
sync-dg-183	sync-dg.pdf	183	Minimum number of 0 items. Maximum number of 50 items. 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 TagResource 705 AWS DataSync • AWS SDK for Python • AWS SDK for Ruby V3 User Guide TagResource 706 User Guide AWS DataSync UntagResource Removes tags from an AWS resource. Request Syntax { "Keys": [ "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. Keys Speciﬁes the keys in the tags that you want to remove. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:/-]+$ Required: Yes ResourceArn Speciﬁes the Amazon Resource Name (ARN) of the resource to remove the tags from. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:(agent\|task\|location\|system)/((agent\|task\|loc)-[a- f0-9]{17}\|storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{12})(/execution/exec-[a-f0-9]{17})?$ UntagResource 707 AWS DataSync Required: Yes Response Elements User Guide 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UntagResource 708 User Guide AWS DataSync UpdateAgent Updates the name of an AWS DataSync agent. Request Syntax { "AgentArn": "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. AgentArn The Amazon Resource Name (ARN) of the agent to update. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ Required: Yes Name The name that you want to use to conﬁgure the agent. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ Required: No UpdateAgent 709 AWS DataSync Response Elements User Guide 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateAgent 710 User Guide AWS DataSync UpdateDiscoveryJob Edits a DataSync discovery job conﬁguration. Request Syntax { "CollectionDurationMinutes": number, "DiscoveryJobArn": "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. CollectionDurationMinutes Speciﬁes in minutes how long that you want the discovery job to run. (You can't set this parameter to less than the number of minutes that the job has already run for.) Type: Integer Valid Range: Minimum value of 60. Maximum value of 44640. Required: Yes DiscoveryJobArn Speciﬁes the Amazon Resource Name (ARN) of the discovery job that you want to update. Type: String Length Constraints: Maximum length of 256. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-
sync-dg-184	sync-dg.pdf	184	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. CollectionDurationMinutes Speciﬁes in minutes how long that you want the discovery job to run. (You can't set this parameter to less than the number of minutes that the job has already run for.) Type: Integer Valid Range: Minimum value of 60. Maximum value of 44640. Required: Yes DiscoveryJobArn Speciﬁes the Amazon Resource Name (ARN) of the discovery job that you want to update. Type: String Length Constraints: Maximum length of 256. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}- [a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: Yes UpdateDiscoveryJob 711 AWS DataSync Response Elements User Guide 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateDiscoveryJob 712 AWS DataSync User Guide UpdateLocationAzureBlob Modiﬁes the following conﬁgurations of the Microsoft Azure Blob Storage transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with Azure Blob Storage. Request Syntax { "AccessTier": "string", "AgentArns": [ "string" ], "AuthenticationType": "string", "BlobType": "string", "LocationArn": "string", "SasConfiguration": { "Token": "string" }, "Subdirectory": "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. AccessTier Speciﬁes the access tier that you want your objects or ﬁles transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers. Type: String Valid Values: HOT \| COOL \| ARCHIVE Required: No AgentArns Speciﬁes the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. UpdateLocationAzureBlob 713 AWS DataSync User Guide You can specify more than one agent. For more information, see Using multiple agents for your transfer. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ Required: No AuthenticationType Speciﬁes the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS). Type: String Valid Values: SAS Required: No BlobType Speciﬁes the type of blob that you want your objects or ﬁles to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation. Type: String Valid Values: BLOCK Required: No LocationArn Speciﬁes the ARN of the Azure Blob Storage transfer location that you're updating. Type: String Length Constraints: Maximum length of 128. UpdateLocationAzureBlob 714 AWS DataSync User Guide Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes SasConﬁguration Speciﬁes the SAS conﬁguration that allows DataSync to access your Azure Blob Storage. Type: AzureBlobSasConﬁguration object Required: No Subdirectory Speciﬁes path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images). Type: String Length Constraints: Maximum length of 1024. Pattern: ^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 UpdateLocationAzureBlob 715 AWS DataSync See Also User Guide For more information about using this API in one of the language-speciﬁc 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 UpdateLocationAzureBlob 716 AWS DataSync UpdateLocationEfs User Guide Modiﬁes the following conﬁguration parameters of the Amazon EFS transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with Amazon
sync-dg-185	sync-dg.pdf	185	this API in one of the language-speciﬁc 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 UpdateLocationAzureBlob 716 AWS DataSync UpdateLocationEfs User Guide Modiﬁes the following conﬁguration parameters of the Amazon EFS transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with Amazon EFS. Request Syntax { "AccessPointArn": "string", "FileSystemAccessRoleArn": "string", "InTransitEncryption": "string", "LocationArn": "string", "Subdirectory": "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. AccessPointArn Speciﬁes the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS ﬁle system. For more information, see Accessing restricted Amazon EFS ﬁle systems. Type: String Length Constraints: Maximum length of 128. Pattern: (^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):elasticfilesystem: [a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$)\|(^$) Required: No FileSystemAccessRoleArn Speciﬁes an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS ﬁle system. UpdateLocationEfs 717 AWS DataSync User Guide For information on creating this role, see Creating a DataSync IAM role for Amazon EFS ﬁle system access. Type: String Length Constraints: Maximum length of 2048. Pattern: (^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):iam::[0-9] {12}:role/.$)\|(^$) Required: No InTransitEncryption Speciﬁes whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS ﬁle system. If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2. Type: String Valid Values: NONE \| TLS1_2 Required: No LocationArn Speciﬁes the Amazon Resource Name (ARN) of the Amazon EFS transfer location that you're updating. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes Subdirectory Speciﬁes a mount path for your Amazon EFS ﬁle system. This is where DataSync reads or writes data on your ﬁle system (depending on if this is a source or destination location). UpdateLocationEfs 718 AWS DataSync User Guide By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn). You can also include subdirectories using forward slashes (for example, / path/to/folder). Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\p{Zs}]$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 UpdateLocationEfs 719 AWS DataSync • 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 User Guide UpdateLocationEfs 720 AWS DataSync User Guide UpdateLocationFsxLustre Modiﬁes the following conﬁguration parameters of the Amazon FSx for Lustre transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with FSx for Lustre. Request Syntax { "LocationArn": "string", "Subdirectory": "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. LocationArn Speciﬁes the Amazon Resource Name (ARN) of the FSx for Lustre transfer location that you're updating. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes Subdirectory Speciﬁes a mount path for your FSx for Lustre ﬁle system. The path can include subdirectories. When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the ﬁle system's root directory (/). Type: String UpdateLocationFsxLustre 721 AWS DataSync User Guide Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP
sync-dg-186	sync-dg.pdf	186	mount path. If you don't include this parameter, DataSync uses the ﬁle system's root directory (/). Type: String UpdateLocationFsxLustre 721 AWS DataSync User Guide Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateLocationFsxLustre 722 AWS DataSync • AWS SDK for Python • AWS SDK for Ruby V3 User Guide UpdateLocationFsxLustre 723 AWS DataSync User Guide UpdateLocationFsxOntap Modiﬁes the following conﬁguration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with FSx for ONTAP. Request Syntax { "LocationArn": "string", "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "Domain": "string", "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "Subdirectory": "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. LocationArn Speciﬁes the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating. Type: String UpdateLocationFsxOntap 724 AWS DataSync User Guide Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes Protocol Speciﬁes the data transfer protocol that DataSync uses to access your Amazon FSx ﬁle system. Type: FsxUpdateProtocol object Required: No Subdirectory Speciﬁes a path to the ﬁle share in the storage virtual machine (SVM) where you want to transfer data to or from. You can specify a junction path (also known as a mount point), qtree path (for NFS ﬁle shares), or share name (for SMB ﬁle shares). For example, your mount path might be /vol1, /vol1/ tree1, or /share1. Note Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide. Type: String Length Constraints: Maximum length of 255. Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$ Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. UpdateLocationFsxOntap 725 AWS DataSync Errors User Guide For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateLocationFsxOntap 726 AWS DataSync User Guide UpdateLocationFsxOpenZfs Modiﬁes the following conﬁguration parameters of the Amazon FSx for OpenZFS transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with FSx for OpenZFS. Note Request parameters related to SMB aren't supported with the UpdateLocationFsxOpenZfs operation. Request Syntax { "LocationArn": "string", "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "Domain": "string", "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "Subdirectory": "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. UpdateLocationFsxOpenZfs 727 AWS DataSync LocationArn User Guide Speciﬁes the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer location that you're updating. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes Protocol Speciﬁes the data transfer protocol that AWS DataSync uses to access your Amazon FSx ﬁle system. Type: FsxProtocol object Required: No Subdirectory Speciﬁes a subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the ﬁle system is a source or destination location). Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$ Required: No Response
sync-dg-187	sync-dg.pdf	187	User Guide Speciﬁes the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer location that you're updating. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes Protocol Speciﬁes the data transfer protocol that AWS DataSync uses to access your Amazon FSx ﬁle system. Type: FsxProtocol object Required: No Subdirectory Speciﬁes a subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the ﬁle system is a source or destination location). Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$ 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. UpdateLocationFsxOpenZfs 728 AWS DataSync InternalException User Guide This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateLocationFsxOpenZfs 729 AWS DataSync User Guide UpdateLocationFsxWindows Modiﬁes the following conﬁguration parameters of the Amazon FSx for Windows File Server transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with FSx for Windows File Server. Request Syntax { "Domain": "string", "LocationArn": "string", "Password": "string", "Subdirectory": "string", "User": "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. Domain Speciﬁes the name of the Windows domain that your FSx for Windows File Server ﬁle system belongs to. If you have multiple Active Directory domains in your environment, conﬁguring this parameter makes sure that DataSync connects to the right ﬁle system. Type: String Length Constraints: Maximum length of 253. Pattern: ^([A-Za-z0-9]((\.\|-+)?[A-Za-z0-9]){0,252})?$ Required: No LocationArn Speciﬁes the ARN of the FSx for Windows File Server transfer location that you're updating. UpdateLocationFsxWindows 730 AWS DataSync Type: String Length Constraints: Maximum length of 128. User Guide Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes Password Speciﬁes the password of the user with the permissions to mount and access the ﬁles, folders, and ﬁle metadata in your FSx for Windows File Server ﬁle system. Type: String Length Constraints: Maximum length of 104. Pattern: ^.{0,104}$ Required: No Subdirectory Speciﬁes a mount path for your ﬁle system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the ﬁle system is a source or destination location). Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$ Required: No User Speciﬁes the user with the permissions to mount and access the ﬁles, folders, and ﬁle metadata in your FSx for Windows File Server ﬁle system. For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations. Type: String UpdateLocationFsxWindows 731 AWS DataSync User Guide Length Constraints: Maximum length of 104. Pattern: ^[^\x22\x5B\x5D/\\:;\|=,+*?\x3C\x3E]{1,104}$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateLocationFsxWindows 732 AWS DataSync • AWS SDK for Python • AWS SDK for Ruby V3 User Guide UpdateLocationFsxWindows 733 AWS DataSync UpdateLocationHdfs User Guide Modiﬁes the following conﬁguration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with an HDFS cluster. Request Syntax { "AgentArns": [ "string" ], "AuthenticationType": "string", "BlockSize": number, "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "KmsKeyProviderUri": "string", "LocationArn": "string", "NameNodes": [ { "Hostname": "string", "Port": number } ], "QopConfiguration": { "DataTransferProtection": "string", "RpcProtection": "string" }, "ReplicationFactor": number, "SimpleUser": "string",
sync-dg-188	sync-dg.pdf	188	SDK for PHP V3 UpdateLocationFsxWindows 732 AWS DataSync • AWS SDK for Python • AWS SDK for Ruby V3 User Guide UpdateLocationFsxWindows 733 AWS DataSync UpdateLocationHdfs User Guide Modiﬁes the following conﬁguration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with an HDFS cluster. Request Syntax { "AgentArns": [ "string" ], "AuthenticationType": "string", "BlockSize": number, "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "KmsKeyProviderUri": "string", "LocationArn": "string", "NameNodes": [ { "Hostname": "string", "Port": number } ], "QopConfiguration": { "DataTransferProtection": "string", "RpcProtection": "string" }, "ReplicationFactor": number, "SimpleUser": "string", "Subdirectory": "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. AgentArns The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster. UpdateLocationHdfs 734 AWS DataSync Type: Array of strings User Guide Array Members: Minimum number of 1 item. Maximum number of 4 items. Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ Required: No AuthenticationType The type of authentication used to determine the identity of the user. Type: String Valid Values: SIMPLE \| KERBEROS Required: No BlockSize The size of the data blocks to write into the HDFS cluster. Type: Integer Valid Range: Minimum value of 1048576. Maximum value of 1073741824. Required: No KerberosKeytab The Kerberos key table (keytab) that contains mappings between the deﬁned Kerberos principal and the encrypted keys. You can load the keytab from a ﬁle by providing the ﬁle's address. Type: Base64-encoded binary data object Length Constraints: Maximum length of 65536. Required: No KerberosKrb5Conf The krb5.conf ﬁle that contains the Kerberos conﬁguration information. You can load the krb5.conf ﬁle by providing the ﬁle's address. If you're using the AWS CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text. UpdateLocationHdfs 735 AWS DataSync User Guide Type: Base64-encoded binary data object Length Constraints: Maximum length of 131072. Required: No KerberosPrincipal The Kerberos principal with access to the ﬁles and folders on the HDFS cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^.+$ Required: No KmsKeyProviderUri The URI of the HDFS cluster's Key Management Server (KMS). Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^kms:\/\/http[s]?@(([a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za- z0-9\-][A-Za-z0-9])(;(([a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9\-][A- Za-z0-9])):[0-9]{1,5}\/kms$ Required: No LocationArn The Amazon Resource Name (ARN) of the source HDFS cluster location. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes UpdateLocationHdfs 736 AWS DataSync NameNodes User Guide The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming ﬁles and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode. Type: Array of HdfsNameNode objects Array Members: Minimum number of 1 item. Required: No QopConﬁguration The Quality of Protection (QOP) conﬁguration speciﬁes the Remote Procedure Call (RPC) and data transfer privacy settings conﬁgured on the Hadoop Distributed File System (HDFS) cluster. Type: QopConﬁguration object Required: No ReplicationFactor The number of DataNodes to replicate the data to when writing to the HDFS cluster. Type: Integer Valid Range: Minimum value of 1. Maximum value of 512. Required: No SimpleUser The user name used to identify the client on the host operating system. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[_.A-Za-z0-9][-_.A-Za-z0-9]$ Required: No Subdirectory A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. UpdateLocationHdfs 737 AWS DataSync Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$ Required: No Response Elements User Guide 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateLocationHdfs 738 AWS DataSync • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 User Guide UpdateLocationHdfs 739 AWS DataSync UpdateLocationNfs User Guide Modiﬁes the following conﬁguration parameters of the Network File System (NFS) transfer location that you're using with AWS DataSync. For more information, see Conﬁguring transfers with an NFS ﬁle server. Request Syntax { "LocationArn": "string", "MountOptions": { "Version":
sync-dg-189	sync-dg.pdf	189	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 UpdateLocationHdfs 738 AWS DataSync • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 User Guide UpdateLocationHdfs 739 AWS DataSync UpdateLocationNfs User Guide Modiﬁes the following conﬁguration parameters of the Network File System (NFS) transfer location that you're using with AWS DataSync. For more information, see Conﬁguring transfers with an NFS ﬁle server. Request Syntax { "LocationArn": "string", "MountOptions": { "Version": "string" }, "OnPremConfig": { "AgentArns": [ "string" ] }, "ServerHostname": "string", "Subdirectory": "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. LocationArn Speciﬁes the Amazon Resource Name (ARN) of the NFS transfer location that you want to update. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes MountOptions Speciﬁes how DataSync can access a location using the NFS protocol. UpdateLocationNfs 740 AWS DataSync User Guide Type: NfsMountOptions object Required: No OnPremConﬁg The AWS DataSync agents that can connect to your Network File System (NFS) ﬁle server. Type: OnPremConﬁg object Required: No ServerHostname Speciﬁes the DNS name or IP version 4 (IPv4) address of the NFS ﬁle server that your DataSync agent connects to. Type: String Length Constraints: Maximum length of 255. Pattern: ^(([a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9\-][A-Za-z0-9])$ Required: No Subdirectory Speciﬁes the export path in your NFS ﬁle server that you want DataSync to mount. This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on conﬁguring an export for DataSync, see Accessing NFS ﬁle servers. Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\p{Zs}]+$ Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. UpdateLocationNfs 741 AWS DataSync Errors User Guide For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateLocationNfs 742 AWS DataSync User Guide UpdateLocationObjectStorage Modiﬁes the following conﬁguration parameters of the object storage transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with an object storage system. Request Syntax { "AccessKey": "string", "AgentArns": [ "string" ], "LocationArn": "string", "SecretKey": "string", "ServerCertificate": blob, "ServerHostname": "string", "ServerPort": number, "ServerProtocol": "string", "Subdirectory": "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. AccessKey Speciﬁes the access key (for example, a user name) if credentials are required to authenticate with the object storage server. Type: String Length Constraints: Minimum length of 0. Maximum length of 200. Pattern: ^.$ Required: No AgentArns Speciﬁes the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. UpdateLocationObjectStorage 743 AWS DataSync Type: Array of strings User Guide Array Members: Minimum number of 1 item. Maximum number of 4 items. Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ Required: No LocationArn Speciﬁes the ARN of the object storage system location that you're updating. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes SecretKey Speciﬁes the secret key (for example, a password) if credentials are required to authenticate with the object storage server. Type: String Length Constraints: Minimum length of 0. Maximum length of 200. Pattern: ^.*$ Required: No ServerCertiﬁcate Speciﬁes a certiﬁcate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certiﬁcate authority (CA). You must specify a single .pem ﬁle with a full certiﬁcate chain (for example, file:///home/user/.ssh/ object_storage_certificates.pem). The certiﬁcate chain might include: UpdateLocationObjectStorage 744 AWS DataSync User Guide • The object storage system's certiﬁcate • All intermediate certiﬁcates (if there are any) • The root certiﬁcate of the signing CA You can concatenate your certiﬁcates into a .pem ﬁle (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem ﬁle that includes three certiﬁcates: cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem >
sync-dg-190	sync-dg.pdf	190	object storage system if the system uses a private or self-signed certiﬁcate authority (CA). You must specify a single .pem ﬁle with a full certiﬁcate chain (for example, file:///home/user/.ssh/ object_storage_certificates.pem). The certiﬁcate chain might include: UpdateLocationObjectStorage 744 AWS DataSync User Guide • The object storage system's certiﬁcate • All intermediate certiﬁcates (if there are any) • The root certiﬁcate of the signing CA You can concatenate your certiﬁcates into a .pem ﬁle (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem ﬁle that includes three certiﬁcates: cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem To use this parameter, conﬁgure ServerProtocol to HTTPS. Updating this parameter doesn't interfere with tasks that you have in progress. Type: Base64-encoded binary data object Length Constraints: Maximum length of 32768. Required: No ServerHostname Speciﬁes the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to. Type: String Length Constraints: Maximum length of 255. Pattern: ^(([a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9\-][A-Za-z0-9])$ Required: No ServerPort Speciﬁes the port that your object storage server accepts inbound network traﬃc on (for example, port 443). Type: Integer Valid Range: Minimum value of 1. Maximum value of 65536. Required: No UpdateLocationObjectStorage 745 AWS DataSync ServerProtocol User Guide Speciﬁes the protocol that your object storage server uses to communicate. Type: String Valid Values: HTTPS \| HTTP Required: No Subdirectory Speciﬁes the object preﬁx for your object storage server. If this is a source location, DataSync only copies objects with this preﬁx. If this is a destination location, DataSync writes all objects with this preﬁx. Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\p{Zs}]$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 UpdateLocationObjectStorage 746 AWS DataSync See Also User Guide For more information about using this API in one of the language-speciﬁc 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 UpdateLocationObjectStorage 747 AWS DataSync UpdateLocationS3 User Guide Modiﬁes the following conﬁguration parameters of the Amazon S3 transfer location that you're using with AWS DataSync. Important Before you begin, make sure that you read the following topics: • Storage class considerations with Amazon S3 locations • Evaluating S3 request costs when using DataSync Request Syntax { "LocationArn": "string", "S3Config": { "BucketAccessRoleArn": "string" }, "S3StorageClass": "string", "Subdirectory": "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. LocationArn Speciﬁes the Amazon Resource Name (ARN) of the Amazon S3 transfer location that you're updating. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ UpdateLocationS3 748 AWS DataSync Required: Yes S3Conﬁg User Guide Speciﬁes the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket. For more information, see Providing DataSync access to S3 buckets. Type: S3Conﬁg object Required: No S3StorageClass Speciﬁes the storage class that you want your objects to use when Amazon S3 is a transfer destination. For buckets in AWS Regions, the storage class defaults to STANDARD. For buckets on AWS Outposts, the storage class defaults to OUTPOSTS. For more information, see Storage class considerations with Amazon S3 transfers. Type: String Valid Values: STANDARD \| STANDARD_IA \| ONEZONE_IA \| INTELLIGENT_TIERING \| GLACIER \| DEEP_ARCHIVE \| OUTPOSTS \| GLACIER_INSTANT_RETRIEVAL Required: No Subdirectory Speciﬁes a preﬁx in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location). Note DataSync can't transfer objects with a preﬁx that begins with a slash (/) or includes //, /./, or /../ patterns. For example: • /photos • photos//2006/January • photos/./2006/February UpdateLocationS3 749 AWS DataSync User Guide • photos/../2006/March Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\p{Zs}]*$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits
sync-dg-191	sync-dg.pdf	191	a slash (/) or includes //, /./, or /../ patterns. For example: • /photos • photos//2006/January • photos/./2006/February UpdateLocationS3 749 AWS DataSync User Guide • photos/../2006/March Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\p{Zs}]*$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 UpdateLocationS3 750 AWS DataSync • 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 User Guide UpdateLocationS3 751 AWS DataSync UpdateLocationSmb User Guide Modiﬁes the following conﬁguration parameters of the Server Message Block (SMB) transfer location that you're using with AWS DataSync. For more information, see Conﬁguring DataSync transfers with an SMB ﬁle server. Request Syntax { "AgentArns": [ "string" ], "AuthenticationType": "string", "DnsIpAddresses": [ "string" ], "Domain": "string", "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "LocationArn": "string", "MountOptions": { "Version": "string" }, "Password": "string", "ServerHostname": "string", "Subdirectory": "string", "User": "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. AgentArns Speciﬁes the DataSync agent (or agents) that can connect to your SMB ﬁle server. You specify an agent by using its Amazon Resource Name (ARN). Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Length Constraints: Maximum length of 128. UpdateLocationSmb 752 AWS DataSync User Guide Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ Required: No AuthenticationType Speciﬁes the authentication protocol that DataSync uses to connect to your SMB ﬁle server. DataSync supports NTLM (default) and KERBEROS authentication. For more information, see Providing DataSync access to SMB ﬁle servers. Type: String Valid Values: NTLM \| KERBEROS Required: No DnsIpAddresses Speciﬁes the IPv4 addresses for the DNS servers that your SMB ﬁle server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, conﬁguring this parameter makes sure that DataSync connects to the right SMB ﬁle server. Type: Array of strings Array Members: Maximum number of 2 items. Length Constraints: Minimum length of 7. Maximum length of 15. Pattern: \A(25[0-5]\|2[0-4]\d\|[0-1]?\d?\d)(\.(25[0-5]\|2[0-4]\d\|[0-1]?\d?\d)) {3}\z Required: No Domain Speciﬁes the Windows domain name that your SMB ﬁle server belongs to. This parameter applies only if AuthenticationType is set to NTLM. If you have multiple domains in your environment, conﬁguring this parameter makes sure that DataSync connects to the right ﬁle server. UpdateLocationSmb 753 AWS DataSync Type: String User Guide Length Constraints: Maximum length of 253. Pattern: ^[A-Za-z0-9]((\.\|-+)?[A-Za-z0-9]){0,252}$ Required: No KerberosKeytab Speciﬁes your Kerberos key table (keytab) ﬁle, which includes mappings between your Kerberos principal and encryption keys. To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab ﬁle matches exactly what you specify for KerberosPrincipal. Type: Base64-encoded binary data object Length Constraints: Maximum length of 65536. Required: No KerberosKrb5Conf Speciﬁes a Kerberos conﬁguration ﬁle (krb5.conf) that deﬁnes your Kerberos realm conﬁguration. The ﬁle must be base64 encoded. If you're using the AWS CLI, the encoding is done for you. Type: Base64-encoded binary data object Length Constraints: Maximum length of 131072. Required: No KerberosPrincipal Speciﬁes a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the ﬁles, folders, and ﬁle metadata in your SMB ﬁle server. A Kerberos principal might look like HOST/[email protected]. Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab ﬁle. UpdateLocationSmb 754 AWS DataSync Type: String User Guide Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^.+$ Required: No LocationArn Speciﬁes the ARN of the SMB location that you want to update. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes MountOptions Speciﬁes the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB ﬁle server. Type: SmbMountOptions object Required: No Password Speciﬁes the password of the user who can mount your SMB ﬁle server and has permission to access the ﬁles and folders involved in your transfer. This parameter applies only if
sync-dg-192	sync-dg.pdf	192	User Guide Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^.+$ Required: No LocationArn Speciﬁes the ARN of the SMB location that you want to update. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: Yes MountOptions Speciﬁes the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB ﬁle server. Type: SmbMountOptions object Required: No Password Speciﬁes the password of the user who can mount your SMB ﬁle server and has permission to access the ﬁles and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM. Type: String Length Constraints: Maximum length of 104. Pattern: ^.{0,104}$ Required: No UpdateLocationSmb 755 AWS DataSync ServerHostname User Guide Speciﬁes the domain name or IP address of the SMB ﬁle server that your DataSync agent connects to. Remember the following when conﬁguring this parameter: • You can't specify an IP version 6 (IPv6) address. • If you're using Kerberos authentication, you must specify a domain name. Type: String Length Constraints: Maximum length of 255. Pattern: ^(([a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9\-][A-Za-z0-9])$ Required: No Subdirectory Speciﬁes the name of the share exported by your SMB ﬁle server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/ subdirectory). Make sure that other SMB clients in your network can also mount this path. To copy all data in the speciﬁed subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB ﬁle servers. Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$ Required: No User Speciﬁes the user name that can mount your SMB ﬁle server and has permission to access the ﬁles and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM. For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB ﬁle servers. UpdateLocationSmb 756 AWS DataSync Type: String User Guide Length Constraints: Maximum length of 104. Pattern: ^[^\x22\x5B\x5D/\\:;\|=,+?\x3C\x3E]{1,104}$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateLocationSmb 757 AWS DataSync • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 User Guide UpdateLocationSmb 758 AWS DataSync UpdateStorageSystem User Guide Modiﬁes some conﬁgurations of an on-premises storage system resource that you're using with DataSync Discovery. Request Syntax { "AgentArns": [ "string" ], "CloudWatchLogGroupArn": "string", "Credentials": { "Password": "string", "Username": "string" }, "Name": "string", "ServerConfiguration": { "ServerHostname": "string", "ServerPort": number }, "StorageSystemArn": "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. AgentArns Speciﬁes the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads your on-premises storage system. You can only specify one ARN. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ UpdateStorageSystem 759 AWS DataSync Required: No CloudWatchLogGroupArn User Guide Speciﬁes the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events. Type: String Length Constraints: Maximum length of 562. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):logs:[a-z\-0-9]+: [0-9]{12}:log-group:([^:\])(:\*)?$ Required: No Credentials Speciﬁes the user name and password for accessing your on-premises storage system's management interface. Type: Credentials object Required: No Name Speciﬁes a familiar name for your on-premises storage system. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\p{L}\p{M}\p{N}\s+=._:@\/-]+$ Required: No ServerConﬁguration Speciﬁes the server name and network port required to connect with your on-premises storage system's management interface. Type: DiscoveryServerConﬁguration object Required: No UpdateStorageSystem 760 AWS DataSync StorageSystemArn User Guide Speciﬁes the ARN of the on-premises storage system that you want reconﬁgure. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{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. InternalException This exception
sync-dg-193	sync-dg.pdf	193	of 256. Pattern: ^[\p{L}\p{M}\p{N}\s+=._:@\/-]+$ Required: No ServerConﬁguration Speciﬁes the server name and network port required to connect with your on-premises storage system's management interface. Type: DiscoveryServerConﬁguration object Required: No UpdateStorageSystem 760 AWS DataSync StorageSystemArn User Guide Speciﬁes the ARN of the on-premises storage system that you want reconﬁgure. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET UpdateStorageSystem 761 User Guide AWS DataSync • 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 UpdateStorageSystem 762 AWS DataSync UpdateTask User Guide Updates the conﬁguration of a task, which deﬁnes where and how AWS DataSync transfers your data. Request Syntax { "CloudWatchLogGroupArn": "string", "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } }, "Name": "string", "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", UpdateTask 763 AWS DataSync User Guide "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "Schedule": { "ScheduleExpression": "string", "Status": "string" }, "TaskArn": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "string" } } UpdateTask 764 AWS DataSync Request Parameters User Guide For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CloudWatchLogGroupArn Speciﬁes the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task. For Enhanced mode tasks, you must use /aws/datasync as your log group name. For example: arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:* For more information, see Monitoring data transfers with CloudWatch Logs. Type: String Length Constraints: Maximum length of 562. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):logs:[a-z\-0-9]+: [0-9]{12}:log-group:([^:\])(:\*)?$ Required: No Excludes Speciﬁes exclude ﬁlters that deﬁne the ﬁles, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using ﬁlters. Type: Array of FilterRule objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No Includes Speciﬁes include ﬁlters deﬁne the ﬁles, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using ﬁlters. Type: Array of FilterRule objects UpdateTask 765 AWS DataSync User Guide Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No ManifestConﬁg Conﬁgures a manifest, which is a list of ﬁles or objects that you want DataSync to transfer. For more information and conﬁguration examples, see Specifying what DataSync transfers by using a manifest. When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission. To remove a manifest conﬁguration, specify this parameter as empty. Type: ManifestConﬁg object Required: No Name Speciﬁes the name of your task. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ Required: No Options Indicates how your transfer task is conﬁgured. These options include how DataSync handles ﬁles, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options. Each option has a default value. Unless you need to, you don't have to conﬁgure any option before calling StartTaskExecution. You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution. Type: Options object UpdateTask 766 AWS DataSync Required: No Schedule User Guide Speciﬁes a schedule for when you want your task to run. For more information, see Scheduling your task. Type: TaskSchedule object Required: No TaskArn Speciﬁes the ARN of the task that you want to
sync-dg-194	sync-dg.pdf	194	integrity, set bandwidth limits for your task, among other options. Each option has a default value. Unless you need to, you don't have to conﬁgure any option before calling StartTaskExecution. You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution. Type: Options object UpdateTask 766 AWS DataSync Required: No Schedule User Guide Speciﬁes a schedule for when you want your task to run. For more information, see Scheduling your task. Type: TaskSchedule object Required: No TaskArn Speciﬁes the ARN of the task that you want to update. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]:[0-9]{12}:task/task-[0-9a-f]{17}$ Required: Yes TaskReportConﬁg Speciﬁes how you want to conﬁgure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports. When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission. To remove a task report conﬁguration, specify this parameter as empty. Type: TaskReportConﬁg object Required: No Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. UpdateTask 767 AWS DataSync Errors User Guide For information about the errors that are common to all actions, see Common Errors. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 InvalidRequestException This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 UpdateTask 768 AWS DataSync UpdateTaskExecution User Guide Updates the conﬁguration of a running AWS DataSync task execution. Note Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution. Request Syntax { "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "TaskExecutionArn": "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. UpdateTaskExecution 769 AWS DataSync Options User Guide Indicates how your transfer task is conﬁgured. These options include how DataSync handles ﬁles, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options. Each option has a default value. Unless you need to, you don't have to conﬁgure any option before calling StartTaskExecution. You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution. Type: Options object Required: Yes TaskExecutionArn Speciﬁes the Amazon Resource Name (ARN) of the task execution that you're updating. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$ 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. InternalException This exception is thrown when an error occurs in the AWS DataSync service. HTTP Status Code: 500 UpdateTaskExecution 770 AWS DataSync InvalidRequestException User Guide This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 Data Types The following data types are supported: • AgentListEntry • AzureBlobSasConﬁguration • Capacity • Credentials • DiscoveryJobListEntry • DiscoveryServerConﬁguration • Ec2Conﬁg • FilterRule Data Types 771 AWS DataSync • FsxProtocol • FsxProtocolNfs • FsxProtocolSmb • FsxUpdateProtocol • FsxUpdateProtocolSmb • HdfsNameNode • IOPS • Latency • LocationFilter • LocationListEntry • ManifestConﬁg • MaxP95Performance • NetAppONTAPCluster • NetAppONTAPSVM • NetAppONTAPVolume • NfsMountOptions • OnPremConﬁg • Options • P95Metrics • Platform • PrivateLinkConﬁg • QopConﬁguration • Recommendation • ReportDestination • ReportDestinationS3 • ReportOverride • ReportOverrides • ReportResult • ResourceDetails • ResourceMetrics
sync-dg-195	sync-dg.pdf	195	• AWS SDK for Python • AWS SDK for Ruby V3 Data Types The following data types are supported: • AgentListEntry • AzureBlobSasConﬁguration • Capacity • Credentials • DiscoveryJobListEntry • DiscoveryServerConﬁguration • Ec2Conﬁg • FilterRule Data Types 771 AWS DataSync • FsxProtocol • FsxProtocolNfs • FsxProtocolSmb • FsxUpdateProtocol • FsxUpdateProtocolSmb • HdfsNameNode • IOPS • Latency • LocationFilter • LocationListEntry • ManifestConﬁg • MaxP95Performance • NetAppONTAPCluster • NetAppONTAPSVM • NetAppONTAPVolume • NfsMountOptions • OnPremConﬁg • Options • P95Metrics • Platform • PrivateLinkConﬁg • QopConﬁguration • Recommendation • ReportDestination • ReportDestinationS3 • ReportOverride • ReportOverrides • ReportResult • ResourceDetails • ResourceMetrics Data Types User Guide 772 User Guide AWS DataSync • S3Conﬁg • S3ManifestConﬁg • SmbMountOptions • SourceManifestConﬁg • StorageSystemListEntry • TagListEntry • TaskExecutionFilesFailedDetail • TaskExecutionFilesListedDetail • TaskExecutionListEntry • TaskExecutionResultDetail • TaskFilter • TaskListEntry • TaskReportConﬁg • TaskSchedule • TaskScheduleDetails • Throughput Data Types 773 AWS DataSync AgentListEntry User Guide Represents a single entry in a list (or array) of AWS DataSync agents when you call the ListAgents operation. Contents AgentArn The Amazon Resource Name (ARN) of a DataSync agent. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ Required: No Name The name of an agent. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ Required: No Platform The platform-related details about the agent, such as the version number. Type: Platform object Required: No Status The status of an agent. • If the status is ONLINE, the agent is conﬁgured properly and ready to use. AgentListEntry 774 AWS DataSync User Guide • If the status is OFFLINE, the agent has been out of contact with DataSync for ﬁve minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is oﬄine? Type: String Valid Values: ONLINE \| OFFLINE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AgentListEntry 775 AWS DataSync User Guide AzureBlobSasConﬁguration The shared access signature (SAS) conﬁguration that allows AWS DataSync to access your Microsoft Azure Blob Storage. For more information, see SAS tokens for accessing your Azure Blob Storage. Contents Token Speciﬁes a SAS token that provides permissions to access your Azure Blob Storage. The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this: sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp %2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^.+$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AzureBlobSasConﬁguration 776 AWS DataSync Capacity User Guide The storage capacity of an on-premises storage system resource (for example, a volume). Contents ClusterCloudStorageUsed The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering). Type: Long Valid Range: Minimum value of 0. Required: No LogicalUsed The amount of space that's being used in a storage system resource without accounting for compression or deduplication. Type: Long Valid Range: Minimum value of 0. Required: No Provisioned The total amount of space available in a storage system resource. Type: Long Valid Range: Minimum value of 0. Required: No Used The amount of space that's being used in a storage system resource. Type: Long Valid Range: Minimum value of 0. Capacity 777 AWS DataSync Required: No See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Capacity 778 AWS DataSync Credentials User Guide The credentials that provide DataSync Discovery read access to your on-premises storage system's management interface. DataSync Discovery stores these credentials in AWS Secrets Manager. For more information, see Accessing your on-premises storage system. Contents Password Speciﬁes the password for your storage system's management interface. Type: String Length Constraints: Maximum length of 1024. Pattern: ^(?!.[:\"][^:"]$).+$ Required: Yes Username Speciﬁes the user name for your storage system's management interface. Type: String Length Constraints: Maximum length of 1024. Pattern: ^(?!.[:\"][^:"]$).+$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Credentials 779 AWS DataSync User Guide Credentials 780 User Guide AWS DataSync DiscoveryJobListEntry The details about a speciﬁc DataSync discovery job. Contents DiscoveryJobArn The Amazon Resource Name (ARN) of a discovery job. Type: String Length Constraints: Maximum length
sync-dg-196	sync-dg.pdf	196	^(?!.[:\"][^:"]$).+$ Required: Yes Username Speciﬁes the user name for your storage system's management interface. Type: String Length Constraints: Maximum length of 1024. Pattern: ^(?!.[:\"][^:"]$).+$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Credentials 779 AWS DataSync User Guide Credentials 780 User Guide AWS DataSync DiscoveryJobListEntry The details about a speciﬁc DataSync discovery job. Contents DiscoveryJobArn The Amazon Resource Name (ARN) of a discovery job. Type: String Length Constraints: Maximum length of 256. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}- [a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: No Status The status of a discovery job. For more information, see Discovery job statuses. Type: String Valid Values: RUNNING \| WARNING \| TERMINATED \| FAILED \| STOPPED \| COMPLETED \| COMPLETED_WITH_ISSUES Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DiscoveryJobListEntry 781 AWS DataSync User Guide DiscoveryServerConﬁguration The network settings that DataSync Discovery uses to connect with your on-premises storage system's management interface. Contents ServerHostname The domain name or IP address of your storage system's management interface. Type: String Length Constraints: Maximum length of 255. Pattern: ^(([a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9\-][A-Za-z0-9])$ Required: Yes ServerPort The network port for accessing the storage system's management interface. Type: Integer Valid Range: Minimum value of 1. Maximum value of 65535. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DiscoveryServerConﬁguration 782 AWS DataSync Ec2Conﬁg User Guide The subnet and security groups that AWS DataSync uses to connect to one of your Amazon EFS ﬁle system's mount targets. Contents SecurityGroupArns Speciﬁes the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS ﬁle system's mount target. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):ec2:[a-z\-0-9]: [0-9]{12}:security-group/sg-[a-f0-9]+$ Required: Yes SubnetArn Speciﬁes the ARN of a subnet where DataSync creates the network interfaces for managing traﬃc during your transfer. The subnet must be located: • In the same virtual private cloud (VPC) as the Amazon EFS ﬁle system. • In the same Availability Zone as at least one mount target for the Amazon EFS ﬁle system. Note You don't need to specify a subnet that includes a ﬁle system mount target. Type: String Length Constraints: Maximum length of 128. Ec2Conﬁg 783 AWS DataSync User Guide Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):ec2:[a-z\-0-9]: [0-9]{12}:subnet/.$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Ec2Conﬁg 784 AWS DataSync FilterRule User Guide Speciﬁes which ﬁles, folders, and objects to include or exclude when transferring ﬁles from source to destination. Contents FilterType The type of ﬁlter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type. Type: String Length Constraints: Maximum length of 128. Pattern: ^[A-Z0-9_]+$ Valid Values: SIMPLE_PATTERN Required: No Value A single ﬁlter string that consists of the patterns to include or exclude. The patterns are delimited by "\|" (that is, a pipe), for example: /folder1\|/folder2 Type: String Length Constraints: Maximum length of 102400. Pattern: ^[^\x00]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 FilterRule 785 AWS DataSync • AWS SDK for Ruby V3 User Guide FilterRule 786 AWS DataSync FsxProtocol User Guide Speciﬁes the data transfer protocol that AWS DataSync uses to access your Amazon FSx ﬁle system. Contents NFS Speciﬁes the Network File System (NFS) protocol conﬁguration that DataSync uses to access your FSx for OpenZFS ﬁle system or FSx for ONTAP ﬁle system's storage virtual machine (SVM). Type: FsxProtocolNfs object Required: No SMB Speciﬁes the Server Message Block (SMB) protocol conﬁguration that DataSync uses to access your FSx for ONTAP ﬁle system's SVM. Type: FsxProtocolSmb object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FsxProtocol 787 AWS DataSync FsxProtocolNfs User Guide Speciﬁes the Network File System (NFS) protocol conﬁguration that DataSync uses to access your FSx for OpenZFS ﬁle system or FSx for ONTAP ﬁle system's storage virtual machine (SVM). Contents MountOptions Speciﬁes how DataSync can access a location using the NFS protocol. Type: NfsMountOptions object
sync-dg-197	sync-dg.pdf	197	your FSx for ONTAP ﬁle system's SVM. Type: FsxProtocolSmb object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FsxProtocol 787 AWS DataSync FsxProtocolNfs User Guide Speciﬁes the Network File System (NFS) protocol conﬁguration that DataSync uses to access your FSx for OpenZFS ﬁle system or FSx for ONTAP ﬁle system's storage virtual machine (SVM). Contents MountOptions Speciﬁes how DataSync can access a location using the NFS protocol. Type: NfsMountOptions object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FsxProtocolNfs 788 AWS DataSync FsxProtocolSmb User Guide Speciﬁes the Server Message Block (SMB) protocol conﬁguration that AWS DataSync uses to access your Amazon FSx for NetApp ONTAP ﬁle system's storage virtual machine (SVM). For more information, see Providing DataSync access to FSx for ONTAP ﬁle systems. Contents Password Speciﬁes the password of a user who has permission to access your SVM. Type: String Length Constraints: Maximum length of 104. Pattern: ^.{0,104}$ Required: Yes User Speciﬁes a user that can mount and access the ﬁles, folders, and metadata in your SVM. For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol. Type: String Length Constraints: Maximum length of 104. Pattern: ^[^\x22\x5B\x5D/\\:;\|=,+?\x3C\x3E]{1,104}$ Required: Yes Domain Speciﬁes the name of the Windows domain that your storage virtual machine (SVM) belongs to. If you have multiple domains in your environment, conﬁguring this setting makes sure that DataSync connects to the right SVM. If you have multiple Active Directory domains in your environment, conﬁguring this parameter makes sure that DataSync connects to the right SVM. FsxProtocolSmb 789 AWS DataSync Type: String User Guide Length Constraints: Maximum length of 253. Pattern: ^[A-Za-z0-9]((\.\|-+)?[A-Za-z0-9]){0,252}$ Required: No MountOptions Speciﬁes the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB ﬁle server. Type: SmbMountOptions object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FsxProtocolSmb 790 AWS DataSync FsxUpdateProtocol User Guide Speciﬁes the data transfer protocol that AWS DataSync uses to access your Amazon FSx ﬁle system. Note You can't update the Network File System (NFS) protocol conﬁguration for FSx for ONTAP locations. DataSync currently only supports NFS version 3 with this location type. Contents NFS Speciﬁes the Network File System (NFS) protocol conﬁguration that DataSync uses to access your FSx for OpenZFS ﬁle system or FSx for ONTAP ﬁle system's storage virtual machine (SVM). Type: FsxProtocolNfs object Required: No SMB Speciﬁes the Server Message Block (SMB) protocol conﬁguration that DataSync uses to access your FSx for ONTAP ﬁle system's storage virtual machine (SVM). Type: FsxUpdateProtocolSmb object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FsxUpdateProtocol 791 AWS DataSync FsxUpdateProtocolSmb User Guide Speciﬁes the Server Message Block (SMB) protocol conﬁguration that AWS DataSync uses to access your Amazon FSx for NetApp ONTAP ﬁle system's storage virtual machine (SVM). For more information, see Providing DataSync access to FSx for ONTAP ﬁle systems. Contents Domain Speciﬁes the name of the Windows domain that your storage virtual machine (SVM) belongs to. If you have multiple Active Directory domains in your environment, conﬁguring this parameter makes sure that DataSync connects to the right SVM. Type: String Length Constraints: Maximum length of 253. Pattern: ^([A-Za-z0-9]((\.\|-+)?[A-Za-z0-9]){0,252})?$ Required: No MountOptions Speciﬁes the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB ﬁle server. Type: SmbMountOptions object Required: No Password Speciﬁes the password of a user who has permission to access your SVM. Type: String Length Constraints: Maximum length of 104. Pattern: ^.{0,104}$ Required: No FsxUpdateProtocolSmb 792 AWS DataSync User User Guide Speciﬁes a user that can mount and access the ﬁles, folders, and metadata in your SVM. For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol. Type: String Length Constraints: Maximum length of 104. Pattern: ^[^\x22\x5B\x5D/\\:;\|=,+?\x3C\x3E]{1,104}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FsxUpdateProtocolSmb 793 AWS DataSync HdfsNameNode User Guide The NameNode of the
sync-dg-198	sync-dg.pdf	198	AWS DataSync User User Guide Speciﬁes a user that can mount and access the ﬁles, folders, and metadata in your SVM. For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol. Type: String Length Constraints: Maximum length of 104. Pattern: ^[^\x22\x5B\x5D/\\:;\|=,+?\x3C\x3E]{1,104}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FsxUpdateProtocolSmb 793 AWS DataSync HdfsNameNode User Guide The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the ﬁle system's namespace. The NameNode performs operations such as opening, closing, and renaming ﬁles and directories. The NameNode contains the information to map blocks of data to the DataNodes. Contents Hostname The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^(([a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9\-][A-Za-z0-9])$ Required: Yes Port The port that the NameNode uses to listen to client requests. Type: Integer Valid Range: Minimum value of 1. Maximum value of 65536. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HdfsNameNode 794 AWS DataSync User Guide HdfsNameNode 795 AWS DataSync IOPS User Guide The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval. Contents Other Peak IOPS unrelated to read and write operations. Type: Double Valid Range: Minimum value of 0. Required: No Read Peak IOPS related to read operations. Type: Double Valid Range: Minimum value of 0. Required: No Total Peak total IOPS on your on-premises storage system resource. Type: Double Valid Range: Minimum value of 0. Required: No Write Peak IOPS related to write operations. Type: Double Valid Range: Minimum value of 0. IOPS 796 AWS DataSync Required: No See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IOPS 797 AWS DataSync Latency User Guide The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval. Contents Other Peak latency for operations unrelated to read and write operations. Type: Double Valid Range: Minimum value of 0. Required: No Read Peak latency for read operations. Type: Double Valid Range: Minimum value of 0. Required: No Write Peak latency for write operations. Type: Double Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ Latency 798 AWS DataSync • AWS SDK for Java V2 • AWS SDK for Ruby V3 User Guide Latency 799 AWS DataSync LocationFilter User Guide Narrow down the list of resources returned by ListLocations. For example, to see all your Amazon S3 locations, create a ﬁlter using "Name": "LocationType", "Operator": "Equals", and "Values": "S3". For more information, see ﬁltering resources. Contents Name The name of the ﬁlter being used. Each API call supports a list of ﬁlters that are available for it (for example, LocationType for ListLocations). Type: String Valid Values: LocationUri \| LocationType \| CreationTime Required: Yes Operator The operator that is used to compare ﬁlter values (for example, Equals or Contains). Type: String Valid Values: Equals \| NotEquals \| In \| LessThanOrEqual \| LessThan \| GreaterThanOrEqual \| GreaterThan \| Contains \| NotContains \| BeginsWith Required: Yes Values The values that you want to ﬁlter for. For example, you might want to display only Amazon S3 locations. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-zA-Z_\ \-\:\\.\\/\?-]$ Required: Yes LocationFilter 800 AWS DataSync See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LocationFilter 801 AWS DataSync LocationListEntry User Guide Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called. Contents LocationArn The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the preﬁx path
sync-dg-199	sync-dg.pdf	199	Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LocationFilter 801 AWS DataSync LocationListEntry User Guide Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called. Contents LocationArn The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the preﬁx path that you want to mount and use as the root of the location. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ Required: No LocationUri Represents a list of URIs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called. Format: TYPE://GLOBAL_ID/SUBDIR. TYPE designates the type of location (for example, nfs or s3). GLOBAL_ID is the globally unique identiﬁer of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 address or a hostname that is compliant with Domain Name Service (DNS). SUBDIR is a valid ﬁle system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the preﬁx path that you mount to and treat as the root of the location. Type: String LocationListEntry 802 AWS DataSync User Guide Length Constraints: Maximum length of 4360. Pattern: ^(efs\|nfs\|s3\|smb\|hdfs\|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LocationListEntry 803 AWS DataSync ManifestConﬁg User Guide Conﬁgures a manifest, which is a list of ﬁles or objects that you want AWS DataSync to transfer. For more information and conﬁguration examples, see Specifying what DataSync transfers by using a manifest. Contents Action Speciﬁes what DataSync uses the manifest for. Type: String Valid Values: TRANSFER Required: No Format Speciﬁes the ﬁle format of your manifest. For more information, see Creating a manifest. Type: String Valid Values: CSV Required: No Source Speciﬁes the manifest that you want DataSync to use and where it's hosted. Note You must specify this parameter if you're conﬁguring a new manifest on or after February 7, 2024. If you don't, you'll get a 400 status code and ValidationException error stating that you're missing the IAM role for DataSync to access the S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest. Type: SourceManifestConﬁg object ManifestConﬁg 804 AWS DataSync Required: No See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManifestConﬁg 805 AWS DataSync MaxP95Performance User Guide The performance data that DataSync Discovery collects about an on-premises storage system resource. Contents IopsOther Peak IOPS unrelated to read and write operations. Type: Double Valid Range: Minimum value of 0. Required: No IopsRead Peak IOPS related to read operations. Type: Double Valid Range: Minimum value of 0. Required: No IopsTotal Peak total IOPS on your on-premises storage system resource. Type: Double Valid Range: Minimum value of 0. Required: No IopsWrite Peak IOPS related to write operations. Type: Double Valid Range: Minimum value of 0. MaxP95Performance 806 AWS DataSync Required: No LatencyOther Peak latency for operations unrelated to read and write operations. User Guide Type: Double Valid Range: Minimum value of 0. Required: No LatencyRead Peak latency for read operations. Type: Double Valid Range: Minimum value of 0. Required: No LatencyWrite Peak latency for write operations. Type: Double Valid Range: Minimum value of 0. Required: No ThroughputOther Peak throughput unrelated to read and write operations. Type: Double Valid Range: Minimum value of 0. Required: No ThroughputRead Peak throughput related to read operations. Type: Double MaxP95Performance 807 AWS DataSync User Guide Valid Range: Minimum value of 0. Required: No ThroughputTotal Peak total throughput on your on-premises storage system resource. Type: Double Valid Range: Minimum value of 0. Required: No ThroughputWrite Peak throughput related to write operations. Type: Double Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MaxP95Performance 808 AWS DataSync NetAppONTAPCluster User Guide The information that DataSync Discovery collects about an on-premises storage
sync-dg-200	sync-dg.pdf	200	User Guide Valid Range: Minimum value of 0. Required: No ThroughputTotal Peak total throughput on your on-premises storage system resource. Type: Double Valid Range: Minimum value of 0. Required: No ThroughputWrite Peak throughput related to write operations. Type: Double Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MaxP95Performance 808 AWS DataSync NetAppONTAPCluster User Guide The information that DataSync Discovery collects about an on-premises storage system cluster. Contents CifsShareCount The number of CIFS shares in the cluster. Type: Long Valid Range: Minimum value of 0. Required: No ClusterBlockStorageLogicalUsed The storage space that's being used in the cluster without accounting for compression or deduplication. Type: Long Valid Range: Minimum value of 0. Required: No ClusterBlockStorageSize The total storage space that's available in the cluster. Type: Long Valid Range: Minimum value of 0. Required: No ClusterBlockStorageUsed The storage space that's being used in a cluster. Type: Long Valid Range: Minimum value of 0. NetAppONTAPCluster 809 AWS DataSync Required: No ClusterCloudStorageUsed User Guide The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering). Type: Long Valid Range: Minimum value of 0. Required: No ClusterName The name of the cluster. Type: String Length Constraints: Maximum length of 1024. Pattern: ^.{0,1024}$ Required: No LunCount The number of LUNs (logical unit numbers) in the cluster. Type: Long Valid Range: Minimum value of 0. Required: No MaxP95Performance The performance data that DataSync Discovery collects about the cluster. Type: MaxP95Performance object Required: No NfsExportedVolumes The number of NFS volumes in the cluster. NetAppONTAPCluster 810 AWS DataSync Type: Long Valid Range: Minimum value of 0. Required: No Recommendations User Guide The AWS storage services that DataSync Discovery recommends for the cluster. For more information, see Recommendations provided by DataSync Discovery. Type: Array of Recommendation objects Required: No RecommendationStatus Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete, or can't be determined. For more information, see Recommendation statuses. Type: String Valid Values: NONE \| IN_PROGRESS \| COMPLETED \| FAILED Required: No ResourceId The universally unique identiﬁer (UUID) of the cluster. 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ NetAppONTAPCluster 811 AWS DataSync • AWS SDK for Java V2 • AWS SDK for Ruby V3 User Guide NetAppONTAPCluster 812 AWS DataSync NetAppONTAPSVM User Guide The information that DataSync Discovery collects about a storage virtual machine (SVM) in your on-premises storage system. Contents CifsShareCount The number of CIFS shares in the SVM. Type: Long Valid Range: Minimum value of 0. Required: No ClusterUuid The universally unique identiﬁer (UUID) of the cluster associated with the SVM. 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 EnabledProtocols The data transfer protocols (such as NFS) conﬁgured for the SVM. Type: Array of strings Length Constraints: Maximum length of 1024. Pattern: ^.{0,1024}$ Required: No LunCount The number of LUNs (logical unit numbers) in the SVM. Type: Long NetAppONTAPSVM 813 AWS DataSync User Guide Valid Range: Minimum value of 0. Required: No MaxP95Performance The performance data that DataSync Discovery collects about the SVM. Type: MaxP95Performance object Required: No NfsExportedVolumes The number of NFS volumes in the SVM. Type: Long Valid Range: Minimum value of 0. Required: No Recommendations The AWS storage services that DataSync Discovery recommends for the SVM. For more information, see Recommendations provided by DataSync Discovery. Type: Array of Recommendation objects Required: No RecommendationStatus Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or can't be determined. For more information, see Recommendation statuses. Type: String Valid Values: NONE \| IN_PROGRESS \| COMPLETED \| FAILED Required: No ResourceId The UUID of the SVM. NetAppONTAPSVM 814 AWS DataSync Type: String User Guide Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: No SvmName The name of the SVM Type: String Length Constraints: Maximum length of 1024. Pattern: ^.{0,1024}$ Required: No TotalCapacityProvisioned The total storage space that's available in the SVM. Type: Long Valid Range: Minimum value of 0. Required: No TotalCapacityUsed The storage space that's being used in the SVM. Type: Long Valid Range: Minimum value of 0. Required: No TotalLogicalCapacityUsed The storage space that's being used in the SVM without accounting for compression or deduplication. Type: Long Valid Range: Minimum value of 0. NetAppONTAPSVM 815 AWS DataSync Required: No TotalSnapshotCapacityUsed The amount of storage in the SVM that's being used for snapshots. User Guide Type: Long Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for
sync-dg-201	sync-dg.pdf	201	space that's being used in the SVM. Type: Long Valid Range: Minimum value of 0. Required: No TotalLogicalCapacityUsed The storage space that's being used in the SVM without accounting for compression or deduplication. Type: Long Valid Range: Minimum value of 0. NetAppONTAPSVM 815 AWS DataSync Required: No TotalSnapshotCapacityUsed The amount of storage in the SVM that's being used for snapshots. User Guide Type: Long Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NetAppONTAPSVM 816 AWS DataSync NetAppONTAPVolume User Guide The information that DataSync Discovery collects about a volume in your on-premises storage system. Contents CapacityProvisioned The total storage space that's available in the volume. Type: Long Valid Range: Minimum value of 0. Required: No CapacityUsed The storage space that's being used in the volume. Type: Long Valid Range: Minimum value of 0. Required: No CifsShareCount The number of CIFS shares in the volume. Type: Long Valid Range: Minimum value of 0. Required: No LogicalCapacityUsed The storage space that's being used in the volume without accounting for compression or deduplication. Type: Long Valid Range: Minimum value of 0. NetAppONTAPVolume 817 AWS DataSync Required: No LunCount User Guide The number of LUNs (logical unit numbers) in the volume. Type: Long Valid Range: Minimum value of 0. Required: No MaxP95Performance The performance data that DataSync Discovery collects about the volume. Type: MaxP95Performance object Required: No NfsExported The number of NFS volumes in the volume. Type: Boolean Required: No Recommendations The AWS storage services that DataSync Discovery recommends for the volume. For more information, see Recommendations provided by DataSync Discovery. Type: Array of Recommendation objects Required: No RecommendationStatus Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete, or can't be determined. For more information, see Recommendation statuses. Type: String Valid Values: NONE \| IN_PROGRESS \| COMPLETED \| FAILED NetAppONTAPVolume 818 AWS DataSync Required: No ResourceId User Guide The universally unique identiﬁer (UUID) of the volume. 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 SecurityStyle The volume's security style (such as Unix or NTFS). Type: String Length Constraints: Maximum length of 1024. Pattern: ^.{0,1024}$ Required: No SnapshotCapacityUsed The amount of storage in the volume that's being used for snapshots. Type: Long Valid Range: Minimum value of 0. Required: No SvmName The name of the SVM associated with the volume. Type: String Length Constraints: Maximum length of 1024. Pattern: ^.{0,1024}$ Required: No NetAppONTAPVolume 819 AWS DataSync SvmUuid User Guide The UUID of the storage virtual machine (SVM) associated with the volume. 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 VolumeName The name of the volume. Type: String Length Constraints: Maximum length of 1024. Pattern: ^.{0,1024}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NetAppONTAPVolume 820 AWS DataSync NfsMountOptions User Guide Speciﬁes how DataSync can access a location using the NFS protocol. Contents Version Speciﬁes the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version speciﬁed, the task fails. You can specify the following options: • AUTOMATIC (default): DataSync chooses NFS version 4.1. • NFS3: Stateless protocol version that allows for asynchronous writes on the server. • NFSv4_0: Stateful, ﬁrewall-friendly protocol version that supports delegations and pseudo ﬁle systems. • NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0. Note DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations. Type: String Valid Values: AUTOMATIC \| NFS3 \| NFS4_0 \| NFS4_1 Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 NfsMountOptions 821 AWS DataSync • AWS SDK for Ruby V3 User Guide NfsMountOptions 822 AWS DataSync OnPremConﬁg User Guide The AWS DataSync agents that can connect to your Network File System (NFS) ﬁle server. Contents AgentArns The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS ﬁle server. You can specify more than one agent. For more information, see Using multiple DataSync agents. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS
sync-dg-202	sync-dg.pdf	202	your Network File System (NFS) ﬁle server. Contents AgentArns The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS ﬁle server. You can specify more than one agent. For more information, see Using multiple DataSync agents. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OnPremConﬁg 823 AWS DataSync Options User Guide Indicates how your transfer task is conﬁgured. These options include how DataSync handles ﬁles, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options. Each option has a default value. Unless you need to, you don't have to conﬁgure any option before calling StartTaskExecution. You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution. Contents Atime Speciﬁes whether to preserve metadata indicating the last time a ﬁle was read or written to. Note The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-eﬀort basis. • BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on all source ﬁles (that is, the version before the PREPARING steps of the task execution). This option is recommended. • NONE - Ignores Atime. Note If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE. Type: String Valid Values: NONE \| BEST_EFFORT Required: No Options 824 AWS DataSync BytesPerSecond User Guide Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024). Note Not applicable to Enhanced mode tasks. Type: Long Valid Range: Minimum value of -1. Required: No Gid Speciﬁes the POSIX group ID (GID) of the ﬁle's owners. • INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended. • NONE - Ignores UID and GID. For more information, see Understanding how DataSync handles ﬁle and object metadata. Type: String Valid Values: NONE \| INT_VALUE \| NAME \| BOTH Required: No LogLevel Speciﬁes the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn. • BASIC - Publishes logs with only basic information (such as transfer errors). • TRANSFER - Publishes logs for all ﬁles or objects that your DataSync task transfers and performs data-integrity checks on. • OFF - No logs are published. Options 825 AWS DataSync Type: String Valid Values: OFF \| BASIC \| TRANSFER Required: No Mtime User Guide Speciﬁes whether to preserve metadata indicating the last time that a ﬁle was written to before the PREPARING step of your task execution. This option is required when you need to run the a task more than once. • PRESERVE (default) - Preserves original Mtime, which is recommended. • NONE - Ignores Mtime. Note If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. If Mtime is set to NONE, Atime must also be set to NONE. Type: String Valid Values: NONE \| PRESERVE Required: No ObjectTags Speciﬁes whether you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Type: String Valid Values: PRESERVE \| NONE Required: No OverwriteMode Speciﬁes whether DataSync should modify or preserve data at the destination location. Options 826 AWS DataSync User Guide • ALWAYS (default) - DataSync modiﬁes data in the destination location when source data (including metadata) has changed. If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers. • NEVER - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to ﬁles or objects in the destination. Type: String Valid Values: ALWAYS \| NEVER Required: No PosixPermissions Speciﬁes which users or groups can access a ﬁle for a speciﬁc purpose such as reading, writing, or execution of the ﬁle. For more information, see Understanding how DataSync handles ﬁle and object metadata. • PRESERVE (default) - Preserves POSIX-style permissions, which is recommended. • NONE - Ignores POSIX-style permissions. Note DataSync can preserve extant permissions of a source location.
sync-dg-203	sync-dg.pdf	203	data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to ﬁles or objects in the destination. Type: String Valid Values: ALWAYS \| NEVER Required: No PosixPermissions Speciﬁes which users or groups can access a ﬁle for a speciﬁc purpose such as reading, writing, or execution of the ﬁle. For more information, see Understanding how DataSync handles ﬁle and object metadata. • PRESERVE (default) - Preserves POSIX-style permissions, which is recommended. • NONE - Ignores POSIX-style permissions. Note DataSync can preserve extant permissions of a source location. Type: String Valid Values: NONE \| PRESERVE Required: No PreserveDeletedFiles Speciﬁes whether ﬁles in the destination location that don't exist in the source should be preserved. This option can aﬀect your Amazon S3 storage cost. If your task deletes objects, Options 827 AWS DataSync User Guide you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync. • PRESERVE (default) - Ignores such destination ﬁles, which is recommended. • REMOVE - Deletes destination ﬁles that aren’t present in the source. Note If you set this parameter to REMOVE, you can't set TransferMode to ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete. Type: String Valid Values: PRESERVE \| REMOVE Required: No PreserveDevices Speciﬁes whether DataSync should preserve the metadata of block and character devices in the source location and recreate the ﬁles with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices. Note DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-ﬁle (EOF) marker. • NONE (default) - Ignores special devices (recommended). • PRESERVE - Preserves character and block device metadata. This option currently isn't supported for Amazon EFS. Type: String Valid Values: NONE \| PRESERVE Required: No Options 828 AWS DataSync SecurityDescriptorCopyFlags User Guide Speciﬁes which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see Understanding how DataSync handles ﬁle and object metadata. • OWNER_DACL (default) - For each copied object, DataSync copies the following metadata: • The object owner. • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. DataSync won't copy NTFS system access control lists (SACLs) with this option. • OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata: • The object owner. • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. • SACLs, which are used by administrators to log attempts to access a secured object. Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer). • NONE - None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s conﬁguration. Type: String Valid Values: NONE \| OWNER_DACL \| OWNER_DACL_SACL Required: No TaskQueueing Speciﬁes whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is ENABLED by default. Options 829 AWS DataSync Type: String Valid Values: ENABLED \| DISABLED Required: No TransferMode User Guide Speciﬁes whether DataSync transfers only the data (including metadata) that diﬀers between locations following an initial copy or transfers all data every time you run the task. If you're planning on recurring transfers, you might only want to transfer what's changed since your previous task execution. • CHANGED (default) - After your initial full transfer, DataSync copies only the data and metadata that diﬀers between the source and destination location. • ALL - DataSync copies everything in the source to the destination without comparing diﬀerences between the locations. Type: String Valid Values: CHANGED \| ALL Required: No Uid Speciﬁes the POSIX user ID (UID) of the ﬁle's owner. • INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended. • NONE - Ignores UID and GID. For more information, see Metadata copied by DataSync. Type: String Valid Values: NONE \| INT_VALUE \| NAME \| BOTH Required: No VerifyMode Speciﬁes if and how DataSync checks the integrity of your data at the end of your transfer. • ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of
sync-dg-204	sync-dg.pdf	204	the destination without comparing diﬀerences between the locations. Type: String Valid Values: CHANGED \| ALL Required: No Uid Speciﬁes the POSIX user ID (UID) of the ﬁle's owner. • INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended. • NONE - Ignores UID and GID. For more information, see Metadata copied by DataSync. Type: String Valid Values: NONE \| INT_VALUE \| NAME \| BOTH Required: No VerifyMode Speciﬁes if and how DataSync checks the integrity of your data at the end of your transfer. • ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred data (including metadata) at the source location. At the end of the transfer, Options 830 AWS DataSync User Guide DataSync then compares this checksum to the checksum calculated on that data at the destination. Note This is the default option for Enhanced mode tasks. We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations. • POINT_IN_TIME_CONSISTENT - At the end of the transfer, DataSync checks the entire source and destination to verify that both locations are fully synchronized. Note The is the default option for Basic mode tasks and isn't currently supported with Enhanced mode tasks. If you use a manifest, DataSync only scans and veriﬁes what's listed in the manifest. You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations. • NONE - DataSync performs data integrity checks only during your transfer. Unlike other options, there's no additional veriﬁcation at the end of your transfer. Type: String Valid Values: POINT_IN_TIME_CONSISTENT \| ONLY_FILES_TRANSFERRED \| NONE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Options 831 AWS DataSync • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 User Guide Options 832 AWS DataSync P95Metrics User Guide The types of performance data that DataSync Discovery collects about an on-premises storage system resource. Contents IOPS The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval. Type: IOPS object Required: No Latency The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval. Type: Latency object Required: No Throughput The throughput peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval. Type: Throughput object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 P95Metrics 833 AWS DataSync User Guide P95Metrics 834 AWS DataSync Platform User Guide The platform-related details about the AWS DataSync agent, such as the version number. Contents Version The version of the DataSync agent. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Platform 835 AWS DataSync PrivateLinkConﬁg User Guide Speciﬁes how your AWS DataSync agent connects to AWS using a virtual private cloud (VPC) service endpoint. An agent that uses a VPC endpoint isn't accessible over the public internet. Contents PrivateLinkEndpoint Speciﬁes the VPC endpoint provided by AWS PrivateLink that your agent connects to. Type: String Length Constraints: Minimum length of 7. Maximum length of 15. Pattern: \A(25[0-5]\|2[0-4]\d\|[0-1]?\d?\d)(\.(25[0-5]\|2[0-4]\d\|[0-1]?\d?\d)) {3}\z Required: No SecurityGroupArns Speciﬁes the Amazon Resource Names (ARN) of the security group that provides DataSync access to your VPC endpoint. You can only specify one ARN. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):ec2:[a-z\-0-9]: [0-9]{12}:security-group/sg-[a-f0-9]+$ Required: No SubnetArns Speciﬁes the ARN of the subnet where your VPC endpoint is located. You can only specify one ARN. Type: Array of strings Array Members: Fixed number of 1 item. PrivateLinkConﬁg 836 AWS DataSync User Guide Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):ec2:[a-z\-0-9]: [0-9]{12}:subnet/.*$ Required: No VpcEndpointId Speciﬁes the ID of the VPC endpoint that your agent connects to. Type: String Pattern: ^vpce-[0-9a-f]{17}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PrivateLinkConﬁg 837 AWS DataSync QopConﬁguration User Guide The Quality of Protection (QOP) conﬁguration speciﬁes
sync-dg-205	sync-dg.pdf	205	specify one ARN. Type: Array of strings Array Members: Fixed number of 1 item. PrivateLinkConﬁg 836 AWS DataSync User Guide Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):ec2:[a-z\-0-9]: [0-9]{12}:subnet/.$ Required: No VpcEndpointId Speciﬁes the ID of the VPC endpoint that your agent connects to. Type: String Pattern: ^vpce-[0-9a-f]{17}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PrivateLinkConﬁg 837 AWS DataSync QopConﬁguration User Guide The Quality of Protection (QOP) conﬁguration speciﬁes the Remote Procedure Call (RPC) and data transfer privacy settings conﬁgured on the Hadoop Distributed File System (HDFS) cluster. Contents DataTransferProtection The data transfer protection setting conﬁgured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml ﬁle on your Hadoop cluster. Type: String Valid Values: DISABLED \| AUTHENTICATION \| INTEGRITY \| PRIVACY Required: No RpcProtection The RPC protection setting conﬁgured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml ﬁle on your Hadoop cluster. Type: String Valid Values: DISABLED \| AUTHENTICATION \| INTEGRITY \| PRIVACY Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 QopConﬁguration 838 AWS DataSync Recommendation User Guide The details about an AWS storage service that DataSync Discovery recommends for a resource in your on-premises storage system. For more information, see Recommendations provided by DataSync Discovery. Contents EstimatedMonthlyStorageCost The estimated monthly cost of the recommended AWS storage service. Type: String Length Constraints: Maximum length of 1024. Pattern: ^.{0,1024}$ Required: No StorageConﬁguration Information about how you can set up a recommended AWS storage service. Type: String to string map Key Length Constraints: Maximum length of 1024. Key Pattern: ^.{0,1024}$ Value Length Constraints: Maximum length of 1024. Value Pattern: ^.{0,1024}$ Required: No StorageType A recommended AWS storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system. Type: String Length Constraints: Maximum length of 1024. Recommendation 839 AWS DataSync Pattern: ^.{0,1024}$ Required: No See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Recommendation 840 AWS DataSync ReportDestination Speciﬁes where DataSync uploads your task report. Contents S3 User Guide Speciﬁes the Amazon S3 bucket where DataSync uploads your task report. Type: ReportDestinationS3 object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ReportDestination 841 AWS DataSync ReportDestinationS3 User Guide Speciﬁes the Amazon S3 bucket where DataSync uploads your task report. Contents BucketAccessRoleArn Speciﬁes the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket. Type: String Length Constraints: Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):iam::[0-9] {12}:role/.$ Required: Yes S3BucketArn Speciﬁes the ARN of the S3 bucket where DataSync uploads your report. Type: String Length Constraints: Maximum length of 268. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):s3:[a-z\-0-9]: [0-9]{12}:accesspoint[/:][a-zA-Z0-9\-.]{1,63}$\|^arn:(aws\|aws-cn\|aws-us- gov\|aws-iso\|aws-iso-b):s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:][a- zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$\|^arn:(aws\|aws- cn\|aws-us-gov\|aws-iso\|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$ Required: Yes Subdirectory Speciﬁes a bucket preﬁx for your report. Type: String Length Constraints: Maximum length of 4096. ReportDestinationS3 842 AWS DataSync User Guide Pattern: ^[a-zA-Z0-9_\-\+\./\p{Zs}]*$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ReportDestinationS3 843 AWS DataSync ReportOverride User Guide Speciﬁes the level of detail for a particular aspect of your DataSync task report. Contents ReportLevel Speciﬁes whether your task report includes errors only or successes and errors. For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task ﬁlter is working correctly. In this situation, you can get a list of what ﬁles DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS). Type: String Valid Values: ERRORS_ONLY \| SUCCESSES_AND_ERRORS Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ReportOverride 844 AWS DataSync ReportOverrides User Guide The level of detail included in each aspect of your DataSync task report. Contents Deleted Speciﬁes the level
sync-dg-206	sync-dg.pdf	206	your task ﬁlter is working correctly. In this situation, you can get a list of what ﬁles DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS). Type: String Valid Values: ERRORS_ONLY \| SUCCESSES_AND_ERRORS Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ReportOverride 844 AWS DataSync ReportOverrides User Guide The level of detail included in each aspect of your DataSync task report. Contents Deleted Speciﬁes the level of reporting for the ﬁles, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you conﬁgure your task to delete data in the destination that isn't in the source. Type: ReportOverride object Required: No Skipped Speciﬁes the level of reporting for the ﬁles, objects, and directories that DataSync attempted to skip during your transfer. Type: ReportOverride object Required: No Transferred Speciﬁes the level of reporting for the ﬁles, objects, and directories that DataSync attempted to transfer. Type: ReportOverride object Required: No Veriﬁed Speciﬁes the level of reporting for the ﬁles, objects, and directories that DataSync attempted to verify at the end of your transfer. Type: ReportOverride object Required: No ReportOverrides 845 AWS DataSync See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ReportOverrides 846 AWS DataSync ReportResult User Guide Indicates whether DataSync created a complete task report for your transfer. Contents ErrorCode Indicates the code associated with the error if DataSync can't create a complete report. Type: String Required: No ErrorDetail Provides details about issues creating a report. Type: String Required: No Status Indicates whether DataSync is still working on your report, created a report, or can't create a complete report. Type: String Valid Values: PENDING \| SUCCESS \| ERROR Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ReportResult 847 AWS DataSync ResourceDetails User Guide Information provided by DataSync Discovery about the resources in your on-premises storage system. Contents NetAppONTAPClusters The information that DataSync Discovery collects about the cluster in your on-premises storage system. Type: Array of NetAppONTAPCluster objects Required: No NetAppONTAPSVMs The information that DataSync Discovery collects about storage virtual machines (SVMs) in your on-premises storage system. Type: Array of NetAppONTAPSVM objects Required: No NetAppONTAPVolumes The information that DataSync Discovery collects about volumes in your on-premises storage system. Type: Array of NetAppONTAPVolume objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceDetails 848 AWS DataSync User Guide ResourceDetails 849 AWS DataSync ResourceMetrics User Guide Information, including performance data and capacity usage, provided by DataSync Discovery about a resource in your on-premises storage system. Contents Capacity The storage capacity of the on-premises storage system resource. Type: Capacity object Required: No P95Metrics The types of performance data that DataSync Discovery collects about the on-premises storage system resource. Type: P95Metrics object Required: No ResourceId The universally unique identiﬁer (UUID) of the on-premises storage system resource. 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 ResourceType The type of on-premises storage system resource. Type: String Valid Values: SVM \| VOLUME \| CLUSTER Required: No ResourceMetrics 850 AWS DataSync Timestamp User Guide The time when DataSync Discovery collected this information from the resource. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceMetrics 851 AWS DataSync S3Conﬁg User Guide Speciﬁes the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket. For more information, see Providing DataSync access to S3 buckets. Contents BucketAccessRoleArn Speciﬁes the ARN of the IAM role that DataSync uses to access your S3 bucket. Type: String Length Constraints: Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):iam::[0-9] {12}:role/.*$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3Conﬁg 852 AWS DataSync S3ManifestConﬁg User Guide Speciﬁes the S3 bucket where you're hosting the manifest that you want AWS DataSync to use. For more information and conﬁguration examples, see Specifying what
sync-dg-207	sync-dg.pdf	207	S3 buckets. Contents BucketAccessRoleArn Speciﬁes the ARN of the IAM role that DataSync uses to access your S3 bucket. Type: String Length Constraints: Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):iam::[0-9] {12}:role/.$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3Conﬁg 852 AWS DataSync S3ManifestConﬁg User Guide Speciﬁes the S3 bucket where you're hosting the manifest that you want AWS DataSync to use. For more information and conﬁguration examples, see Specifying what DataSync transfers by using a manifest. Contents BucketAccessRoleArn Speciﬁes the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see Providing DataSync access to your manifest. Type: String Length Constraints: Maximum length of 2048. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):iam::[0-9] {12}:role/.$ Required: Yes ManifestObjectPath Speciﬁes the Amazon S3 object key of your manifest. This can include a preﬁx (for example, prefix/my-manifest.csv). Type: String Length Constraints: Maximum length of 4096. Pattern: ^[a-zA-Z0-9_\-\+\./\p{Zs}]$ Required: Yes S3BucketArn Speciﬁes the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest. Type: String Length Constraints: Maximum length of 268. S3ManifestConﬁg 853 AWS DataSync User Guide Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):s3:[a-z\-0-9]: [0-9]{12}:accesspoint[/:][a-zA-Z0-9\-.]{1,63}$\|^arn:(aws\|aws-cn\|aws-us- gov\|aws-iso\|aws-iso-b):s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:][a- zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$\|^arn:(aws\|aws- cn\|aws-us-gov\|aws-iso\|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$ Required: Yes ManifestObjectVersionId Speciﬁes the object version ID of the manifest that you want DataSync to use. If you don't set this, DataSync uses the latest version of the object. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^.+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3ManifestConﬁg 854 AWS DataSync SmbMountOptions User Guide Speciﬁes the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB ﬁle server. Contents Version By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB ﬁle server. You also can conﬁgure DataSync to use a speciﬁc SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB ﬁle server automatically. These are the following options for conﬁguring the SMB version: • AUTOMATIC (default): DataSync and the SMB ﬁle server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a speciﬁc version that your ﬁle server doesn't support, you may get an Operation Not Supported error. • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2. • SMB2: Restricts the protocol negotiation to only SMB version 2.1. • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0. • SMB1: Restricts the protocol negotiation to only SMB version 1.0. Note The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location. Type: String Valid Values: AUTOMATIC \| SMB2 \| SMB3 \| SMB1 \| SMB2_0 Required: No SmbMountOptions 855 AWS DataSync See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SmbMountOptions 856 AWS DataSync SourceManifestConﬁg User Guide Speciﬁes the manifest that you want AWS DataSync to use and where it's hosted. For more information and conﬁguration examples, see Specifying what DataSync transfers by using a manifest. Contents S3 Speciﬁes the S3 bucket where you're hosting your manifest. Type: S3ManifestConﬁg object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SourceManifestConﬁg 857 AWS DataSync User Guide StorageSystemListEntry Information that identiﬁes an on-premises storage system that you're using with DataSync Discovery. Contents Name The name of an on-premises storage system that you added to DataSync Discovery. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\p{L}\p{M}\p{N}\s+=._:@\/-]+$ Required: No StorageSystemArn The Amazon Resource Names (ARN) of an on-premises storage system that you added to DataSync Discovery. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 StorageSystemListEntry 858 AWS DataSync • AWS SDK for Ruby V3 User Guide StorageSystemListEntry 859 AWS DataSync TagListEntry User Guide A key-value pair representing a single tag that's been applied to an AWS resource. Contents Key The key for an AWS resource tag. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:/-]+$
sync-dg-208	sync-dg.pdf	208	Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9] {4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 StorageSystemListEntry 858 AWS DataSync • AWS SDK for Ruby V3 User Guide StorageSystemListEntry 859 AWS DataSync TagListEntry User Guide A key-value pair representing a single tag that's been applied to an AWS resource. Contents Key The key for an AWS resource tag. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:/-]+$ Required: Yes Value The value for an AWS resource tag. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TagListEntry 860 AWS DataSync User Guide TaskExecutionFilesFailedDetail The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution. Note Applies only to Enhanced mode tasks. Contents Delete The number of objects that DataSync fails to delete during your task execution. Type: Long Required: No Prepare The number of objects that DataSync fails to prepare during your task execution. Type: Long Required: No Transfer The number of objects that DataSync fails to transfer during your task execution. Type: Long Required: No Verify The number of objects that DataSync fails to verify during your task execution. Type: Long Required: No TaskExecutionFilesFailedDetail 861 AWS DataSync See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TaskExecutionFilesFailedDetail 862 AWS DataSync User Guide TaskExecutionFilesListedDetail The number of objects that DataSync ﬁnds at your locations. Note Applies only to Enhanced mode tasks. Contents AtDestinationForDelete The number of objects that DataSync ﬁnds at your destination location. This counter is only applicable if you conﬁgure your task to delete data in the destination that isn't in the source. Type: Long Required: No AtSource The number of objects that DataSync ﬁnds at your source location. • With a manifest, DataSync lists only what's in your manifest (and not everything at your source location). • With an include ﬁlter, DataSync lists only what matches the ﬁlter at your source location. • With an exclude ﬁlter, DataSync lists everything at your source location before applying the ﬁlter. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 TaskExecutionFilesListedDetail 863 AWS DataSync • AWS SDK for Ruby V3 User Guide TaskExecutionFilesListedDetail 864 AWS DataSync TaskExecutionListEntry User Guide Represents a single entry in a list of AWS DataSync task executions that's returned with the ListTaskExecutions operation. Contents Status The status of a task execution. For more information, see Task execution statuses. Type: String Valid Values: QUEUED \| CANCELLING \| LAUNCHING \| PREPARING \| TRANSFERRING \| VERIFYING \| SUCCESS \| ERROR Required: No TaskExecutionArn The Amazon Resource Name (ARN) of a task execution. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$ Required: No TaskMode The task mode that you're using. For more information, see Choosing a task mode for your data transfer. Type: String Valid Values: BASIC \| ENHANCED Required: No TaskExecutionListEntry 865 AWS DataSync See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TaskExecutionListEntry 866 AWS DataSync User Guide TaskExecutionResultDetail Provides detailed information about the result of your AWS DataSync task execution. Contents ErrorCode An error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues. Type: String Required: No ErrorDetail The detailed description of an error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues. Type: String Required: No PrepareDuration The time in milliseconds that your task execution was in the PREPARING step. For more information, see Task execution statuses. For Enhanced mode tasks, the value is always 0. For more information, see How DataSync prepares your data transfer. Type: Long Valid Range: Minimum value of 0. Required: No PrepareStatus The status of the PREPARING step for your task execution. For more information, see Task execution statuses. Type: String TaskExecutionResultDetail 867 AWS DataSync User Guide Valid Values: PENDING \| SUCCESS \| ERROR Required: No TotalDuration The time in milliseconds that your task execution ran. Type: Long Valid
sync-dg-209	sync-dg.pdf	209	Required: No PrepareDuration The time in milliseconds that your task execution was in the PREPARING step. For more information, see Task execution statuses. For Enhanced mode tasks, the value is always 0. For more information, see How DataSync prepares your data transfer. Type: Long Valid Range: Minimum value of 0. Required: No PrepareStatus The status of the PREPARING step for your task execution. For more information, see Task execution statuses. Type: String TaskExecutionResultDetail 867 AWS DataSync User Guide Valid Values: PENDING \| SUCCESS \| ERROR Required: No TotalDuration The time in milliseconds that your task execution ran. Type: Long Valid Range: Minimum value of 0. Required: No TransferDuration The time in milliseconds that your task execution was in the TRANSFERRING step. For more information, see Task execution statuses. For Enhanced mode tasks, the value is always 0. For more information, see How DataSync transfers your data. Type: Long Valid Range: Minimum value of 0. Required: No TransferStatus The status of the TRANSFERRING step for your task execution. For more information, see Task execution statuses. Type: String Valid Values: PENDING \| SUCCESS \| ERROR Required: No VerifyDuration The time in milliseconds that your task execution was in the VERIFYING step. For more information, see Task execution statuses. For Enhanced mode tasks, the value is always 0. For more information, see How DataSync veriﬁes your data's integrity. TaskExecutionResultDetail 868 AWS DataSync Type: Long Valid Range: Minimum value of 0. Required: No VerifyStatus User Guide The status of the VERIFYING step for your task execution. For more information, see Task execution statuses. Type: String Valid Values: PENDING \| SUCCESS \| ERROR Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TaskExecutionResultDetail 869 AWS DataSync TaskFilter User Guide You can use API ﬁlters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a source location, you can use ListTasks with ﬁlter name LocationId and Operator Equals with the ARN for the location. For more information, see ﬁltering DataSync resources. Contents Name The name of the ﬁlter being used. Each API call supports a list of ﬁlters that are available for it. For example, LocationId for ListTasks. Type: String Valid Values: LocationId \| CreationTime Required: Yes Operator The operator that is used to compare ﬁlter values (for example, Equals or Contains). Type: String Valid Values: Equals \| NotEquals \| In \| LessThanOrEqual \| LessThan \| GreaterThanOrEqual \| GreaterThan \| Contains \| NotContains \| BeginsWith Required: Yes Values The values that you want to ﬁlter for. For example, you might want to display only tasks for a speciﬁc destination location. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-zA-Z_\ \-\:\\.\\/\?-]$ Required: Yes TaskFilter 870 AWS DataSync See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TaskFilter 871 AWS DataSync TaskListEntry User Guide Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination ﬁle systems to sync and the options to use for the tasks. Contents Name The name of the task. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ Required: No Status The status of the task. Type: String Valid Values: AVAILABLE \| CREATING \| QUEUED \| RUNNING \| UNAVAILABLE Required: No TaskArn The Amazon Resource Name (ARN) of the task. Type: String Length Constraints: Maximum length of 128. Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso\|aws-iso-b):datasync:[a-z \-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$ Required: No TaskListEntry 872 AWS DataSync TaskMode User Guide The task mode that you're using. For more information, see Choosing a task mode for your data transfer. Type: String Valid Values: BASIC \| ENHANCED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TaskListEntry 873 AWS DataSync TaskReportConﬁg User Guide Speciﬁes how you want to conﬁgure a task report, which provides detailed information about for your AWS DataSync transfer. For more information, see Task reports. Contents Destination Speciﬁes the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports. Type: ReportDestination object Required: No ObjectVersionIds Speciﬁes whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to
sync-dg-210	sync-dg.pdf	210	for Java V2 • AWS SDK for Ruby V3 TaskListEntry 873 AWS DataSync TaskReportConﬁg User Guide Speciﬁes how you want to conﬁgure a task report, which provides detailed information about for your AWS DataSync transfer. For more information, see Task reports. Contents Destination Speciﬁes the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports. Type: ReportDestination object Required: No ObjectVersionIds Speciﬁes whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution. Type: String Valid Values: INCLUDE \| NONE Required: No OutputType Speciﬁes the type of task report that you want: • SUMMARY_ONLY: Provides necessary details about your task, including the number of ﬁles, objects, and directories transferred and transfer duration. • STANDARD: Provides complete details about your task, including a full list of ﬁles, objects, and directories that were transferred, skipped, veriﬁed, and more. Type: String Valid Values: SUMMARY_ONLY \| STANDARD Required: No TaskReportConﬁg 874 AWS DataSync Overrides User Guide Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the ﬁles that DataSync attempted to delete in your destination location. Type: ReportOverrides object Required: No ReportLevel Speciﬁes whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. • ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete. • SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete. Type: String Valid Values: ERRORS_ONLY \| SUCCESSES_AND_ERRORS Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TaskReportConﬁg 875 AWS DataSync TaskSchedule User Guide Conﬁgures your AWS DataSync task to run on a schedule (at a minimum interval of 1 hour). Contents ScheduleExpression Speciﬁes your task schedule by using a cron or rate expression. Use cron expressions for task schedules that run on a speciﬁc time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the ﬁrst Wednesday of every month: cron(0 8 * * 3#1) Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours: rate(12 hours) For information about cron and rate expression syntax, see the Amazon EventBridge User Guide. Type: String Length Constraints: Maximum length of 256. Pattern: ^[a-zA-Z0-9\ \_\\?\,\\|\^\-\/\#\s\+]$ Required: Yes Status Speciﬁes whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to ﬁx an issue with your task or perform maintenance on your storage system. DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails. Type: String TaskSchedule 876 AWS DataSync User Guide Valid Values: ENABLED \| DISABLED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TaskSchedule 877 AWS DataSync TaskScheduleDetails Provides information about your AWS DataSync task schedule. User Guide Contents DisabledBy Indicates how your task schedule was disabled. • USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console. • SERVICE - Your schedule was automatically disabled by DataSync because the task failed repeatedly with the same error. Type: String Valid Values: USER \| SERVICE Required: No DisabledReason Provides a reason if the task schedule is disabled. If your schedule is disabled by USER, you see a Manually disabled by user. message. If your schedule is disabled by SERVICE, you see an error message to help you understand why the task keeps failing. For information on resolving DataSync errors, see Troubleshooting issues with DataSync transfers. Type: String Length Constraints: Maximum length of 8192. Pattern: ^[\w\s.,'?!:;\/=\|<>()-]*$ Required: No StatusUpdateTime Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see when the schedule was disabled. TaskScheduleDetails 878 AWS DataSync Type: Timestamp Required: No See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for
sync-dg-211	sync-dg.pdf	211	message to help you understand why the task keeps failing. For information on resolving DataSync errors, see Troubleshooting issues with DataSync transfers. Type: String Length Constraints: Maximum length of 8192. Pattern: ^[\w\s.,'?!:;\/=\|<>()-]*$ Required: No StatusUpdateTime Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see when the schedule was disabled. TaskScheduleDetails 878 AWS DataSync Type: Timestamp Required: No See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TaskScheduleDetails 879 AWS DataSync Throughput User Guide The throughput peaks for an on-premises storage system volume. Each data point represents the 95th percentile peak value during a 1-hour interval. Contents Other Peak throughput unrelated to read and write operations. Type: Double Valid Range: Minimum value of 0. Required: No Read Peak throughput related to read operations. Type: Double Valid Range: Minimum value of 0. Required: No Total Peak total throughput on your on-premises storage system resource. Type: Double Valid Range: Minimum value of 0. Required: No Write Peak throughput related to write operations. Type: Double Valid Range: Minimum value of 0. Throughput 880 AWS DataSync Required: No See Also User Guide For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. Common Errors 881 User Guide AWS DataSync HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. Common Parameters 882 AWS DataSync User Guide For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Common Parameters 883 AWS DataSync Type: string Required: Conditional X-Amz-Date User Guide The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of
sync-dg-212	sync-dg.pdf	212	authentication information in a query string instead of in the HTTP authorization header. Common Parameters 883 AWS DataSync Type: string Required: Conditional X-Amz-Date User Guide The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional Common Parameters 884 AWS DataSync X-Amz-SignedHeaders User Guide Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional Common Parameters 885 AWS DataSync User Guide Document history The following table describes important additions to the AWS DataSync documentation. We also update the documentation frequently to address feedback that you send us. To get notiﬁed about updates to this documentation, subscribe to the RSS feed. Change Description Date AWS managed policy update - Update to existing policy AWS managed policy update - Update to existing policy AWS managed policy update - Update to existing policy AWS managed policy update - Update to existing policy Performing large data migrations May 7, 2025 April 23, 2025 April 23, 2025 The AWSDataSyncFullAcc ess policy has new permissions that allow DataSync to work with AWS Secrets Manager. The AWSDataSyncFullAcc ess policy has new permissions that allow DataSync to work with AWS Secrets Manager. The AWSDataSyncFullAcc ess policy has new permissions that allow DataSync to work with AWS Secrets Manager and AWS Key Management Service. The AWSDataSyncService April 15, 2025 has new RolePolicy permissions that allow DataSync to work with AWS Secrets Manager. Learn how to plan large- scale data migrations using DataSync for transferring ﬁles or objects from on-premis February 19, 2025 886 AWS DataSync User Guide Support for Kerberos with SMB locations New AWS Region New AWS Region Update AWS storage locations No longer supporting Snowball Edge es or other cloud storage to AWS. DataSync can now use Kerberos authentication when connecting to Server Message Block (SMB) ﬁle servers. AWS DataSync is available for data transfers in the Mexico (Central) Region. AWS DataSync is available for data transfers in the Asia Paciﬁc (Thailand) Region. You can now update your Amazon S3, Amazon EFS, and Amazon FSx transfer locations . As of November 12, 2024, DataSync no longer supports AWS Snowball Edge. January 28, 2025 January 14, 2025 January 7, 2025 December 18, 2024 November 13, 2024 New AWS managed policy The DataSync service-linked October 30, 2024 Introducing Enhanced mode role named AWSServic uses eRoleForDataSync a new managed policy named AWSDataSyncService RolePolicy . With Enhanced mode, you can transfer virtually unlimited numbers of objects between Amazon S3 locations. October 30, 2024 887 AWS DataSync User Guide AWS managed policy updates - Update to an existing policy The AWSDataSyncFullAcc ess policy has a new permission for services that work with DataSync. October 30, 2024 Support for Azure storage general-purpose v1 accounts DataSync can work with Azure storage general-purpose v1 October 4, 2024 accounts when transferring to or from Microsoft Azure Blob Storage. New way to conﬁgure task schedules You can conﬁgure your DataSync task schedules by August 22, 2024 New AWS Region using rate expressions. AWS DataSync is available for data transfers in the Asia Paciﬁc (Malaysia) Region. August 21, 2024 Support for agentless cross- Region transfers that include You no longer need a DataSync agent for transfers July 24, 2024 an opt-in Region between AWS storage AWS managed policy updates - Update to an existing policy Updated S3 cross-account tutorial services when at least one storage location is in an opt- in AWS Region. The AWSDataSyncFullAcc ess policy has a
sync-dg-213	sync-dg.pdf	213	Storage. New way to conﬁgure task schedules You can conﬁgure your DataSync task schedules by August 22, 2024 New AWS Region using rate expressions. AWS DataSync is available for data transfers in the Asia Paciﬁc (Malaysia) Region. August 21, 2024 Support for agentless cross- Region transfers that include You no longer need a DataSync agent for transfers July 24, 2024 an opt-in Region between AWS storage AWS managed policy updates - Update to an existing policy Updated S3 cross-account tutorial services when at least one storage location is in an opt- in AWS Region. The AWSDataSyncFullAcc ess policy has a new permission for services that work with DataSync. Removed some source account user permissions that are no longer required for this transfer. July 22, 2024 June 10, 2024 888 AWS DataSync User Guide New task execution status The CANCELLING status indicates when a task execution is being cancelled. May 15, 2024 New option for pausing task schedules You can disable your AWS DataSync task schedule when April 24, 2024 you need to troubleshoot issues or perform storage system maintenance. Updated TLS cipher for FIPS endpoints AWS DataSync uses the TLS_AES_128_GCM_SH April 22, 2024 AWS managed policy updates - Update to an existing policy A256 (secp256r1) cipher for Federal Information Processin g Standard (FIPS) service endpoints. The AWSDataSyncFullAcc ess policy has a new permission for services that work with DataSync. February 16, 2024 Transfer speciﬁc ﬁles or objects with a manifest AWS DataSync can transfer a list of ﬁles or objects by using February 7, 2024 New AWS Region Support for transfers with additional cloud providers a manifest. AWS DataSync is now available for data transfers in the Canada West (Calgary) Region. AWS DataSync can now transfer data between AWS storage services and IBM Cloud Object Storage or Seagate Lyve Cloud. December 20, 2023 November 7, 2023 889 AWS DataSync User Guide Support for transfers with Alibaba Cloud Object Storage AWS DataSync can now transfer data between AWS September 25, 2023 Service storage services and Alibaba Cloud Object Storage Service. Support for task reports Monitor your AWS DataSync transfers with task reports. August 30, 2023 New AWS Region Support for transfers with additional cloud providers August 23, 2023 August 8, 2023 AWS DataSync is now available for data transfers in the Israel (Tel Aviv) Region. AWS DataSync can now transfer data between AWS storage services and several other cloud providers (such as Wasabi Cloud Storage, DigitalOcean Spaces, and Oracle Cloud Infrastructure Object Storage). General availability of Microsoft Azure Blob Storage AWS DataSync can now transfer objects to and from July 25, 2023 support Microsoft Azure Blob Storage. TLS 1.3 support New DataSync Discovery metrics June 28, 2023 June 28, 2023 When transferring between storage locations, AWS DataSync now encrypts all network traﬃc with Transport Layer Security (TLS) 1.3. AWS DataSync Discovery can now tell you how many LUNs (logical unit numbers) are in a storage resource cluster, storage virtual machine (SVM), or volume. 890 AWS DataSync New AWS Region Support for with S3 compatible storage on Snowball Edge AWS managed policy updates - Update to an existing policy AWS DataSync is now available for data transfers in the Asia Paciﬁc (Melbourne) Region. You can use AWS DataSync to transfer data between Amazon S3 compatible storage on AWS Snowball Edge and AWS storage services. The AWSDataSyncFullAcc ess policy has new permissions for services that work with DataSync. May 24, 2023 May 18, 2023 May 2, 2023 General availability of AWS DataSync Discovery Use DataSync Discovery to help accelerate your April 25, 2023 migration to AWS. Public preview release of Microsoft Azure Blob Storage AWS DataSync can now transfer objects from support Microsoft Azure Blob Storage. March 29, 2023 New IAM policy New AWS Regions March 21, 2023 February 6, 2023 To support the DataSync Discovery feature, DataSync uses the service-linked role named AWSServic eRoleForDataSyncDi scovery . AWS DataSync is now available in the following AWS Regions: Asia Paciﬁc (Hyderabad), Europe (Spain), and Europe (Zurich). User Guide 891 AWS DataSync User Guide Using tags in task executions You can now tag your AWS DataSync task executions. December 16, 2022 Support for S3 Glacier Instant Retrieval You can now transfer objects directly into the S3 Glacier December 16, 2022 Copying object system metadata New AWS Regions New AWS Region Instant Retrieval storage class. AWS DataSync can now copy system metadata when transferring between an object storage system and Amazon S3. AWS DataSync is now available in the China (Beijing) and China (Ningxia) Regions. AWS DataSync is now available in the Middle East (UAE) Region. December 16, 2022 December 14, 2022 November 16, 2022 Support for self-signed certiﬁcates with object AWS DataSync can connect to object storage locations storage locations that use self-signed or private October 25, 2022 Get data compression information Public preview release
sync-dg-214	sync-dg.pdf	214	S3 Glacier December 16, 2022 Copying object system metadata New AWS Regions New AWS Region Instant Retrieval storage class. AWS DataSync can now copy system metadata when transferring between an object storage system and Amazon S3. AWS DataSync is now available in the China (Beijing) and China (Ningxia) Regions. AWS DataSync is now available in the Middle East (UAE) Region. December 16, 2022 December 14, 2022 November 16, 2022 Support for self-signed certiﬁcates with object AWS DataSync can connect to object storage locations storage locations that use self-signed or private October 25, 2022 Get data compression information Public preview release of AWS DataSync Discovery certiﬁcates. AWS DataSync can provide the physical number of bytes transferred over the network after compression was applied. Use DataSync Discovery to help accelerate your migration to AWS. October 25, 2022 September 21, 2022 892 AWS DataSync User Guide New option for migrating data to or from Google Cloud You can transfer data to or from Google Cloud July 21, 2022 Storage Storage by deploying an AWS DataSync agent in Google Cloud. Support for Amazon FSx for NetApp ONTAP ﬁle systems AWS DataSync can now transfer ﬁles and folders to June 28, 2022 and from FSx for ONTAP ﬁle systems. New security options for Amazon EFS locations AWS DataSync can access Amazon EFS ﬁle systems May 31, 2022 using TLS, access points, and IAM roles. Migrating data to or from Google Cloud Storage and With AWS DataSync, you can transfer data to or May 24, 2022 Azure Files New AWS DataSync task setting New AWS Region from Google Cloud Storage and Azure Files. For more information, see Creating a location for object storage and Creating a location for SMB. With the Copy object tags option, you can specify whether to maintain object tags when transferring between object storage systems. AWS DataSync is now available in the Asia Paciﬁc (Jakarta) Region. May 5, 2022 April 19, 2022 893 AWS DataSync User Guide Support for Amazon FSx for OpenZFS ﬁle systems AWS DataSync can now transfer ﬁles and folders to April 5, 2022 and from FSx for OpenZFS ﬁle systems. Support for Amazon FSx for Lustre ﬁle systems AWS DataSync can now transfer ﬁles and folders to December 10, 2021 and from FSx for Lustre ﬁle systems. Support for Hadoop Distribut ed File Systems (HDFS) AWS DataSync now supports transferring ﬁles and folders November 3, 2021 New AWS Region to and from HDFS clusters. AWS DataSync is now available in the Asia Paciﬁc (Osaka) Region. July 28, 2021 Fully automated transfers between AWS storage AWS DataSync can now transfer ﬁles or objects November 9, 2020 services between Amazon S3, Amazon EFS, or FSx for Windows File Server with just a few clicks in the DataSync console. Adjusting the network bandwidth used by a running AWS DataSync now enables customers to adjust the November 9, 2020 task network bandwidth used by a running DataSync task. This helps to minimize impact on other users or applications when a task spans multiple days. 894 AWS DataSync User Guide Enhanced support for on- premises DataSync virtual The AWS DataSync agent VM host console now supports machine (VM) functions enhanced functions, including October 19, 2020 activating an agent from the local console. AWS DataSync can now transfer data to and from AWS Outposts DataSync now supports transferring objects to and from Amazon S3 on AWS Outposts. September 30, 2020 Support for API ﬁltering AWS DataSync now supports August 18, 2020 ﬁltering for the ListTasks and ListLocations API calls, enabling you to easily retrieve conﬁguration of data transfer tasks by using ﬁlters such as the source or destinati on for the data transfer. Support for copying data from your self-managed AWS DataSync now supports data transfer between self- July 27, 2020 object storage Support for Linux Kernel-ba sed Virtual Machine (KVM) and Microsoft Hyper-V hypervisors managed object storage and Amazon S3, Amazon Elastic File System, or FSx for Windows File Server. AWS DataSync now provides the ability to deploy on- premises agents on the KVM and Microsoft Hyper- V virtualization platforms , in addition to the existing VMware and Amazon EC2 options. July 1, 2020 895 AWS DataSync User Guide AWS DataSync can now automatically conﬁgure your When using DataSync, you now have the option of July 1, 2020 Amazon CloudWatch Logs automatically generating the conﬁguration CloudWatch log group and resource policy required to publish logs for your data transfer, simplifying task creation and monitoring setup. AWS DataSync can now transfer data to and from DataSync now supports transferring ﬁles to and AWS Snowball Edge from AWS Snowball Edge, June 17, 2020 the smallest member of the AWS Snow Family of edge computing and data transfer devices. Snowball Edge is portable, ruggedized, and secure—small and light enough to ﬁt in a backpack and able
sync-dg-215	sync-dg.pdf	215	automatically conﬁgure your When using DataSync, you now have the option of July 1, 2020 Amazon CloudWatch Logs automatically generating the conﬁguration CloudWatch log group and resource policy required to publish logs for your data transfer, simplifying task creation and monitoring setup. AWS DataSync can now transfer data to and from DataSync now supports transferring ﬁles to and AWS Snowball Edge from AWS Snowball Edge, June 17, 2020 the smallest member of the AWS Snow Family of edge computing and data transfer devices. Snowball Edge is portable, ruggedized, and secure—small and light enough to ﬁt in a backpack and able to withstand harsh environments. AWS DataSync is now available in the Africa (Cape Town) Region and the Europe (Milan) Region. You can now enable detailed logging for ﬁles and objects copied between your NFS servers, SMB servers, Amazon S3 buckets, Amazon EFS ﬁle systems, and FSx for Windows File Server ﬁle systems. June 16, 2020 April 24, 2020 New AWS Region Enhanced monitoring capabilities with ﬁle-level logging 896 AWS DataSync User Guide Support for copying data between your SMB share and You can now copy data between your SMB share and Amazon FSx for Windows File FSx for Windows File Server. January 24, 2020 Server Support for scheduling tasks New AWS Region New AWS Region November 20, 2019 November 20, 2019 October 2, 2019 You can now run tasks manually or schedule them to run based on a speciﬁed schedule. AWS DataSync is now available in the Asia Paciﬁc (Hong Kong) Region, Asia Paciﬁc (Mumbai) Region, Europe (Stockholm) Region, South America (São Paulo) Region, and AWS GovCloud (US-East) Region. AWS DataSync is now available in the Canada (Central) Region, Europe (London) Region, and Europe (Paris) Region. Support for Amazon S3 storage classes You can now transfer objects directly into Amazon S3 September 24, 2019 New AWS Region storage classes. AWS DataSync is now available in the Middle East (Bahrain) Region. Support for copying data between your Server Message Block (SMB) share and Amazon S3 or Amazon EFS You can now copy data between your SMB ﬁle share and Amazon S3 or Amazon EFS. August 28, 2019 August 22, 2019 897 AWS DataSync User Guide Support for using virtual private cloud (VPC) endpoints You can now create a private connection between your August 5, 2019 agent and AWS and run tasks in a private network. Doing this increases the security of your data as it's copied over the network. Support for Federal Informati on Processing Standard (FIPS) You can now use FIPS endpoints to create agents August 5, 2019 endpoints and run tasks. New AWS Region Support for ﬁltering June 11, 2019 May 22, 2019 AWS DataSync is now available in the AWS GovCloud (US-West) Region. You can now apply ﬁlters to transfer only a subset of the ﬁles in your source location when you transfer data from your source to your destinati on location. First release of AWS DataSync General release of the AWS DataSync service. November 26, 2018 898 AWS DataSync User Guide AWS Glossary For the latest AWS terminology, see the AWS glossary in the AWS Glossary Reference. 899
Synthetics-APIReference-001	Synthetics-APIReference.pdf	1	Welcome Amazon CloudWatch Synthetics API Version 2017-10-11 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon CloudWatch Synthetics Welcome Amazon CloudWatch Synthetics: Welcome Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon CloudWatch Synthetics Table of Contents Welcome Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 AssociateResource ......................................................................................................................................... 3 Request Syntax ........................................................................................................................................ 3 URI Request Parameters ........................................................................................................................ 3 Request Body ........................................................................................................................................... 3 Response Syntax ...................................................................................................................................... 4 Response Elements ................................................................................................................................. 4 Errors .......................................................................................................................................................... 4 See Also ..................................................................................................................................................... 5 CreateCanary ................................................................................................................................................. 6 Request Syntax ........................................................................................................................................ 6 URI Request Parameters ........................................................................................................................ 7 Request Body ........................................................................................................................................... 7 Response Syntax ................................................................................................................................... 12 Response Elements ............................................................................................................................... 13 Errors ....................................................................................................................................................... 14 See Also .................................................................................................................................................. 14 CreateGroup ................................................................................................................................................. 16 Request Syntax ...................................................................................................................................... 16 URI Request Parameters ...................................................................................................................... 16 Request Body ......................................................................................................................................... 16 Response Syntax ................................................................................................................................... 17 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 18 See Also .................................................................................................................................................. 19 DeleteCanary ............................................................................................................................................... 20 Request Syntax ...................................................................................................................................... 20 URI Request Parameters ...................................................................................................................... 20 Request Body ......................................................................................................................................... 21 Response Syntax ................................................................................................................................... 21 Response Elements ............................................................................................................................... 21 Errors ....................................................................................................................................................... 21 See Also .................................................................................................................................................. 22 API Version 2017-10-11 iii Amazon CloudWatch Synthetics Welcome DeleteGroup ................................................................................................................................................ 23 Request Syntax ...................................................................................................................................... 23 URI Request Parameters ...................................................................................................................... 23 Request Body ......................................................................................................................................... 23 Response Syntax ................................................................................................................................... 23 Response Elements ............................................................................................................................... 23 Errors ....................................................................................................................................................... 23 See Also .................................................................................................................................................. 24 DescribeCanaries ......................................................................................................................................... 25 Request Syntax ...................................................................................................................................... 25 URI Request Parameters ...................................................................................................................... 25 Request Body ......................................................................................................................................... 25 Response Syntax ................................................................................................................................... 26 Response Elements ............................................................................................................................... 28 Errors ....................................................................................................................................................... 29 See Also .................................................................................................................................................. 29 DescribeCanariesLastRun .......................................................................................................................... 30 Request Syntax ...................................................................................................................................... 30 URI Request Parameters ...................................................................................................................... 30 Request Body ......................................................................................................................................... 30 Response Syntax ................................................................................................................................... 31 Response Elements ............................................................................................................................... 32 Errors ....................................................................................................................................................... 33 See Also .................................................................................................................................................. 33 DescribeRuntimeVersions .......................................................................................................................... 34 Request Syntax ...................................................................................................................................... 34 URI Request Parameters ...................................................................................................................... 34 Request Body ......................................................................................................................................... 34 Response Syntax ................................................................................................................................... 35 Response Elements ............................................................................................................................... 35 Errors ....................................................................................................................................................... 36 See Also .................................................................................................................................................. 36 DisassociateResource ................................................................................................................................. 37 Request Syntax ...................................................................................................................................... 37 URI Request Parameters ...................................................................................................................... 37 Request Body ......................................................................................................................................... 37 API Version 2017-10-11 iv Amazon CloudWatch Synthetics Welcome Response Syntax ................................................................................................................................... 38 Response Elements ............................................................................................................................... 38 Errors ....................................................................................................................................................... 38 See Also .................................................................................................................................................. 38 GetCanary .................................................................................................................................................... 40 Request Syntax ...................................................................................................................................... 40 URI Request Parameters ...................................................................................................................... 40 Request Body ......................................................................................................................................... 40 Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 42 Errors ....................................................................................................................................................... 42 See Also .................................................................................................................................................. 43 GetCanaryRuns ............................................................................................................................................ 44 Request Syntax ...................................................................................................................................... 44 URI Request Parameters ...................................................................................................................... 44 Request Body ......................................................................................................................................... 44 Response Syntax ................................................................................................................................... 45 Response Elements ............................................................................................................................... 46 Errors ....................................................................................................................................................... 47 See Also .................................................................................................................................................. 47 GetGroup ...................................................................................................................................................... 48 Request Syntax ...................................................................................................................................... 48 URI Request Parameters ...................................................................................................................... 48 Request Body ......................................................................................................................................... 48 Response Syntax ................................................................................................................................... 48 Response Elements ............................................................................................................................... 49 Errors ....................................................................................................................................................... 49 See Also .................................................................................................................................................. 50 ListAssociatedGroups ................................................................................................................................. 51 Request Syntax ...................................................................................................................................... 51 URI Request Parameters ...................................................................................................................... 51 Request Body ......................................................................................................................................... 51 Response Syntax ................................................................................................................................... 52 Response Elements ............................................................................................................................... 52 Errors ....................................................................................................................................................... 53 See Also .................................................................................................................................................. 53 API Version 2017-10-11 v Amazon CloudWatch Synthetics Welcome ListGroupResources .................................................................................................................................... 55 Request Syntax ...................................................................................................................................... 55 URI Request Parameters ...................................................................................................................... 55 Request Body ......................................................................................................................................... 55 Response Syntax ................................................................................................................................... 56 Response Elements ............................................................................................................................... 56 Errors ....................................................................................................................................................... 57 See Also .................................................................................................................................................. 57 ListGroups .................................................................................................................................................... 59 Request Syntax ...................................................................................................................................... 59 URI Request Parameters ...................................................................................................................... 59 Request Body ......................................................................................................................................... 59 Response Syntax ................................................................................................................................... 60 Response Elements ............................................................................................................................... 60 Errors ....................................................................................................................................................... 61 See Also .................................................................................................................................................. 61 ListTagsForResource ................................................................................................................................... 62 Request Syntax ...................................................................................................................................... 62 URI Request Parameters ...................................................................................................................... 62 Request Body ......................................................................................................................................... 62 Response Syntax ................................................................................................................................... 62 Response Elements ............................................................................................................................... 63 Errors ....................................................................................................................................................... 63 See Also .................................................................................................................................................. 64 StartCanary .................................................................................................................................................. 65 Request Syntax ...................................................................................................................................... 65 URI Request Parameters ...................................................................................................................... 65 Request Body ......................................................................................................................................... 65 Response Syntax ................................................................................................................................... 65 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 65 See Also .................................................................................................................................................. 66 StartCanaryDryRun .................................................................................................................................... 67 Request Syntax ...................................................................................................................................... 67 URI Request Parameters ...................................................................................................................... 68 Request Body ......................................................................................................................................... 68 API Version 2017-10-11 vi Amazon CloudWatch Synthetics Welcome Response Syntax ................................................................................................................................... 71 Response Elements ............................................................................................................................... 72 Errors ....................................................................................................................................................... 72 See Also .................................................................................................................................................. 73 StopCanary .................................................................................................................................................. 74 Request Syntax ...................................................................................................................................... 74 URI Request Parameters ...................................................................................................................... 74 Request Body ......................................................................................................................................... 74 Response Syntax ................................................................................................................................... 74 Response Elements ............................................................................................................................... 74 Errors ....................................................................................................................................................... 75 See Also .................................................................................................................................................. 75 TagResource ................................................................................................................................................. 77 Request Syntax ...................................................................................................................................... 77 URI Request Parameters ...................................................................................................................... 77 Request Body ......................................................................................................................................... 78 Response Syntax ................................................................................................................................... 78 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 78 See Also .................................................................................................................................................. 79 UntagResource ............................................................................................................................................ 81 Request Syntax ...................................................................................................................................... 81 URI Request Parameters ...................................................................................................................... 81 Request Body ......................................................................................................................................... 82 Response Syntax ................................................................................................................................... 82 Response Elements ............................................................................................................................... 82 Errors .......................................................................................................................................................
Synthetics-APIReference-002	Synthetics-APIReference.pdf	2	71 Response Elements ............................................................................................................................... 72 Errors ....................................................................................................................................................... 72 See Also .................................................................................................................................................. 73 StopCanary .................................................................................................................................................. 74 Request Syntax ...................................................................................................................................... 74 URI Request Parameters ...................................................................................................................... 74 Request Body ......................................................................................................................................... 74 Response Syntax ................................................................................................................................... 74 Response Elements ............................................................................................................................... 74 Errors ....................................................................................................................................................... 75 See Also .................................................................................................................................................. 75 TagResource ................................................................................................................................................. 77 Request Syntax ...................................................................................................................................... 77 URI Request Parameters ...................................................................................................................... 77 Request Body ......................................................................................................................................... 78 Response Syntax ................................................................................................................................... 78 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 78 See Also .................................................................................................................................................. 79 UntagResource ............................................................................................................................................ 81 Request Syntax ...................................................................................................................................... 81 URI Request Parameters ...................................................................................................................... 81 Request Body ......................................................................................................................................... 82 Response Syntax ................................................................................................................................... 82 Response Elements ............................................................................................................................... 82 Errors ....................................................................................................................................................... 82 See Also .................................................................................................................................................. 83 UpdateCanary .............................................................................................................................................. 84 Request Syntax ...................................................................................................................................... 84 URI Request Parameters ...................................................................................................................... 85 Request Body ......................................................................................................................................... 86 Response Syntax ................................................................................................................................... 89 Response Elements ............................................................................................................................... 90 Errors ....................................................................................................................................................... 90 See Also .................................................................................................................................................. 91 API Version 2017-10-11 vii Amazon CloudWatch Synthetics Welcome Data Types ..................................................................................................................................... 92 ArtifactConﬁgInput .................................................................................................................................... 94 Contents .................................................................................................................................................. 94 See Also .................................................................................................................................................. 94 ArtifactConﬁgOutput ................................................................................................................................. 95 Contents .................................................................................................................................................. 95 See Also .................................................................................................................................................. 95 BaseScreenshot ........................................................................................................................................... 96 Contents .................................................................................................................................................. 96 See Also .................................................................................................................................................. 96 Canary ........................................................................................................................................................... 98 Contents .................................................................................................................................................. 98 See Also ................................................................................................................................................ 102 CanaryCodeInput ...................................................................................................................................... 103 Contents ............................................................................................................................................... 103 See Also ................................................................................................................................................ 104 CanaryCodeOutput .................................................................................................................................. 106 Contents ............................................................................................................................................... 106 See Also ................................................................................................................................................ 106 CanaryDryRunConﬁgOutput .................................................................................................................. 107 Contents ............................................................................................................................................... 107 See Also ................................................................................................................................................ 107 CanaryLastRun .......................................................................................................................................... 108 Contents ............................................................................................................................................... 108 See Also ................................................................................................................................................ 108 CanaryRun ................................................................................................................................................. 109 Contents ............................................................................................................................................... 109 See Also ................................................................................................................................................ 110 CanaryRunConﬁgInput ............................................................................................................................ 111 Contents ............................................................................................................................................... 111 See Also ................................................................................................................................................ 112 CanaryRunConﬁgOutput ........................................................................................................................ 113 Contents ............................................................................................................................................... 113 See Also ................................................................................................................................................ 113 CanaryRunStatus ...................................................................................................................................... 115 Contents ............................................................................................................................................... 115 API Version 2017-10-11 viii Amazon CloudWatch Synthetics Welcome See Also ................................................................................................................................................ 115 CanaryRunTimeline .................................................................................................................................. 117 Contents ............................................................................................................................................... 117 See Also ................................................................................................................................................ 117 CanaryScheduleInput .............................................................................................................................. 118 Contents ............................................................................................................................................... 118 See Also ................................................................................................................................................ 119 CanaryScheduleOutput ........................................................................................................................... 120 Contents ............................................................................................................................................... 120 See Also ................................................................................................................................................ 121 CanaryStatus ............................................................................................................................................. 122 Contents ............................................................................................................................................... 122 See Also ................................................................................................................................................ 122 CanaryTimeline ......................................................................................................................................... 124 Contents ............................................................................................................................................... 124 See Also ................................................................................................................................................ 124 DryRunConﬁgOutput ............................................................................................................................... 126 Contents ............................................................................................................................................... 126 See Also ................................................................................................................................................ 126 Group .......................................................................................................................................................... 127 Contents ............................................................................................................................................... 127 See Also ................................................................................................................................................ 128 GroupSummary ........................................................................................................................................ 129 Contents ............................................................................................................................................... 129 See Also ................................................................................................................................................ 129 RuntimeVersion ........................................................................................................................................ 131 Contents ............................................................................................................................................... 131 See Also ................................................................................................................................................ 132 S3EncryptionConﬁg ................................................................................................................................. 133 Contents ............................................................................................................................................... 133 See Also ................................................................................................................................................ 133 VisualReferenceInput ............................................................................................................................... 135 Contents ............................................................................................................................................... 135 See Also ................................................................................................................................................ 135 VisualReferenceOutput ........................................................................................................................... 137 Contents ............................................................................................................................................... 137 API Version 2017-10-11 ix Amazon CloudWatch Synthetics Welcome See Also ................................................................................................................................................ 137 VpcConﬁgInput ......................................................................................................................................... 138 Contents ............................................................................................................................................... 138 See Also ................................................................................................................................................ 138 VpcConﬁgOutput ..................................................................................................................................... 140 Contents ............................................................................................................................................... 140 See Also ................................................................................................................................................ 141 Common Parameters ................................................................................................................... 142 Common Errors ............................................................................................................................ 145 API Version 2017-10-11 x Amazon CloudWatch Synthetics Welcome Welcome You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries, which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications in the Amazon CloudWatch User Guide. Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries. This document was last published on May 14, 2025. API Version 2017-10-11 1 Amazon CloudWatch Synthetics Welcome Actions The following actions are supported: • AssociateResource • CreateCanary • CreateGroup • DeleteCanary • DeleteGroup • DescribeCanaries • DescribeCanariesLastRun • DescribeRuntimeVersions • DisassociateResource • GetCanary • GetCanaryRuns • GetGroup • ListAssociatedGroups • ListGroupResources • ListGroups • ListTagsForResource • StartCanary • StartCanaryDryRun • StopCanary • TagResource • UntagResource • UpdateCanary API Version 2017-10-11 2 Amazon CloudWatch Synthetics AssociateResource Welcome Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group. You must run this operation in the Region where the canary exists. Request Syntax PATCH /group/groupIdentifier/associate HTTP/1.1 Content-type: application/json { "ResourceArn": "string" } URI Request Parameters The request uses the following URI parameters. groupIdentiﬁer Speciﬁes the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request accepts the following data in JSON format. ResourceArn The ARN of the canary that you want to associate with the speciﬁed group. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. AssociateResource API Version 2017-10-11 3 Amazon CloudWatch Synthetics Welcome Pattern: arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+- \d{1}:\d{12}:canary:[0-9a-z_\-]{1,255} Required: Yes Response
Synthetics-APIReference-003	Synthetics-APIReference.pdf	3	Content-type: application/json { "ResourceArn": "string" } URI Request Parameters The request uses the following URI parameters. groupIdentiﬁer Speciﬁes the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request accepts the following data in JSON format. ResourceArn The ARN of the canary that you want to associate with the speciﬁed group. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. AssociateResource API Version 2017-10-11 3 Amazon CloudWatch Synthetics Welcome Pattern: arn:(aws[a-zA-Z-])?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+- \d{1}:\d{12}:canary:[0-9a-z_\-]{1,255} Required: Yes Response Syntax HTTP/1.1 200 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. ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ServiceQuotaExceededException The request exceeded a service quota value. HTTP Status Code: 402 ValidationException A parameter could not be validated. Response Syntax API Version 2017-10-11 4 Amazon CloudWatch Synthetics HTTP Status Code: 400 See Also Welcome For more information about using this API in one of the language-speciﬁc 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 2017-10-11 5 Amazon CloudWatch Synthetics CreateCanary Welcome Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside- in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once. Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead. To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries. Request Syntax POST /canary HTTP/1.1 Content-type: application/json { "ArtifactConfig": { "S3Encryption": { "EncryptionMode": "string", "KmsKeyArn": "string" } }, "ArtifactS3Location": "string", "Code": { "Handler": "string", "S3Bucket": "string", "S3Key": "string", "S3Version": "string", "ZipFile": blob }, "ExecutionRoleArn": "string", "FailureRetentionPeriodInDays": number, "Name": "string", CreateCanary API Version 2017-10-11 6 Amazon CloudWatch Synthetics Welcome "ProvisionedResourceCleanup": "string", "ResourcesToReplicateTags": [ "string" ], "RunConfig": { "ActiveTracing": boolean, "EnvironmentVariables": { "string" : "string" }, "MemoryInMB": number, "TimeoutInSeconds": number }, "RuntimeVersion": "string", "Schedule": { "DurationInSeconds": number, "Expression": "string" }, "SuccessRetentionPeriodInDays": number, "Tags": { "string" : "string" }, "VpcConfig": { "Ipv6AllowedForDualStack": boolean, "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ArtifactConﬁg A structure that contains the conﬁguration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Type: ArtifactConﬁgInput object Required: No URI Request Parameters API Version 2017-10-11 7 Amazon CloudWatch Synthetics ArtifactS3Location Welcome The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log ﬁle, screenshots, and HAR ﬁles. The name of the S3 bucket can't include a period (.). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes Code A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. Type: CanaryCodeInput object Required: Yes ExecutionRoleArn The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions: • s3:PutObject • s3:GetBucketLocation • s3:ListAllMyBuckets • cloudwatch:PutMetricData • logs:CreateLogGroup • logs:CreateLogStream • logs:PutLogEvents Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ Required: Yes Request Body API Version 2017-10-11 8 Amazon CloudWatch Synthetics FailureRetentionPeriodInDays Welcome The number of days to retain data about failed runs of this canary. If you omit this ﬁeld, the default of 31 days is used. The valid range
Synthetics-APIReference-004	Synthetics-APIReference.pdf	4	to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions: • s3:PutObject • s3:GetBucketLocation • s3:ListAllMyBuckets • cloudwatch:PutMetricData • logs:CreateLogGroup • logs:CreateLogStream • logs:PutLogEvents Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ Required: Yes Request Body API Version 2017-10-11 8 Amazon CloudWatch Synthetics FailureRetentionPeriodInDays Welcome The number of days to retain data about failed runs of this canary. If you omit this ﬁeld, the default of 31 days is used. The valid range is 1 to 455 days. This setting aﬀects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1024. Required: No Name The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: Yes ProvisionedResourceCleanup Speciﬁes whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted. Type: String Valid Values: AUTOMATIC \| OFF Request Body API Version 2017-10-11 9 Amazon CloudWatch Synthetics Required: No ResourcesToReplicateTags Welcome To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function. If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails. Type: Array of strings Array Members: Fixed number of 1 item. Valid Values: lambda-function Required: No RunConﬁg A structure that contains the conﬁguration for individual canary runs, such as timeout value and environment variables. Important Environment variable keys and values are encrypted at rest using AWS owned AWS KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them. Type: CanaryRunConﬁgInput object Required: No RuntimeVersion Speciﬁes the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes Request Body API Version 2017-10-11 10 Amazon CloudWatch Synthetics Schedule Welcome A structure that contains information about how often the canary is to run and when these test runs are to stop. Type: CanaryScheduleInput object Required: Yes SuccessRetentionPeriodInDays The number of days to retain data about successful runs of this canary. If you omit this ﬁeld, the default of 31 days is used. The valid range is 1 to 455 days. This setting aﬀects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1024. Required: No Tags A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values. To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Required: No Request Body API Version 2017-10-11 11 Amazon CloudWatch Synthetics VpcConﬁg Welcome If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. Type: VpcConﬁgInput object Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Canary": { "ArtifactConfig": { "S3Encryption": { "EncryptionMode": "string", "KmsKeyArn": "string" } }, "ArtifactS3Location": "string", "Code": { "Handler": "string", "SourceLocationArn": "string" }, "DryRunConfig": { "DryRunId": "string", "LastDryRunExecutionStatus": "string" }, "EngineArn": "string", "ExecutionRoleArn": "string", "FailureRetentionPeriodInDays": number, "Id": "string", "Name": "string",
Synthetics-APIReference-005	Synthetics-APIReference.pdf	5	of 256. Required: No Request Body API Version 2017-10-11 11 Amazon CloudWatch Synthetics VpcConﬁg Welcome If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. Type: VpcConﬁgInput object Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Canary": { "ArtifactConfig": { "S3Encryption": { "EncryptionMode": "string", "KmsKeyArn": "string" } }, "ArtifactS3Location": "string", "Code": { "Handler": "string", "SourceLocationArn": "string" }, "DryRunConfig": { "DryRunId": "string", "LastDryRunExecutionStatus": "string" }, "EngineArn": "string", "ExecutionRoleArn": "string", "FailureRetentionPeriodInDays": number, "Id": "string", "Name": "string", "ProvisionedResourceCleanup": "string", "RunConfig": { "ActiveTracing": boolean, "MemoryInMB": number, "TimeoutInSeconds": number Response Syntax API Version 2017-10-11 12 Amazon CloudWatch Synthetics Welcome }, "RuntimeVersion": "string", "Schedule": { "DurationInSeconds": number, "Expression": "string" }, "Status": { "State": "string", "StateReason": "string", "StateReasonCode": "string" }, "SuccessRetentionPeriodInDays": number, "Tags": { "string" : "string" }, "Timeline": { "Created": number, "LastModified": number, "LastStarted": number, "LastStopped": number }, "VisualReference": { "BaseCanaryRunId": "string", "BaseScreenshots": [ { "IgnoreCoordinates": [ "string" ], "ScreenshotName": "string" } ] }, "VpcConfig": { "Ipv6AllowedForDualStack": boolean, "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcId": "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Elements API Version 2017-10-11 13 Amazon CloudWatch Synthetics Welcome The following data is returned in JSON format by the service. Canary The full details about the canary you have created. Type: Canary object Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An unknown internal error occurred. HTTP Status Code: 500 RequestEntityTooLargeException One of the input resources is larger than is allowed. HTTP Status Code: 413 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 14 Amazon CloudWatch Synthetics • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 15 Amazon CloudWatch Synthetics CreateGroup Welcome Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group. Groups are global resources. When you create a group, it is replicated across AWS Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reﬂects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view. Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region. Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups. Request Syntax POST /group HTTP/1.1 Content-type: application/json { "Name": "string", "Tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. Name The name for the group. It can include any Unicode characters. CreateGroup API Version 2017-10-11 16 Amazon CloudWatch Synthetics Welcome The names for all groups in your account, across all Regions, must be unique. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes Tags A list of key-value pairs to associate with the group. You can associate as many as 50 tags with a group. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Group": { "Arn": "string", "CreatedTime": number, "Id": "string", "LastModifiedTime": number, "Name": "string", "Tags": { "string" : "string" Response Syntax API Version 2017-10-11 17 Amazon CloudWatch Synthetics Welcome } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is
Synthetics-APIReference-006	Synthetics-APIReference.pdf	6	change only the resources that have certain tag values. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Group": { "Arn": "string", "CreatedTime": number, "Id": "string", "LastModifiedTime": number, "Name": "string", "Tags": { "string" : "string" Response Syntax API Version 2017-10-11 17 Amazon CloudWatch Synthetics Welcome } } } 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. Group A structure that contains information about the group that was just created. Type: Group object Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ServiceQuotaExceededException The request exceeded a service quota value. HTTP Status Code: 402 ValidationException A parameter could not be validated. HTTP Status Code: 400 Response Elements API Version 2017-10-11 18 Amazon CloudWatch Synthetics See Also Welcome For more information about using this API in one of the language-speciﬁc 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 2017-10-11 19 Amazon CloudWatch Synthetics DeleteCanary Permanently deletes the speciﬁed canary. Welcome If the canary's ProvisionedResourceCleanup ﬁeld is set to AUTOMATIC or you specify DeleteLambda in this operation as true, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary. Other resources used and created by the canary are not automatically deleted. After you delete a canary, you should also delete the following: • The CloudWatch alarms created for this canary. These alarms have a name of Synthetics- Alarm-first-198-characters-of-canary-name-canaryId-alarm number • Amazon S3 objects and buckets, such as the canary's artifact location. • IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-First-21-Characters-of- CanaryName • CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/ lambda/cwsyn-First-21-Characters-of-CanaryName Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary. Request Syntax DELETE /canary/name?deleteLambda=DeleteLambda HTTP/1.1 URI Request Parameters The request uses the following URI parameters. DeleteLambda Speciﬁes whether to also delete the Lambda functions and layers used by this canary. The default is false. DeleteCanary API Version 2017-10-11 20 Amazon CloudWatch Synthetics Welcome Your setting for this parameter is used only if the canary doesn't have AUTOMATIC for its ProvisionedResourceCleanup ﬁeld. If that ﬁeld is set to AUTOMATIC, then the Lambda functions and layers will be deleted when this canary is deleted. Type: Boolean name The name of the canary that you want to delete. To ﬁnd the names of your canaries, use DescribeCanaries. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 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. ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. Request Body API Version 2017-10-11 21 Welcome Amazon CloudWatch Synthetics HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 22 Amazon CloudWatch Synthetics DeleteGroup Welcome Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group. Groups are a global resource that appear in all Regions, but the request to delete a group must
Synthetics-APIReference-007	Synthetics-APIReference.pdf	7	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 2017-10-11 22 Amazon CloudWatch Synthetics DeleteGroup Welcome Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group. Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can ﬁnd the home Region of a group within its ARN. Request Syntax DELETE /group/groupIdentifier HTTP/1.1 URI Request Parameters The request uses the following URI parameters. groupIdentiﬁer Speciﬁes which group to delete. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 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. DeleteGroup API Version 2017-10-11 23 Welcome Amazon CloudWatch Synthetics ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 24 Amazon CloudWatch Synthetics DescribeCanaries Welcome This operation returns a list of the canaries in your account, along with full details about each canary. This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing speciﬁc canaries. Request Syntax POST /canaries HTTP/1.1 Content-type: application/json { "MaxResults": number, "Names": [ "string" ], "NextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. MaxResults Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 20 is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. DescribeCanaries API Version 2017-10-11 25 Amazon CloudWatch Synthetics Required: No Names Welcome Use this parameter to return only canaries that match the names that you specify here. You can specify as many as ﬁve canary names. If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing speciﬁc canaries. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: No NextToken A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 252. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Canaries": [ { Response Syntax API Version 2017-10-11 26 Amazon CloudWatch Synthetics Welcome "ArtifactConfig": { "S3Encryption": { "EncryptionMode": "string", "KmsKeyArn": "string" } }, "ArtifactS3Location": "string", "Code": { "Handler": "string", "SourceLocationArn": "string" }, "DryRunConfig": { "DryRunId": "string", "LastDryRunExecutionStatus": "string" }, "EngineArn": "string", "ExecutionRoleArn": "string", "FailureRetentionPeriodInDays":
Synthetics-APIReference-008	Synthetics-APIReference.pdf	8	Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: No NextToken A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 252. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Canaries": [ { Response Syntax API Version 2017-10-11 26 Amazon CloudWatch Synthetics Welcome "ArtifactConfig": { "S3Encryption": { "EncryptionMode": "string", "KmsKeyArn": "string" } }, "ArtifactS3Location": "string", "Code": { "Handler": "string", "SourceLocationArn": "string" }, "DryRunConfig": { "DryRunId": "string", "LastDryRunExecutionStatus": "string" }, "EngineArn": "string", "ExecutionRoleArn": "string", "FailureRetentionPeriodInDays": number, "Id": "string", "Name": "string", "ProvisionedResourceCleanup": "string", "RunConfig": { "ActiveTracing": boolean, "MemoryInMB": number, "TimeoutInSeconds": number }, "RuntimeVersion": "string", "Schedule": { "DurationInSeconds": number, "Expression": "string" }, "Status": { "State": "string", "StateReason": "string", "StateReasonCode": "string" }, "SuccessRetentionPeriodInDays": number, "Tags": { "string" : "string" }, "Timeline": { "Created": number, "LastModified": number, "LastStarted": number, Response Syntax API Version 2017-10-11 27 Amazon CloudWatch Synthetics Welcome "LastStopped": number }, "VisualReference": { "BaseCanaryRunId": "string", "BaseScreenshots": [ { "IgnoreCoordinates": [ "string" ], "ScreenshotName": "string" } ] }, "VpcConfig": { "Ipv6AllowedForDualStack": boolean, "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcId": "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. Canaries Returns an array. Each item in the array contains the full information about one canary. Type: Array of Canary objects NextToken A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 252. Response Elements API Version 2017-10-11 28 Amazon CloudWatch Synthetics Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 29 Amazon CloudWatch Synthetics Welcome DescribeCanariesLastRun Use this operation to see information from the most recent run of each canary that you have created. This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing speciﬁc canaries. Request Syntax POST /canaries/last-run HTTP/1.1 Content-type: application/json { "MaxResults": number, "Names": [ "string" ], "NextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. MaxResults Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun operation. If you omit this parameter, the default of 100 is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. DescribeCanariesLastRun API Version 2017-10-11 30 Amazon CloudWatch Synthetics Required: No Names Welcome Use this parameter to return only canaries that match the names that you specify here. You can specify as many as ﬁve canary names. If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing speciﬁc canaries. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: No NextToken A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results. Type: String
Synthetics-APIReference-009	Synthetics-APIReference.pdf	9	use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing speciﬁc canaries. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: No NextToken A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 252. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "CanariesLastRun": [ Response Syntax API Version 2017-10-11 31 Amazon CloudWatch Synthetics Welcome { "CanaryName": "string", "LastRun": { "ArtifactS3Location": "string", "DryRunConfig": { "DryRunId": "string" }, "Id": "string", "Name": "string", "Status": { "State": "string", "StateReason": "string", "StateReasonCode": "string" }, "Timeline": { "Completed": number, "Started": 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. CanariesLastRun An array that contains the information from the most recent run of each canary. Type: Array of CanaryLastRun objects NextToken A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 252. Response Elements API Version 2017-10-11 32 Amazon CloudWatch Synthetics Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 33 Amazon CloudWatch Synthetics Welcome DescribeRuntimeVersions Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions. Request Syntax POST /runtime-versions HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. MaxResults Specify this parameter to limit how many runs are returned each time you use the DescribeRuntimeVersions operation. If you omit this parameter, the default of 100 is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results. Type: String DescribeRuntimeVersions API Version 2017-10-11 34 Amazon CloudWatch Synthetics Welcome Length Constraints: Minimum length of 4. Maximum length of 252. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "RuntimeVersions": [ { "DeprecationDate": number, "Description": "string", "ReleaseDate": number, "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. NextToken A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 252. RuntimeVersions An array of objects that display the details about each Synthetics canary runtime version. Type: Array of RuntimeVersion objects Response Syntax API Version 2017-10-11 35 Amazon CloudWatch Synthetics Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 36 Amazon CloudWatch Synthetics Welcome DisassociateResource Removes a canary from a group. You must run this operation in the Region where the canary exists. Request Syntax PATCH /group/groupIdentifier/disassociate HTTP/1.1 Content-type: application/json { "ResourceArn": "string" } URI Request Parameters
Synthetics-APIReference-010	Synthetics-APIReference.pdf	10	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 2017-10-11 36 Amazon CloudWatch Synthetics Welcome DisassociateResource Removes a canary from a group. You must run this operation in the Region where the canary exists. Request Syntax PATCH /group/groupIdentifier/disassociate HTTP/1.1 Content-type: application/json { "ResourceArn": "string" } URI Request Parameters The request uses the following URI parameters. groupIdentiﬁer Speciﬁes the group. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request accepts the following data in JSON format. ResourceArn The ARN of the canary that you want to remove from the speciﬁed group. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+- \d{1}:\d{12}:canary:[0-9a-z_\-]{1,255} DisassociateResource API Version 2017-10-11 37 Amazon CloudWatch Synthetics Required: Yes Response Syntax HTTP/1.1 200 Response Elements Welcome 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. ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Response Syntax API Version 2017-10-11 38 Welcome Amazon CloudWatch Synthetics • 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 2017-10-11 39 Amazon CloudWatch Synthetics GetCanary Welcome Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries. Request Syntax GET /canary/name?dryRunId=DryRunId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. DryRunId The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run. Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ name The name of the canary that you want details for. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Canary": { "ArtifactConfig": { GetCanary API Version 2017-10-11 40 Amazon CloudWatch Synthetics Welcome "S3Encryption": { "EncryptionMode": "string", "KmsKeyArn": "string" } }, "ArtifactS3Location": "string", "Code": { "Handler": "string", "SourceLocationArn": "string" }, "DryRunConfig": { "DryRunId": "string", "LastDryRunExecutionStatus": "string" }, "EngineArn": "string", "ExecutionRoleArn": "string", "FailureRetentionPeriodInDays": number, "Id": "string", "Name": "string", "ProvisionedResourceCleanup": "string", "RunConfig": { "ActiveTracing": boolean, "MemoryInMB": number, "TimeoutInSeconds": number }, "RuntimeVersion": "string", "Schedule": { "DurationInSeconds": number, "Expression": "string" }, "Status": { "State": "string", "StateReason": "string", "StateReasonCode": "string" }, "SuccessRetentionPeriodInDays": number, "Tags": { "string" : "string" }, "Timeline": { "Created": number, "LastModified": number, "LastStarted": number, "LastStopped": number Response Syntax API Version 2017-10-11 41 Welcome Amazon CloudWatch Synthetics }, "VisualReference": { "BaseCanaryRunId": "string", "BaseScreenshots": [ { "IgnoreCoordinates": [ "string" ], "ScreenshotName": "string" } ] }, "VpcConfig": { "Ipv6AllowedForDualStack": boolean, "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcId": "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. Canary A structure that contains the full information about the canary. Type: Canary object Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ValidationException A parameter could not be validated. Response Elements API Version 2017-10-11 42 Amazon CloudWatch Synthetics HTTP Status Code: 400 See Also Welcome For more information about using this API in one of the language-speciﬁc 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 2017-10-11 43 Welcome Amazon CloudWatch Synthetics GetCanaryRuns Retrieves a list of runs for a speciﬁed canary. Request Syntax POST
Synthetics-APIReference-011	Synthetics-APIReference.pdf	11	Code: 400 See Also Welcome For more information about using this API in one of the language-speciﬁc 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 2017-10-11 43 Welcome Amazon CloudWatch Synthetics GetCanaryRuns Retrieves a list of runs for a speciﬁed canary. Request Syntax POST /canary/name/runs HTTP/1.1 Content-type: application/json { "DryRunId": "string", "MaxResults": number, "NextToken": "string", "RunType": "string" } URI Request Parameters The request uses the following URI parameters. name The name of the canary that you want to see runs for. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: Yes Request Body The request accepts the following data in JSON format. DryRunId The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run. Type: String GetCanaryRuns API Version 2017-10-11 44 Amazon CloudWatch Synthetics Welcome Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: No MaxResults Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 252. Required: No RunType • When you provide RunType=CANARY_RUN and dryRunId, you will get an exception • When a value is not provided for RunType, the default value is CANARY_RUN • When CANARY_RUN is provided, all canary runs excluding dry runs are returned • When DRY_RUN is provided, all dry runs excluding canary runs are returned Type: String Valid Values: CANARY_RUN \| DRY_RUN Required: No Response Syntax HTTP/1.1 200 Content-type: application/json Response Syntax API Version 2017-10-11 45 Amazon CloudWatch Synthetics Welcome { "CanaryRuns": [ { "ArtifactS3Location": "string", "DryRunConfig": { "DryRunId": "string" }, "Id": "string", "Name": "string", "Status": { "State": "string", "StateReason": "string", "StateReasonCode": "string" }, "Timeline": { "Completed": number, "Started": 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. CanaryRuns An array of structures. Each structure contains the details of one of the retrieved canary runs. Type: Array of CanaryRun objects NextToken A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 252. Response Elements API Version 2017-10-11 46 Amazon CloudWatch Synthetics Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 47 Amazon CloudWatch Synthetics GetGroup Welcome Returns information about one group. Groups are a global resource, so you can use this operation from any Region. Request Syntax GET /group/groupIdentifier HTTP/1.1 URI Request Parameters The request uses the following URI parameters. groupIdentiﬁer Speciﬁes the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Group": { "Arn": "string", "CreatedTime": number, "Id": "string", "LastModifiedTime": number, "Name": "string", "Tags": { "string" : "string" GetGroup API Version 2017-10-11 48 Amazon CloudWatch Synthetics Welcome } } } 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. Group A structure that contains information about the group. Type: Group object Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException A conﬂicting
Synthetics-APIReference-012	Synthetics-APIReference.pdf	12	The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Group": { "Arn": "string", "CreatedTime": number, "Id": "string", "LastModifiedTime": number, "Name": "string", "Tags": { "string" : "string" GetGroup API Version 2017-10-11 48 Amazon CloudWatch Synthetics Welcome } } } 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. Group A structure that contains information about the group. Type: Group object Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 Response Elements API Version 2017-10-11 49 Amazon CloudWatch Synthetics See Also Welcome For more information about using this API in one of the language-speciﬁc 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 2017-10-11 50 Amazon CloudWatch Synthetics Welcome ListAssociatedGroups Returns a list of the groups that the speciﬁed canary is associated with. The canary that you specify must be in the current Region. Request Syntax POST /resource/resourceArn/groups HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the canary that you want to view groups for. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+- \d{1}:\d{12}:canary:[0-9a-z_\-]{1,255} Required: Yes Request Body The request accepts the following data in JSON format. MaxResults Specify this parameter to limit how many groups are returned each time you use the ListAssociatedGroups operation. If you omit this parameter, the default of 20 is used. Type: Integer ListAssociatedGroups API Version 2017-10-11 51 Amazon CloudWatch Synthetics Welcome Valid Range: Minimum value of 1. Maximum value of 20. Required: No NextToken A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: ^.+$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Groups": [ { "Arn": "string", "Id": "string", "Name": "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. Groups An array of structures that contain information about the groups that this canary is associated with. Response Syntax API Version 2017-10-11 52 Amazon CloudWatch Synthetics Welcome Type: Array of GroupSummary objects NextToken A token that indicates that there is more data available. You can use this token in a subsequent ListAssociatedGroups operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: ^.+$ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2017-10-11 53 Welcome Amazon CloudWatch Synthetics • 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 2017-10-11 54 Amazon CloudWatch Synthetics ListGroupResources Welcome This operation returns a list of the ARNs of the canaries that are associated with the speciﬁed group. Request Syntax POST /group/groupIdentifier/resources HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } URI Request Parameters The request uses the following URI parameters. groupIdentiﬁer Speciﬁes the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request accepts the following data in JSON format. MaxResults Specify this parameter to limit how many canary ARNs are returned each time you use the ListGroupResources operation. If you omit this parameter, the default of 20 is used.
Synthetics-APIReference-013	Synthetics-APIReference.pdf	13	group. Request Syntax POST /group/groupIdentifier/resources HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } URI Request Parameters The request uses the following URI parameters. groupIdentiﬁer Speciﬁes the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request accepts the following data in JSON format. MaxResults Specify this parameter to limit how many canary ARNs are returned each time you use the ListGroupResources operation. If you omit this parameter, the default of 20 is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. ListGroupResources API Version 2017-10-11 55 Amazon CloudWatch Synthetics Required: No NextToken Welcome A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: ^.+$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Resources": [ "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 A token that indicates that there is more data available. You can use this token in a subsequent ListGroupResources operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: ^.+$ Response Syntax API Version 2017-10-11 56 Amazon CloudWatch Synthetics Resources Welcome An array of ARNs. These ARNs are for the canaries that are associated with the group. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 1024. Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2017-10-11 57 Welcome Amazon CloudWatch Synthetics • 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 2017-10-11 58 Amazon CloudWatch Synthetics ListGroups Welcome Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned. Request Syntax POST /groups HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. MaxResults Specify this parameter to limit how many groups are returned each time you use the ListGroups operation. If you omit this parameter, the default of 20 is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. Required: No NextToken A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results. Type: String ListGroups API Version 2017-10-11 59 Amazon CloudWatch Synthetics Welcome Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: ^.+$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Groups": [ { "Arn": "string", "Id": "string", "Name": "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. Groups An array of structures that each contain information about one group. Type: Array of GroupSummary objects NextToken A token that indicates that there is more data available. You can use this token in a subsequent ListGroups operation to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 252. Response Syntax API Version 2017-10-11 60 Amazon CloudWatch Synthetics Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 •
Synthetics-APIReference-014	Synthetics-APIReference.pdf	14	252. Response Syntax API Version 2017-10-11 60 Amazon CloudWatch Synthetics Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 61 Welcome Amazon CloudWatch Synthetics ListTagsForResource Displays the tags associated with a canary or group. Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the canary or group that you want to view tags for. The ARN format of a canary is arn:aws:synthetics:Region:account- id:canary:canary-name . The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group- name Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+- \d{1}:\d{12}:(canary\|group):[0-9a-z_\-]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Tags": { ListTagsForResource API Version 2017-10-11 62 Amazon CloudWatch Synthetics "string" : "string" } } Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Tags The list of tag keys and values associated with the resource that you speciﬁed. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The request was not valid. HTTP Status Code: 400 ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalFailureException An internal failure occurred. Try the operation again. Response Elements API Version 2017-10-11 63 Amazon CloudWatch Synthetics HTTP Status Code: 500 NotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 TooManyRequestsException Welcome There were too many simultaneous requests. Try the operation again. HTTP Status Code: 429 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 64 Amazon CloudWatch Synthetics StartCanary Welcome Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary. Request Syntax POST /canary/name/start HTTP/1.1 URI Request Parameters The request uses the following URI parameters. name The name of the canary that you want to run. To ﬁnd canary names, use DescribeCanaries. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 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. StartCanary API Version 2017-10-11 65 Welcome Amazon CloudWatch Synthetics ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 66 Amazon CloudWatch Synthetics StartCanaryDryRun Welcome Use this operation to start a dry run for a canary that has already been created Request Syntax POST /canary/name/dry-run/start HTTP/1.1 Content-type: application/json { "ArtifactConfig": { "S3Encryption": { "EncryptionMode": "string", "KmsKeyArn": "string" } }, "ArtifactS3Location": "string", "Code": { "Handler": "string", "S3Bucket": "string", "S3Key": "string", "S3Version": "string", "ZipFile": blob },
Synthetics-APIReference-015	Synthetics-APIReference.pdf	15	• 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 2017-10-11 66 Amazon CloudWatch Synthetics StartCanaryDryRun Welcome Use this operation to start a dry run for a canary that has already been created Request Syntax POST /canary/name/dry-run/start HTTP/1.1 Content-type: application/json { "ArtifactConfig": { "S3Encryption": { "EncryptionMode": "string", "KmsKeyArn": "string" } }, "ArtifactS3Location": "string", "Code": { "Handler": "string", "S3Bucket": "string", "S3Key": "string", "S3Version": "string", "ZipFile": blob }, "ExecutionRoleArn": "string", "FailureRetentionPeriodInDays": number, "ProvisionedResourceCleanup": "string", "RunConfig": { "ActiveTracing": boolean, "EnvironmentVariables": { "string" : "string" }, "MemoryInMB": number, "TimeoutInSeconds": number }, "RuntimeVersion": "string", "SuccessRetentionPeriodInDays": number, "VisualReference": { "BaseCanaryRunId": "string", "BaseScreenshots": [ { "IgnoreCoordinates": [ "string" ], "ScreenshotName": "string" StartCanaryDryRun API Version 2017-10-11 67 Welcome Amazon CloudWatch Synthetics } ] }, "VpcConfig": { "Ipv6AllowedForDualStack": boolean, "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } } URI Request Parameters The request uses the following URI parameters. name The name of the canary that you want to dry run. To ﬁnd canary names, use DescribeCanaries. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: Yes Request Body The request accepts the following data in JSON format. ArtifactConﬁg A structure that contains the conﬁguration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Type: ArtifactConﬁgInput object Required: No ArtifactS3Location The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log ﬁle, screenshots, and HAR ﬁles. The name of the Amazon S3 bucket can't include a period (.). URI Request Parameters API Version 2017-10-11 68 Amazon CloudWatch Synthetics Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No Code Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile. If you are uploading your canary scripts with an Amazon S3 bucket, your zip ﬁle should include your script in a certain folder structure. • For Node.js canaries, the folder structure must be nodejs/ node_modules/myCanaryFilename.js For more information, see Packaging your Node.js canary ﬁles • For Python canaries, the folder structure must be python/myCanaryFilename.py or python/myFolder/myCanaryFilename.py For more information, see Packaging your Python canary ﬁles Type: CanaryCodeInput object Required: No ExecutionRoleArn The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions: Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ Required: No FailureRetentionPeriodInDays The number of days to retain data on the failed runs for this canary. The valid range is 1 to 455 days. Request Body API Version 2017-10-11 69 Amazon CloudWatch Synthetics Welcome This setting aﬀects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1024. Required: No ProvisionedResourceCleanup Speciﬁes whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If the value of this parameter is AUTOMATIC, it means that the Lambda functions and layers will be deleted when the canary is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted. Type: String Valid Values: AUTOMATIC \| OFF Required: No RunConﬁg A structure that contains input information for a canary run. Type: CanaryRunConﬁgInput object Required: No RuntimeVersion Speciﬁes the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No SuccessRetentionPeriodInDays The number of days to retain data on the failed runs for this canary. The valid range is 1 to 455 days. Request Body API Version 2017-10-11 70 Amazon CloudWatch Synthetics Welcome This setting aﬀects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1024. Required: No VisualReference An object that speciﬁes what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts
Synthetics-APIReference-016	Synthetics-APIReference.pdf	16	1. Maximum length of 1024. Required: No SuccessRetentionPeriodInDays The number of days to retain data on the failed runs for this canary. The valid range is 1 to 455 days. Request Body API Version 2017-10-11 70 Amazon CloudWatch Synthetics Welcome This setting aﬀects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1024. Required: No VisualReference An object that speciﬁes what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison. Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint Type: VisualReferenceInput object Required: No VpcConﬁg If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. Type: VpcConﬁgInput object Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "DryRunConfig": { "DryRunId": "string", "LastDryRunExecutionStatus": "string" } Response Syntax API Version 2017-10-11 71 Amazon CloudWatch Synthetics } Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DryRunConﬁg Returns the dry run conﬁgurations for a canary. Type: DryRunConﬁgOutput object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You don't have permission to perform this operation on this resource. HTTP Status Code: 403 ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. Response Elements API Version 2017-10-11 72 Amazon CloudWatch Synthetics HTTP Status Code: 400 See Also Welcome For more information about using this API in one of the language-speciﬁc 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 2017-10-11 73 Amazon CloudWatch Synthetics StopCanary Welcome Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run. You can use StartCanary to start it running again with the canary’s current schedule at any point in the future. Request Syntax POST /canary/name/stop HTTP/1.1 URI Request Parameters The request uses the following URI parameters. name The name of the canary that you want to stop. To ﬁnd the names of your canaries, use ListCanaries. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. StopCanary API Version 2017-10-11 74 Amazon CloudWatch Synthetics Errors Welcome For information about the errors that are common to all actions, see Common Errors. ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 Errors API Version 2017-10-11 75 Amazon CloudWatch Synthetics • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 76 Amazon CloudWatch Synthetics TagResource Welcome Assigns one or more tags (key-value pairs) to the speciﬁed canary or group. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new
Synthetics-APIReference-017	Synthetics-APIReference.pdf	17	for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 76 Amazon CloudWatch Synthetics TagResource Welcome Assigns one or more tags (key-value pairs) to the speciﬁed canary or group. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a canary or group. Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the canary or group that you're adding tags to. The ARN format of a canary is arn:aws:synthetics:Region:account- id:canary:canary-name . The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group- name TagResource API Version 2017-10-11 77 Amazon CloudWatch Synthetics Welcome Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+- \d{1}:\d{12}:(canary\|group):[0-9a-z_\-]+ Required: Yes Request Body The request accepts the following data in JSON format. Tags The list of key-value pairs to associate with the resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Required: Yes Response Syntax HTTP/1.1 200 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. BadRequestException The request was not valid. Request Body API Version 2017-10-11 78 Welcome Amazon CloudWatch Synthetics HTTP Status Code: 400 ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalFailureException An internal failure occurred. Try the operation again. HTTP Status Code: 500 NotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 TooManyRequestsException There were too many simultaneous requests. Try the operation again. HTTP Status Code: 429 See Also For more information about using this API in one of the language-speciﬁc 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 2017-10-11 79 Amazon CloudWatch Synthetics Welcome See Also API Version 2017-10-11 80 Welcome Amazon CloudWatch Synthetics UntagResource Removes one or more tags from the speciﬁed resource. Request Syntax DELETE /tags/resourceArn?tagKeys=TagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the canary or group that you're removing tags from. The ARN format of a canary is arn:aws:synthetics:Region:account- id:canary:canary-name . The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group- name Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+- \d{1}:\d{12}:(canary\|group):[0-9a-z_\-]+ Required: Yes TagKeys The list of tag keys to remove from the resource. Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Required: Yes UntagResource API Version 2017-10-11 81 Welcome Amazon CloudWatch Synthetics Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 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. BadRequestException The request was not valid. HTTP Status Code: 400 ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalFailureException An internal failure occurred. Try the operation again. HTTP Status Code: 500 NotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 TooManyRequestsException There were too many simultaneous requests. Try the operation again. Request Body API Version 2017-10-11 82 Amazon CloudWatch Synthetics HTTP Status Code: 429 See Also Welcome For more information about using this API in one of the language-speciﬁc 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
Synthetics-APIReference-018	Synthetics-APIReference.pdf	18	Code: 500 NotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 TooManyRequestsException There were too many simultaneous requests. Try the operation again. Request Body API Version 2017-10-11 82 Amazon CloudWatch Synthetics HTTP Status Code: 429 See Also Welcome For more information about using this API in one of the language-speciﬁc 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 2017-10-11 83 Amazon CloudWatch Synthetics UpdateCanary Welcome Updates the conﬁguration of a canary that has already been created. You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource. Note When you use the dryRunId ﬁeld when updating a canary, the only other ﬁeld you can provide is the Schedule. Adding any other ﬁeld will thrown an exception. Request Syntax PATCH /canary/name HTTP/1.1 Content-type: application/json { "ArtifactConfig": { "S3Encryption": { "EncryptionMode": "string", "KmsKeyArn": "string" } }, "ArtifactS3Location": "string", "Code": { "Handler": "string", "S3Bucket": "string", "S3Key": "string", "S3Version": "string", "ZipFile": blob }, "DryRunId": "string", "ExecutionRoleArn": "string", "FailureRetentionPeriodInDays": number, "ProvisionedResourceCleanup": "string", "RunConfig": { "ActiveTracing": boolean, "EnvironmentVariables": { "string" : "string" UpdateCanary API Version 2017-10-11 84 Welcome Amazon CloudWatch Synthetics }, "MemoryInMB": number, "TimeoutInSeconds": number }, "RuntimeVersion": "string", "Schedule": { "DurationInSeconds": number, "Expression": "string" }, "SuccessRetentionPeriodInDays": number, "VisualReference": { "BaseCanaryRunId": "string", "BaseScreenshots": [ { "IgnoreCoordinates": [ "string" ], "ScreenshotName": "string" } ] }, "VpcConfig": { "Ipv6AllowedForDualStack": boolean, "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } } URI Request Parameters The request uses the following URI parameters. name The name of the canary that you want to update. To ﬁnd the names of your canaries, use DescribeCanaries. You cannot change the name of a canary that has already been created. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: Yes URI Request Parameters API Version 2017-10-11 85 Amazon CloudWatch Synthetics Request Body The request accepts the following data in JSON format. ArtifactConﬁg Welcome A structure that contains the conﬁguration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Type: ArtifactConﬁgInput object Required: No ArtifactS3Location The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log ﬁle, screenshots, and HAR ﬁles. The name of the S3 bucket can't include a period (.). Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No Code A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. Type: CanaryCodeInput object Required: No DryRunId Update the existing canary using the updated conﬁgurations from the DryRun associated with the DryRunId. Note When you use the dryRunId ﬁeld when updating a canary, the only other ﬁeld you can provide is the Schedule. Adding any other ﬁeld will thrown an exception. Request Body API Version 2017-10-11 86 Amazon CloudWatch Synthetics Type: String Welcome Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: No ExecutionRoleArn The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions: • s3:PutObject • s3:GetBucketLocation • s3:ListAllMyBuckets • cloudwatch:PutMetricData • logs:CreateLogGroup • logs:CreateLogStream • logs:CreateLogStream Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ Required: No FailureRetentionPeriodInDays The number of days to retain data about failed runs of this canary. This setting aﬀects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1024. Required: No Request Body API Version 2017-10-11 87 Amazon CloudWatch Synthetics ProvisionedResourceCleanup Welcome Speciﬁes whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted. Type: String Valid Values: AUTOMATIC \| OFF Required: No RunConﬁg A structure that contains the timeout value that is used for each individual run of the canary. Important Environment variable keys and values are encrypted at rest using AWS owned AWS KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them. Type: CanaryRunConﬁgInput object Required: No RuntimeVersion Speciﬁes the runtime version to
Synthetics-APIReference-019	Synthetics-APIReference.pdf	19	the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted. Type: String Valid Values: AUTOMATIC \| OFF Required: No RunConﬁg A structure that contains the timeout value that is used for each individual run of the canary. Important Environment variable keys and values are encrypted at rest using AWS owned AWS KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them. Type: CanaryRunConﬁgInput object Required: No RuntimeVersion Speciﬁes the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No Schedule A structure that contains information about how often the canary is to run, and when these runs are to stop. Request Body API Version 2017-10-11 88 Amazon CloudWatch Synthetics Welcome Type: CanaryScheduleInput object Required: No SuccessRetentionPeriodInDays The number of days to retain data about successful runs of this canary. This setting aﬀects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1024. Required: No VisualReference Deﬁnes the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already. Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint Type: VisualReferenceInput object Required: No VpcConﬁg If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. Type: VpcConﬁgInput object Required: No Response Syntax HTTP/1.1 200 Response Syntax API Version 2017-10-11 89 Amazon CloudWatch Synthetics Response Elements Welcome 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. AccessDeniedException You don't have permission to perform this operation on this resource. HTTP Status Code: 403 ConﬂictException A conﬂicting operation is already in progress. HTTP Status Code: 409 InternalServerException An unknown internal error occurred. HTTP Status Code: 500 RequestEntityTooLargeException One of the input resources is larger than is allowed. HTTP Status Code: 413 ResourceNotFoundException One of the speciﬁed resources was not found. HTTP Status Code: 404 ValidationException A parameter could not be validated. HTTP Status Code: 400 Response Elements API Version 2017-10-11 90 Amazon CloudWatch Synthetics See Also Welcome For more information about using this API in one of the language-speciﬁc 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 2017-10-11 91 Amazon CloudWatch Synthetics Welcome Data Types The Synthetics Internal API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • ArtifactConﬁgInput • ArtifactConﬁgOutput • BaseScreenshot • Canary • CanaryCodeInput • CanaryCodeOutput • CanaryDryRunConﬁgOutput • CanaryLastRun • CanaryRun • CanaryRunConﬁgInput • CanaryRunConﬁgOutput • CanaryRunStatus • CanaryRunTimeline • CanaryScheduleInput • CanaryScheduleOutput • CanaryStatus • CanaryTimeline • DryRunConﬁgOutput • Group • GroupSummary API Version 2017-10-11 92 Amazon CloudWatch Synthetics • RuntimeVersion • S3EncryptionConﬁg • VisualReferenceInput • VisualReferenceOutput • VpcConﬁgInput • VpcConﬁgOutput Welcome API Version 2017-10-11 93 Amazon CloudWatch Synthetics ArtifactConﬁgInput Welcome A structure that contains the conﬁguration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Contents S3Encryption A structure that contains the conﬁguration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Artifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see Encrypting canary artifacts Type: S3EncryptionConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ArtifactConﬁgInput API Version 2017-10-11 94 Amazon CloudWatch Synthetics Welcome ArtifactConﬁgOutput A structure that contains the conﬁguration for canary artifacts, including the encryption-at-rest settings
Synthetics-APIReference-020	Synthetics-APIReference.pdf	20	of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Artifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see Encrypting canary artifacts Type: S3EncryptionConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ArtifactConﬁgInput API Version 2017-10-11 94 Amazon CloudWatch Synthetics Welcome ArtifactConﬁgOutput A structure that contains the conﬁguration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Contents S3Encryption A structure that contains the conﬁguration of encryption settings for canary artifacts that are stored in Amazon S3. Type: S3EncryptionConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ArtifactConﬁgOutput API Version 2017-10-11 95 Amazon CloudWatch Synthetics BaseScreenshot Welcome A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary. Contents ScreenshotName The name of the screenshot. This is generated the ﬁrst time the canary is run after the UpdateCanary operation that speciﬁed for this canary to perform visual monitoring. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes IgnoreCoordinates Coordinates that deﬁne the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 20 items. Pattern: ^(-?\d{1,5}\.?\d{0,2},){3}(-?\d{1,5}\.?\d{0,2}){1}$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BaseScreenshot API Version 2017-10-11 96 Amazon CloudWatch Synthetics Welcome See Also API Version 2017-10-11 97 Amazon CloudWatch Synthetics Canary Welcome This structure contains all information about one canary in your account. Contents ArtifactConﬁg A structure that contains the conﬁguration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Type: ArtifactConﬁgOutput object Required: No ArtifactS3Location The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log ﬁle, screenshots, and HAR ﬁles. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No Code This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics. Type: CanaryCodeOutput object Required: No DryRunConﬁg Returns the dry run conﬁgurations for a canary. Type: DryRunConﬁgOutput object Required: No Canary API Version 2017-10-11 98 Amazon CloudWatch Synthetics EngineArn Welcome The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:lambda:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+-\d{1}: \d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST\|[a-zA-Z0-9-_]+))? Required: No ExecutionRoleArn The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ Required: No FailureRetentionPeriodInDays The number of days to retain data about failed runs of this canary. This setting aﬀects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1024. Required: No Id The unique ID of this canary. Type: String Contents API Version 2017-10-11 99 Amazon CloudWatch Synthetics Welcome Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ Required: No Name The name of the canary. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: No ProvisionedResourceCleanup Speciﬁes whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted. Type: String Valid Values: AUTOMATIC \| OFF Required: No RunConﬁg A structure that contains information about a canary run. Type: CanaryRunConﬁgOutput object Required: No RuntimeVersion Speciﬁes the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions. Type: String Contents API Version 2017-10-11 100 Amazon CloudWatch Synthetics Welcome Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No Schedule A
Synthetics-APIReference-021	Synthetics-APIReference.pdf	21	is deleted. If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted. Type: String Valid Values: AUTOMATIC \| OFF Required: No RunConﬁg A structure that contains information about a canary run. Type: CanaryRunConﬁgOutput object Required: No RuntimeVersion Speciﬁes the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions. Type: String Contents API Version 2017-10-11 100 Amazon CloudWatch Synthetics Welcome Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No Schedule A structure that contains information about how often the canary is to run, and when these runs are to stop. Type: CanaryScheduleOutput object Required: No Status A structure that contains information about the canary's status. Type: CanaryStatus object Required: No SuccessRetentionPeriodInDays The number of days to retain data about successful runs of this canary. This setting aﬀects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1024. Required: No Tags The list of key-value pairs that are associated with the canary. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Contents API Version 2017-10-11 101 Amazon CloudWatch Synthetics Welcome Value Length Constraints: Maximum length of 256. Required: No Timeline A structure that contains information about when the canary was created, modiﬁed, and most recently run. Type: CanaryTimeline object Required: No VisualReference If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison. Type: VisualReferenceOutput object Required: No VpcConﬁg If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. Type: VpcConﬁgOutput object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2017-10-11 102 Amazon CloudWatch Synthetics CanaryCodeInput Welcome Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile. If you are uploading your canary scripts with an Amazon S3 bucket, your zip ﬁle should include your script in a certain folder structure. • For Node.js canaries, the folder structure must be nodejs/ node_modules/myCanaryFilename.js For more information, see Packaging your Node.js canary ﬁles • For Python canaries, the folder structure must be python/myCanaryFilename.py or python/myFolder/myCanaryFilename.py For more information, see Packaging your Python canary ﬁles Contents Handler The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be speciﬁed as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be speciﬁed as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName . Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^([0-9a-zA-Z_-]+\/)[0-9A-Za-z_\\-]+\.[A-Za-z_][A-Za-z0-9_]$ Required: Yes S3Bucket If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name. CanaryCodeInput API Version 2017-10-11 103 Amazon CloudWatch Synthetics Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No S3Key The S3 key of your script. For more information, see Working with Amazon S3 Objects. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No S3Version The S3 version ID of your script. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No ZipFile If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip ﬁle that contains the script. It must be smaller than 225 Kb. For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter. Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 10000000. Required: No See Also For more information about using this API in
Synthetics-APIReference-022	Synthetics-APIReference.pdf	22	Constraints: Minimum length of 1. Maximum length of 1024. Required: No ZipFile If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip ﬁle that contains the script. It must be smaller than 225 Kb. For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter. Type: Base64-encoded binary data object Length Constraints: Minimum length of 1. Maximum length of 10000000. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2017-10-11 104 Amazon CloudWatch Synthetics • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 105 Amazon CloudWatch Synthetics CanaryCodeOutput Welcome This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics. Contents Handler The entry point to use for the source code when running the canary. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No SourceLocationArn The ARN of the Lambda layer where Synthetics stores the canary script code. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CanaryCodeOutput API Version 2017-10-11 106 Amazon CloudWatch Synthetics Welcome CanaryDryRunConﬁgOutput Returns the dry run conﬁgurations set for a canary. Contents DryRunId The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run. 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CanaryDryRunConﬁgOutput API Version 2017-10-11 107 Amazon CloudWatch Synthetics CanaryLastRun Welcome This structure contains information about the most recent run of a single canary. Contents CanaryName The name of the canary. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ Required: No LastRun The results from this canary's most recent run. Type: CanaryRun object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CanaryLastRun API Version 2017-10-11 108 Amazon CloudWatch Synthetics CanaryRun This structure contains the details about one run of one canary. Welcome Contents ArtifactS3Location The location where the canary stored artifacts from the run. Artifacts include the log ﬁle, screenshots, and HAR ﬁles. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No DryRunConﬁg Returns the dry run conﬁgurations for a canary. Type: CanaryDryRunConﬁgOutput object Required: No Id A unique ID that identiﬁes this canary run. 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 Name The name of the canary. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[0-9a-z_\-]+$ CanaryRun API Version 2017-10-11 109 Amazon CloudWatch Synthetics Required: No Status The status of this run. Type: CanaryRunStatus object Required: No Timeline Welcome A structure that contains the start and end times of this run. Type: CanaryRunTimeline object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2017-10-11 110 Amazon CloudWatch Synthetics Welcome CanaryRunConﬁgInput A structure that contains input information for a canary run. Contents ActiveTracing Speciﬁes whether this canary is to use active AWS X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime. Type: Boolean Required: No EnvironmentVariables Speciﬁes the keys and values to use for any environment variables used in the canary script. Use the following format: { "key1" : "value1", "key2" : "value2", ...} Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables. Important Environment
Synthetics-APIReference-023	Synthetics-APIReference.pdf	23	can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime. Type: Boolean Required: No EnvironmentVariables Speciﬁes the keys and values to use for any environment variables used in the canary script. Use the following format: { "key1" : "value1", "key2" : "value2", ...} Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables. Important Environment variable keys and values are encrypted at rest using AWS owned AWS KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them. Type: String to string map CanaryRunConﬁgInput API Version 2017-10-11 111 Amazon CloudWatch Synthetics Welcome Key Pattern: [a-zA-Z]([a-zA-Z0-9_])+ Required: No MemoryInMB The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64. Type: Integer Valid Range: Minimum value of 960. Maximum value of 3008. Required: No TimeoutInSeconds How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary. If you omit this ﬁeld, the frequency of the canary is used as this value, up to a maximum of 14 minutes. Type: Integer Valid Range: Minimum value of 3. Maximum value of 840. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2017-10-11 112 Amazon CloudWatch Synthetics Welcome CanaryRunConﬁgOutput A structure that contains information about a canary run. Contents ActiveTracing Displays whether this canary run used active X-Ray tracing. Type: Boolean Required: No MemoryInMB The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64. Type: Integer Valid Range: Minimum value of 960. Maximum value of 3008. Required: No TimeoutInSeconds How long the canary is allowed to run before it must stop. Type: Integer Valid Range: Minimum value of 3. Maximum value of 840. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 CanaryRunConﬁgOutput API Version 2017-10-11 113 Amazon CloudWatch Synthetics • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 114 Amazon CloudWatch Synthetics CanaryRunStatus This structure contains the status information about a canary run. Welcome Contents State The current state of the run. Type: String Valid Values: RUNNING \| PASSED \| FAILED Required: No StateReason If run of the canary failed, this ﬁeld contains the reason for the error. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No StateReasonCode If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics. Type: String Valid Values: CANARY_FAILURE \| EXECUTION_FAILURE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ CanaryRunStatus API Version 2017-10-11 115 Amazon CloudWatch Synthetics • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 116 Amazon CloudWatch Synthetics CanaryRunTimeline Welcome This structure contains the start and end times of a single canary run. Contents Completed The end time of the run. Type: Timestamp Required: No Started The start time of the run. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CanaryRunTimeline API Version 2017-10-11 117 Amazon CloudWatch Synthetics Welcome CanaryScheduleInput This structure speciﬁes how often a canary is to make runs and the date and time when it should stop making runs. Contents Expression A rate expression or a cron expression that deﬁnes how often the canary is to run. For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour). Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started. Use cron(expression) to specify a cron expression. You can't
Synthetics-APIReference-024	Synthetics-APIReference.pdf	24	A rate expression or a cron expression that deﬁnes how often the canary is to run. For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour). Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started. Use cron(expression) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes DurationInSeconds How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this ﬁeld, the default of 0 is used. Type: Long Valid Range: Minimum value of 0. Maximum value of 31622400. Required: No CanaryScheduleInput API Version 2017-10-11 118 Amazon CloudWatch Synthetics See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2017-10-11 119 Amazon CloudWatch Synthetics Welcome CanaryScheduleOutput How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. Contents DurationInSeconds How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value. Type: Long Valid Range: Minimum value of 0. Maximum value of 31622400. Required: No Expression A rate expression or a cron expression that deﬁnes how often the canary is to run. For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour). Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started. Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No CanaryScheduleOutput API Version 2017-10-11 120 Amazon CloudWatch Synthetics See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2017-10-11 121 Amazon CloudWatch Synthetics CanaryStatus A structure that contains the current state of the canary. Welcome Contents State The current state of the canary. Type: String Valid Values: CREATING \| READY \| STARTING \| RUNNING \| UPDATING \| STOPPING \| STOPPED \| ERROR \| DELETING Required: No StateReason If the canary creation or update failed, this ﬁeld provides details on the failure. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No StateReasonCode If the canary creation or update failed, this ﬁeld displays the reason code. Type: String Valid Values: INVALID_PERMISSIONS \| CREATE_PENDING \| CREATE_IN_PROGRESS \| CREATE_FAILED \| UPDATE_PENDING \| UPDATE_IN_PROGRESS \| UPDATE_COMPLETE \| ROLLBACK_COMPLETE \| ROLLBACK_FAILED \| DELETE_IN_PROGRESS \| DELETE_FAILED \| SYNC_DELETE_IN_PROGRESS Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: CanaryStatus API Version 2017-10-11 122 Amazon CloudWatch Synthetics • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 123 Amazon CloudWatch Synthetics CanaryTimeline Welcome This structure contains information about when the canary was created and modiﬁed. Contents Created The date and time the canary was created. Type: Timestamp Required: No LastModiﬁed The date and time the canary was most recently modiﬁed. Type: Timestamp Required: No LastStarted The date and time that the canary's most recent run started. Type: Timestamp Required: No LastStopped The date and time that the canary's most recent run ended. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ CanaryTimeline API Version 2017-10-11 124 Amazon CloudWatch Synthetics • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 125 Amazon CloudWatch Synthetics Welcome DryRunConﬁgOutput
Synthetics-APIReference-025	Synthetics-APIReference.pdf	25	and time the canary was most recently modiﬁed. Type: Timestamp Required: No LastStarted The date and time that the canary's most recent run started. Type: Timestamp Required: No LastStopped The date and time that the canary's most recent run ended. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ CanaryTimeline API Version 2017-10-11 124 Amazon CloudWatch Synthetics • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 125 Amazon CloudWatch Synthetics Welcome DryRunConﬁgOutput Returns the dry run conﬁgurations set for a canary. Contents DryRunId The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run. 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 LastDryRunExecutionStatus Returns the last execution status for a canary's dry run. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DryRunConﬁgOutput API Version 2017-10-11 126 Amazon CloudWatch Synthetics Group This structure contains information about one group. Welcome Contents Arn The ARN of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: arn:(aws[a-zA-Z-])?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+- \d{1}:\d{12}:group:[0-9a-z]+ Required: No CreatedTime The date and time that the group was created. Type: Timestamp Required: No Id The unique ID of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No LastModiﬁedTime The date and time that the group was most recently updated. Type: Timestamp Required: No Group API Version 2017-10-11 127 Welcome Amazon CloudWatch Synthetics Name The name of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Tags The list of key-value pairs that are associated with the canary. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2017-10-11 128 Amazon CloudWatch Synthetics GroupSummary A structure containing some information about a group. Welcome Contents Arn The ARN of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: arn:(aws[a-zA-Z-])?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+- \d{1}:\d{12}:group:[0-9a-z]+ Required: No Id The unique ID of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No Name The name of the group. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: GroupSummary API Version 2017-10-11 129 Amazon CloudWatch Synthetics • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 130 Amazon CloudWatch Synthetics RuntimeVersion Welcome This structure contains information about one canary runtime version. For more information about runtime versions, see Canary Runtime Versions. Contents DeprecationDate If this runtime version is deprecated, this value is the date of deprecation. Type: Timestamp Required: No Description A description of the runtime version, created by Amazon. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No ReleaseDate The date that the runtime version was released. Type: Timestamp Required: No VersionName The name of the runtime version. For a list of valid runtime versions, see Canary Runtime Versions. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No RuntimeVersion API Version 2017-10-11 131 Amazon CloudWatch Synthetics See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2017-10-11 132 Amazon CloudWatch Synthetics S3EncryptionConﬁg Welcome A structure that contains the conﬁguration of encryption-at-rest settings for canary artifacts that the canary uploads to Amazon S3. For more information, see Encrypting canary artifacts Contents EncryptionMode The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server- side encryption with a customer-managed AWS KMS key. If you omit this parameter, an AWS-managed AWS KMS key is used. Type: String Valid Values: SSE_S3 \| SSE_KMS Required: No KmsKeyArn The ARN of the customer-managed AWS KMS key
Synthetics-APIReference-026	Synthetics-APIReference.pdf	26	132 Amazon CloudWatch Synthetics S3EncryptionConﬁg Welcome A structure that contains the conﬁguration of encryption-at-rest settings for canary artifacts that the canary uploads to Amazon S3. For more information, see Encrypting canary artifacts Contents EncryptionMode The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server- side encryption with a customer-managed AWS KMS key. If you omit this parameter, an AWS-managed AWS KMS key is used. Type: String Valid Values: SSE_S3 \| SSE_KMS Required: No KmsKeyArn The ARN of the customer-managed AWS KMS key to use, if you specify SSE-KMS for EncryptionMode Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:kms:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+-\d{1}: \d{12}:key/[\w\-\/]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: S3EncryptionConﬁg API Version 2017-10-11 133 Amazon CloudWatch Synthetics • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 134 Amazon CloudWatch Synthetics Welcome VisualReferenceInput An object that speciﬁes what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison. Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint Contents BaseCanaryRunId Speciﬁes which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run before this update was made, or the value of Id in the CanaryRun from a run of this a canary in the past 31 days. If you specify the Id of a canary run older than 31 days, the operation returns a 400 validation exception error.. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes BaseScreenshots An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array. Type: Array of BaseScreenshot objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: VisualReferenceInput API Version 2017-10-11 135 Amazon CloudWatch Synthetics • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 136 Amazon CloudWatch Synthetics Welcome VisualReferenceOutput If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run that is used as the baseline for screenshots, and the coordinates of any parts of those screenshots that are ignored during visual monitoring comparison. Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. Contents BaseCanaryRunId The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No BaseScreenshots An array of screenshots that are used as the baseline for comparisons during visual monitoring. Type: Array of BaseScreenshot objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 VisualReferenceOutput API Version 2017-10-11 137 Amazon CloudWatch Synthetics VpcConﬁgInput Welcome If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. Contents Ipv6AllowedForDualStack Set this to true to allow outbound IPv6 traﬃc on VPC canaries that are connected to dual- stack subnets. The default is false Type: Boolean Required: No SecurityGroupIds The IDs of the security groups for this canary. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No SubnetIds The IDs of the subnets where this canary is to run. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 16 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ VpcConﬁgInput API Version 2017-10-11 138 Amazon CloudWatch Synthetics • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 139 Amazon CloudWatch Synthetics VpcConﬁgOutput Welcome If this canary is to test an endpoint in a VPC, this
Synthetics-APIReference-027	Synthetics-APIReference.pdf	27	Required: No SubnetIds The IDs of the subnets where this canary is to run. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 16 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ VpcConﬁgInput API Version 2017-10-11 138 Amazon CloudWatch Synthetics • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-10-11 139 Amazon CloudWatch Synthetics VpcConﬁgOutput Welcome If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC. Contents Ipv6AllowedForDualStack Indicates whether this canary allows outbound IPv6 traﬃc if it is connected to dual-stack subnets. Type: Boolean Required: No SecurityGroupIds The IDs of the security groups for this canary. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No SubnetIds The IDs of the subnets where this canary is to run. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 16 items. Required: No VpcId The IDs of the VPC where this canary is to run. Type: String Required: No VpcConﬁgOutput API Version 2017-10-11 140 Amazon CloudWatch Synthetics See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2017-10-11 141 Amazon CloudWatch Synthetics Welcome Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2017-10-11 142 Amazon CloudWatch Synthetics Welcome For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2017-10-11 143 Amazon CloudWatch Synthetics Type: string Required: Conditional X-Amz-SignedHeaders Welcome Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2017-10-11 144 Amazon CloudWatch Synthetics Welcome Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this
Synthetics-APIReference-028	Synthetics-APIReference.pdf	28	as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2017-10-11 144 Amazon CloudWatch Synthetics Welcome Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2017-10-11 145 Amazon CloudWatch Synthetics HTTP Status Code: 403 RequestAbortedException Welcome Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2017-10-11 146 Amazon CloudWatch Synthetics UnknownOperationException Welcome The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2017-10-11 147
systems-manager-api-001	systems-manager-api.pdf	1	API Reference AWS Systems Manager API Version 2014-11-06 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Systems Manager API Reference AWS Systems Manager: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS Systems Manager Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 AddTagsToResource ...................................................................................................................................... 7 Request Syntax ........................................................................................................................................ 7 Request Parameters ................................................................................................................................ 8 Response Elements ................................................................................................................................. 9 Errors .......................................................................................................................................................... 9 Examples ................................................................................................................................................. 10 See Also .................................................................................................................................................. 11 AssociateOpsItemRelatedItem ................................................................................................................. 13 Request Syntax ...................................................................................................................................... 13 Request Parameters .............................................................................................................................. 13 Response Syntax ................................................................................................................................... 14 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 14 Examples ................................................................................................................................................. 15 See Also .................................................................................................................................................. 16 CancelCommand ......................................................................................................................................... 17 Request Syntax ...................................................................................................................................... 17 Request Parameters .............................................................................................................................. 17 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 18 Examples ................................................................................................................................................. 18 See Also .................................................................................................................................................. 19 CancelMaintenanceWindowExecution .................................................................................................... 21 Request Syntax ...................................................................................................................................... 21 Request Parameters .............................................................................................................................. 21 Response Syntax ................................................................................................................................... 21 Response Elements ............................................................................................................................... 21 Errors ....................................................................................................................................................... 22 Examples ................................................................................................................................................. 22 See Also .................................................................................................................................................. 23 CreateActivation ......................................................................................................................................... 24 Request Syntax ...................................................................................................................................... 24 API Version 2014-11-06 iii AWS Systems Manager API Reference Request Parameters .............................................................................................................................. 25 Response Syntax ................................................................................................................................... 27 Response Elements ............................................................................................................................... 27 Errors ....................................................................................................................................................... 28 Examples ................................................................................................................................................. 28 See Also .................................................................................................................................................. 29 CreateAssociation ....................................................................................................................................... 31 Request Syntax ...................................................................................................................................... 31 Request Parameters .............................................................................................................................. 33 Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 42 Errors ....................................................................................................................................................... 43 Examples ................................................................................................................................................. 45 See Also .................................................................................................................................................. 46 CreateAssociationBatch ............................................................................................................................. 47 Request Syntax ...................................................................................................................................... 47 Request Parameters .............................................................................................................................. 49 Response Syntax ................................................................................................................................... 49 Response Elements ............................................................................................................................... 53 Errors ....................................................................................................................................................... 54 Examples ................................................................................................................................................. 55 See Also .................................................................................................................................................. 58 CreateDocument ......................................................................................................................................... 59 Request Syntax ...................................................................................................................................... 59 Request Parameters .............................................................................................................................. 60 Response Syntax ................................................................................................................................... 64 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 65 Examples ................................................................................................................................................. 66 See Also .................................................................................................................................................. 68 CreateMaintenanceWindow ...................................................................................................................... 69 Request Syntax ...................................................................................................................................... 69 Request Parameters .............................................................................................................................. 69 Response Syntax ................................................................................................................................... 73 Response Elements ............................................................................................................................... 73 Errors ....................................................................................................................................................... 74 API Version 2014-11-06 iv AWS Systems Manager API Reference Examples ................................................................................................................................................. 74 See Also .................................................................................................................................................. 75 CreateOpsItem ............................................................................................................................................ 77 Request Syntax ...................................................................................................................................... 77 Request Parameters .............................................................................................................................. 78 Response Syntax ................................................................................................................................... 83 Response Elements ............................................................................................................................... 83 Errors ....................................................................................................................................................... 84 Examples ................................................................................................................................................. 84 See Also .................................................................................................................................................. 85 CreateOpsMetadata ................................................................................................................................... 87 Request Syntax ...................................................................................................................................... 87 Request Parameters .............................................................................................................................. 87 Response Syntax ................................................................................................................................... 88 Response Elements ............................................................................................................................... 88 Errors ....................................................................................................................................................... 89 See Also .................................................................................................................................................. 90 CreatePatchBaseline .................................................................................................................................. 91 Request Syntax ...................................................................................................................................... 91 Request Parameters .............................................................................................................................. 92 Response Syntax ................................................................................................................................... 97 Response Elements ............................................................................................................................... 97 Errors ....................................................................................................................................................... 97 Examples ................................................................................................................................................. 98 See Also .................................................................................................................................................. 99 CreateResourceDataSync ........................................................................................................................ 101 Request Syntax .................................................................................................................................... 101 Request Parameters ........................................................................................................................... 102 Response Elements ............................................................................................................................ 103 Errors ..................................................................................................................................................... 103 Examples ............................................................................................................................................... 104 See Also ................................................................................................................................................ 105 DeleteActivation ....................................................................................................................................... 106 Request Syntax .................................................................................................................................... 106 Request Parameters ........................................................................................................................... 106 Response Elements ............................................................................................................................ 106 API Version 2014-11-06 v AWS Systems Manager API Reference Errors ..................................................................................................................................................... 106 Examples ............................................................................................................................................... 107 See Also ................................................................................................................................................ 108 DeleteAssociation ..................................................................................................................................... 109 Request Syntax .................................................................................................................................... 109 Request Parameters ........................................................................................................................... 109 Response Elements ............................................................................................................................ 110 Errors ..................................................................................................................................................... 110 Examples ............................................................................................................................................... 111 See Also ................................................................................................................................................ 112 DeleteDocument ....................................................................................................................................... 113 Request Syntax .................................................................................................................................... 113 Request Parameters ........................................................................................................................... 113 Response Elements ............................................................................................................................ 114 Errors ..................................................................................................................................................... 114 Examples ............................................................................................................................................... 115 See Also ................................................................................................................................................ 115 DeleteInventory ........................................................................................................................................ 117 Request Syntax .................................................................................................................................... 117 Request Parameters ........................................................................................................................... 117 Response Syntax ................................................................................................................................. 118 Response Elements ............................................................................................................................ 119 Errors ..................................................................................................................................................... 119 Examples ............................................................................................................................................... 120 See Also ................................................................................................................................................ 121 DeleteMaintenanceWindow ................................................................................................................... 123 Request Syntax .................................................................................................................................... 123 Request Parameters ........................................................................................................................... 123 Response Syntax ................................................................................................................................. 123 Response Elements ............................................................................................................................ 123 Errors ..................................................................................................................................................... 124 Examples ............................................................................................................................................... 124 See Also ................................................................................................................................................ 125 DeleteOpsItem .......................................................................................................................................... 126 Request Syntax .................................................................................................................................... 126 Request Parameters ........................................................................................................................... 126 API Version 2014-11-06 vi AWS Systems Manager API Reference Response Elements ............................................................................................................................ 127 Errors ..................................................................................................................................................... 127 Examples ............................................................................................................................................... 127 See Also ................................................................................................................................................ 128 DeleteOpsMetadata ................................................................................................................................. 129 Request Syntax .................................................................................................................................... 129 Request Parameters ........................................................................................................................... 129 Response Elements ............................................................................................................................ 129 Errors ..................................................................................................................................................... 129 See Also ................................................................................................................................................ 130 DeleteParameter ...................................................................................................................................... 131 Request Syntax .................................................................................................................................... 131 Request Parameters ........................................................................................................................... 131 Response Elements ............................................................................................................................ 131 Errors ..................................................................................................................................................... 131 Examples ............................................................................................................................................... 132 See Also ................................................................................................................................................ 133 DeleteParameters ..................................................................................................................................... 134 Request Syntax .................................................................................................................................... 134 Request Parameters ........................................................................................................................... 134 Response Syntax ................................................................................................................................. 134 Response Elements ............................................................................................................................ 135 Errors ..................................................................................................................................................... 135 Examples ............................................................................................................................................... 135 See Also ................................................................................................................................................ 136 DeletePatchBaseline ................................................................................................................................ 138 Request Syntax .................................................................................................................................... 138 Request Parameters ........................................................................................................................... 138 Response Syntax ................................................................................................................................. 138 Response Elements ............................................................................................................................ 138 Errors ..................................................................................................................................................... 139 Examples ............................................................................................................................................... 139 See Also ................................................................................................................................................ 140 DeleteResourceDataSync ........................................................................................................................ 141 Request Syntax .................................................................................................................................... 141 Request Parameters ........................................................................................................................... 141 API Version
systems-manager-api-002	systems-manager-api.pdf	2	See Also ................................................................................................................................................ 130 DeleteParameter ...................................................................................................................................... 131 Request Syntax .................................................................................................................................... 131 Request Parameters ........................................................................................................................... 131 Response Elements ............................................................................................................................ 131 Errors ..................................................................................................................................................... 131 Examples ............................................................................................................................................... 132 See Also ................................................................................................................................................ 133 DeleteParameters ..................................................................................................................................... 134 Request Syntax .................................................................................................................................... 134 Request Parameters ........................................................................................................................... 134 Response Syntax ................................................................................................................................. 134 Response Elements ............................................................................................................................ 135 Errors ..................................................................................................................................................... 135 Examples ............................................................................................................................................... 135 See Also ................................................................................................................................................ 136 DeletePatchBaseline ................................................................................................................................ 138 Request Syntax .................................................................................................................................... 138 Request Parameters ........................................................................................................................... 138 Response Syntax ................................................................................................................................. 138 Response Elements ............................................................................................................................ 138 Errors ..................................................................................................................................................... 139 Examples ............................................................................................................................................... 139 See Also ................................................................................................................................................ 140 DeleteResourceDataSync ........................................................................................................................ 141 Request Syntax .................................................................................................................................... 141 Request Parameters ........................................................................................................................... 141 API Version 2014-11-06 vii AWS Systems Manager API Reference Response Elements ............................................................................................................................ 141 Errors ..................................................................................................................................................... 142 Examples ............................................................................................................................................... 142 See Also ................................................................................................................................................ 143 DeleteResourcePolicy .............................................................................................................................. 144 Request Syntax .................................................................................................................................... 144 Request Parameters ........................................................................................................................... 144 Response Elements ............................................................................................................................ 145 Errors ..................................................................................................................................................... 145 See Also ................................................................................................................................................ 146 DeregisterManagedInstance ................................................................................................................... 147 Request Syntax .................................................................................................................................... 147 Request Parameters ........................................................................................................................... 147 Response Elements ............................................................................................................................ 147 Errors ..................................................................................................................................................... 148 Examples ............................................................................................................................................... 148 See Also ................................................................................................................................................ 149 DeregisterPatchBaselineForPatchGroup .............................................................................................. 150 Request Syntax .................................................................................................................................... 150 Request Parameters ........................................................................................................................... 150 Response Syntax ................................................................................................................................. 151 Response Elements ............................................................................................................................ 151 Errors ..................................................................................................................................................... 151 Examples ............................................................................................................................................... 152 See Also ................................................................................................................................................ 153 DeregisterTargetFromMaintenanceWindow ....................................................................................... 154 Request Syntax .................................................................................................................................... 154 Request Parameters ........................................................................................................................... 154 Response Syntax ................................................................................................................................. 155 Response Elements ............................................................................................................................ 155 Errors ..................................................................................................................................................... 156 Examples ............................................................................................................................................... 156 See Also ................................................................................................................................................ 157 DeregisterTaskFromMaintenanceWindow ........................................................................................... 158 Request Syntax .................................................................................................................................... 158 Request Parameters ........................................................................................................................... 158 API Version 2014-11-06 viii AWS Systems Manager API Reference Response Syntax ................................................................................................................................. 159 Response Elements ............................................................................................................................ 159 Errors ..................................................................................................................................................... 159 Examples ............................................................................................................................................... 160 See Also ................................................................................................................................................ 161 DescribeActivations .................................................................................................................................. 162 Request Syntax .................................................................................................................................... 162 Request Parameters ........................................................................................................................... 162 Response Syntax ................................................................................................................................. 163 Response Elements ............................................................................................................................ 163 Errors ..................................................................................................................................................... 164 Examples ............................................................................................................................................... 164 See Also ................................................................................................................................................ 165 DescribeAssociation ................................................................................................................................. 167 Request Syntax .................................................................................................................................... 167 Request Parameters ........................................................................................................................... 167 Response Syntax ................................................................................................................................. 168 Response Elements ............................................................................................................................ 170 Errors ..................................................................................................................................................... 171 Examples ............................................................................................................................................... 172 See Also ................................................................................................................................................ 173 DescribeAssociationExecutions .............................................................................................................. 174 Request Syntax .................................................................................................................................... 174 Request Parameters ........................................................................................................................... 174 Response Syntax ................................................................................................................................. 175 Response Elements ............................................................................................................................ 176 Errors ..................................................................................................................................................... 176 Examples ............................................................................................................................................... 177 See Also ................................................................................................................................................ 178 DescribeAssociationExecutionTargets .................................................................................................. 179 Request Syntax .................................................................................................................................... 179 Request Parameters ........................................................................................................................... 179 Response Syntax ................................................................................................................................. 180 Response Elements ............................................................................................................................ 181 Errors ..................................................................................................................................................... 181 Examples ............................................................................................................................................... 182 API Version 2014-11-06 ix AWS Systems Manager API Reference See Also ................................................................................................................................................ 184 DescribeAutomationExecutions ............................................................................................................. 185 Request Syntax .................................................................................................................................... 185 Request Parameters ........................................................................................................................... 185 Response Syntax ................................................................................................................................. 186 Response Elements ............................................................................................................................ 188 Errors ..................................................................................................................................................... 189 Examples ............................................................................................................................................... 190 See Also ................................................................................................................................................ 191 DescribeAutomationStepExecutions .................................................................................................... 192 Request Syntax .................................................................................................................................... 192 Request Parameters ........................................................................................................................... 192 Response Syntax ................................................................................................................................. 193 Response Elements ............................................................................................................................ 195 Errors ..................................................................................................................................................... 196 Examples ............................................................................................................................................... 196 See Also ................................................................................................................................................ 198 DescribeAvailablePatches ....................................................................................................................... 199 Request Syntax .................................................................................................................................... 199 Request Parameters ........................................................................................................................... 199 Response Syntax ................................................................................................................................. 202 Response Elements ............................................................................................................................ 203 Errors ..................................................................................................................................................... 203 Examples ............................................................................................................................................... 203 See Also ................................................................................................................................................ 206 DescribeDocument ................................................................................................................................... 208 Request Syntax .................................................................................................................................... 208 Request Parameters ........................................................................................................................... 208 Response Syntax ................................................................................................................................. 209 Response Elements ............................................................................................................................ 210 Errors ..................................................................................................................................................... 210 Examples ............................................................................................................................................... 211 See Also ................................................................................................................................................ 213 DescribeDocumentPermission ............................................................................................................... 214 Request Syntax .................................................................................................................................... 214 Request Parameters ........................................................................................................................... 214 API Version 2014-11-06 x AWS Systems Manager API Reference Response Syntax ................................................................................................................................. 215 Response Elements ............................................................................................................................ 215 Errors ..................................................................................................................................................... 216 Examples ............................................................................................................................................... 217 See Also ................................................................................................................................................ 217 DescribeEﬀectiveInstanceAssociations ................................................................................................. 219 Request Syntax .................................................................................................................................... 219 Request Parameters ........................................................................................................................... 219 Response Syntax ................................................................................................................................. 220 Response Elements ............................................................................................................................ 220 Errors ..................................................................................................................................................... 220 Examples ............................................................................................................................................... 221 See Also ................................................................................................................................................ 222 DescribeEﬀectivePatchesForPatchBaseline ......................................................................................... 223 Request Syntax .................................................................................................................................... 223 Request Parameters ........................................................................................................................... 223 Response Syntax ................................................................................................................................. 224 Response Elements ............................................................................................................................ 225 Errors ..................................................................................................................................................... 225 Examples ............................................................................................................................................... 226 See Also ................................................................................................................................................ 229 DescribeInstanceAssociationsStatus ..................................................................................................... 230 Request Syntax .................................................................................................................................... 230 Request Parameters ........................................................................................................................... 230 Response Syntax ................................................................................................................................. 231 Response Elements ............................................................................................................................ 231 Errors ..................................................................................................................................................... 232 Examples ............................................................................................................................................... 232 See Also ................................................................................................................................................ 233 DescribeInstanceInformation ................................................................................................................. 235 Request Syntax .................................................................................................................................... 235 Request Parameters ........................................................................................................................... 235 Response Syntax ................................................................................................................................. 237 Response Elements ............................................................................................................................ 238 Errors ..................................................................................................................................................... 238 Examples ............................................................................................................................................... 239 API Version 2014-11-06 xi AWS Systems Manager API Reference See Also ................................................................................................................................................ 240 DescribeInstancePatches ......................................................................................................................... 242 Request Syntax .................................................................................................................................... 242 Request Parameters ........................................................................................................................... 242 Response Syntax ................................................................................................................................. 243 Response Elements ............................................................................................................................ 244 Errors ..................................................................................................................................................... 244 Examples ............................................................................................................................................... 245 See Also ................................................................................................................................................ 247 DescribeInstancePatchStates ................................................................................................................. 248 Request Syntax .................................................................................................................................... 248 Request Parameters ........................................................................................................................... 248 Response Syntax ................................................................................................................................. 249 Response Elements ............................................................................................................................ 249 Errors ..................................................................................................................................................... 250 Examples ............................................................................................................................................... 250 See Also ................................................................................................................................................ 252 DescribeInstancePatchStatesForPatchGroup ...................................................................................... 253 Request Syntax .................................................................................................................................... 253 Request Parameters ........................................................................................................................... 253 Response Syntax ................................................................................................................................. 254 Response Elements ............................................................................................................................ 255 Errors ..................................................................................................................................................... 255 Examples ............................................................................................................................................... 256 See Also ................................................................................................................................................ 258 DescribeInstanceProperties .................................................................................................................... 259 Request Syntax .................................................................................................................................... 259 Request Parameters ........................................................................................................................... 259 Response Syntax ................................................................................................................................. 260 Response Elements ............................................................................................................................ 261 Errors ..................................................................................................................................................... 261 See Also ................................................................................................................................................ 263 DescribeInventoryDeletions ................................................................................................................... 264 Request Syntax .................................................................................................................................... 264 Request Parameters ........................................................................................................................... 264 Response Syntax ................................................................................................................................. 265 API Version 2014-11-06 xii
systems-manager-api-003	systems-manager-api.pdf	3	Request Syntax .................................................................................................................................... 248 Request Parameters ........................................................................................................................... 248 Response Syntax ................................................................................................................................. 249 Response Elements ............................................................................................................................ 249 Errors ..................................................................................................................................................... 250 Examples ............................................................................................................................................... 250 See Also ................................................................................................................................................ 252 DescribeInstancePatchStatesForPatchGroup ...................................................................................... 253 Request Syntax .................................................................................................................................... 253 Request Parameters ........................................................................................................................... 253 Response Syntax ................................................................................................................................. 254 Response Elements ............................................................................................................................ 255 Errors ..................................................................................................................................................... 255 Examples ............................................................................................................................................... 256 See Also ................................................................................................................................................ 258 DescribeInstanceProperties .................................................................................................................... 259 Request Syntax .................................................................................................................................... 259 Request Parameters ........................................................................................................................... 259 Response Syntax ................................................................................................................................. 260 Response Elements ............................................................................................................................ 261 Errors ..................................................................................................................................................... 261 See Also ................................................................................................................................................ 263 DescribeInventoryDeletions ................................................................................................................... 264 Request Syntax .................................................................................................................................... 264 Request Parameters ........................................................................................................................... 264 Response Syntax ................................................................................................................................. 265 API Version 2014-11-06 xii AWS Systems Manager API Reference Response Elements ............................................................................................................................ 265 Errors ..................................................................................................................................................... 266 Examples ............................................................................................................................................... 266 See Also ................................................................................................................................................ 267 DescribeMaintenanceWindowExecutions ............................................................................................ 269 Request Syntax .................................................................................................................................... 269 Request Parameters ........................................................................................................................... 269 Response Syntax ................................................................................................................................. 270 Response Elements ............................................................................................................................ 271 Errors ..................................................................................................................................................... 271 Examples ............................................................................................................................................... 271 See Also ................................................................................................................................................ 273 DescribeMaintenanceWindowExecutionTaskInvocations ................................................................. 274 Request Syntax .................................................................................................................................... 274 Request Parameters ........................................................................................................................... 274 Response Syntax ................................................................................................................................. 275 Response Elements ............................................................................................................................ 276 Errors ..................................................................................................................................................... 276 Examples ............................................................................................................................................... 277 See Also ................................................................................................................................................ 278 DescribeMaintenanceWindowExecutionTasks .................................................................................... 279 Request Syntax .................................................................................................................................... 279 Request Parameters ........................................................................................................................... 279 Response Syntax ................................................................................................................................. 280 Response Elements ............................................................................................................................ 281 Errors ..................................................................................................................................................... 281 Examples ............................................................................................................................................... 282 See Also ................................................................................................................................................ 283 DescribeMaintenanceWindows .............................................................................................................. 284 Request Syntax .................................................................................................................................... 284 Request Parameters ........................................................................................................................... 284 Response Syntax ................................................................................................................................. 285 Response Elements ............................................................................................................................ 285 Errors ..................................................................................................................................................... 286 Examples ............................................................................................................................................... 286 See Also ................................................................................................................................................ 288 API Version 2014-11-06 xiii AWS Systems Manager API Reference DescribeMaintenanceWindowSchedule ............................................................................................... 289 Request Syntax .................................................................................................................................... 289 Request Parameters ........................................................................................................................... 289 Response Syntax ................................................................................................................................. 291 Response Elements ............................................................................................................................ 291 Errors ..................................................................................................................................................... 291 Examples ............................................................................................................................................... 292 See Also ................................................................................................................................................ 293 DescribeMaintenanceWindowsForTarget ............................................................................................ 294 Request Syntax .................................................................................................................................... 294 Request Parameters ........................................................................................................................... 294 Response Syntax ................................................................................................................................. 295 Response Elements ............................................................................................................................ 295 Errors ..................................................................................................................................................... 296 Examples ............................................................................................................................................... 296 See Also ................................................................................................................................................ 297 DescribeMaintenanceWindowTargets .................................................................................................. 299 Request Syntax .................................................................................................................................... 299 Request Parameters ........................................................................................................................... 299 Response Syntax ................................................................................................................................. 300 Response Elements ............................................................................................................................ 301 Errors ..................................................................................................................................................... 301 Examples ............................................................................................................................................... 302 See Also ................................................................................................................................................ 303 DescribeMaintenanceWindowTasks ...................................................................................................... 304 Request Syntax .................................................................................................................................... 304 Request Parameters ........................................................................................................................... 304 Response Syntax ................................................................................................................................. 305 Response Elements ............................................................................................................................ 306 Errors ..................................................................................................................................................... 307 Examples ............................................................................................................................................... 307 See Also ................................................................................................................................................ 309 DescribeOpsItems .................................................................................................................................... 310 Request Syntax .................................................................................................................................... 310 Request Parameters ........................................................................................................................... 310 Response Syntax ................................................................................................................................. 312 API Version 2014-11-06 xiv AWS Systems Manager API Reference Response Elements ............................................................................................................................ 313 Errors ..................................................................................................................................................... 313 Examples ............................................................................................................................................... 314 See Also ................................................................................................................................................ 315 DescribeParameters ................................................................................................................................. 317 Request Syntax .................................................................................................................................... 317 Request Parameters ........................................................................................................................... 318 Response Syntax ................................................................................................................................. 319 Response Elements ............................................................................................................................ 320 Errors ..................................................................................................................................................... 320 Examples ............................................................................................................................................... 321 See Also ................................................................................................................................................ 323 DescribePatchBaselines ........................................................................................................................... 325 Request Syntax .................................................................................................................................... 325 Request Parameters ........................................................................................................................... 325 Response Syntax ................................................................................................................................. 326 Response Elements ............................................................................................................................ 326 Errors ..................................................................................................................................................... 327 Examples ............................................................................................................................................... 327 See Also ................................................................................................................................................ 329 DescribePatchGroups ............................................................................................................................... 330 Request Syntax .................................................................................................................................... 330 Request Parameters ........................................................................................................................... 330 Response Syntax ................................................................................................................................. 331 Response Elements ............................................................................................................................ 331 Errors ..................................................................................................................................................... 332 Examples ............................................................................................................................................... 332 See Also ................................................................................................................................................ 334 DescribePatchGroupState ....................................................................................................................... 335 Request Syntax .................................................................................................................................... 335 Request Parameters ........................................................................................................................... 335 Response Syntax ................................................................................................................................. 335 Response Elements ............................................................................................................................ 336 Errors ..................................................................................................................................................... 338 Examples ............................................................................................................................................... 338 See Also ................................................................................................................................................ 339 API Version 2014-11-06 xv AWS Systems Manager API Reference DescribePatchProperties ......................................................................................................................... 341 Request Syntax .................................................................................................................................... 342 Request Parameters ........................................................................................................................... 342 Response Syntax ................................................................................................................................. 343 Response Elements ............................................................................................................................ 343 Errors ..................................................................................................................................................... 344 Examples ............................................................................................................................................... 344 See Also ................................................................................................................................................ 345 DescribeSessions ...................................................................................................................................... 347 Request Syntax .................................................................................................................................... 347 Request Parameters ........................................................................................................................... 347 Response Syntax ................................................................................................................................. 348 Response Elements ............................................................................................................................ 349 Errors ..................................................................................................................................................... 349 Examples ............................................................................................................................................... 350 See Also ................................................................................................................................................ 351 DisassociateOpsItemRelatedItem ......................................................................................................... 352 Request Syntax .................................................................................................................................... 352 Request Parameters ........................................................................................................................... 352 Response Elements ............................................................................................................................ 352 Errors ..................................................................................................................................................... 353 Examples ............................................................................................................................................... 353 See Also ................................................................................................................................................ 354 GetAccessToken ........................................................................................................................................ 355 Request Syntax .................................................................................................................................... 355 Request Parameters ........................................................................................................................... 355 Response Syntax ................................................................................................................................. 355 Response Elements ............................................................................................................................ 355 Errors ..................................................................................................................................................... 356 See Also ................................................................................................................................................ 357 GetAutomationExecution ....................................................................................................................... 358 Request Syntax .................................................................................................................................... 358 Request Parameters ........................................................................................................................... 358 Response Syntax ................................................................................................................................. 358 Response Elements ............................................................................................................................ 364 Errors ..................................................................................................................................................... 364 API Version 2014-11-06 xvi AWS Systems Manager API Reference Examples ............................................................................................................................................... 364 See Also ................................................................................................................................................ 366 GetCalendarState ..................................................................................................................................... 368 Request Syntax .................................................................................................................................... 368 Request Parameters ........................................................................................................................... 368 Response Syntax ................................................................................................................................. 369 Response Elements ............................................................................................................................ 369 Errors ..................................................................................................................................................... 370 Examples ............................................................................................................................................... 370 See Also ................................................................................................................................................ 371 GetCommandInvocation ......................................................................................................................... 372 Request Syntax .................................................................................................................................... 372 Request Parameters ........................................................................................................................... 372 Response Syntax ................................................................................................................................. 373 Response Elements ............................................................................................................................ 374 Errors ..................................................................................................................................................... 378 Examples ............................................................................................................................................... 379 See Also ................................................................................................................................................ 381 GetConnectionStatus ............................................................................................................................... 382 Request Syntax .................................................................................................................................... 382 Request Parameters ........................................................................................................................... 382 Response Syntax ................................................................................................................................. 382 Response Elements ............................................................................................................................ 382 Errors ..................................................................................................................................................... 383 Examples ............................................................................................................................................... 383 See Also ................................................................................................................................................ 384 GetDefaultPatchBaseline ........................................................................................................................ 385 Request Syntax .................................................................................................................................... 385 Request Parameters ........................................................................................................................... 385 Response Syntax ................................................................................................................................. 385 Response Elements ............................................................................................................................ 385 Errors ..................................................................................................................................................... 386 Examples ............................................................................................................................................... 386 See Also ................................................................................................................................................ 387 GetDeployablePatchSnapshotForInstance .......................................................................................... 389 Request Syntax .................................................................................................................................... 389 API Version 2014-11-06 xvii AWS Systems Manager
systems-manager-api-004	systems-manager-api.pdf	4	......................................................................................................................... 372 Request Syntax .................................................................................................................................... 372 Request Parameters ........................................................................................................................... 372 Response Syntax ................................................................................................................................. 373 Response Elements ............................................................................................................................ 374 Errors ..................................................................................................................................................... 378 Examples ............................................................................................................................................... 379 See Also ................................................................................................................................................ 381 GetConnectionStatus ............................................................................................................................... 382 Request Syntax .................................................................................................................................... 382 Request Parameters ........................................................................................................................... 382 Response Syntax ................................................................................................................................. 382 Response Elements ............................................................................................................................ 382 Errors ..................................................................................................................................................... 383 Examples ............................................................................................................................................... 383 See Also ................................................................................................................................................ 384 GetDefaultPatchBaseline ........................................................................................................................ 385 Request Syntax .................................................................................................................................... 385 Request Parameters ........................................................................................................................... 385 Response Syntax ................................................................................................................................. 385 Response Elements ............................................................................................................................ 385 Errors ..................................................................................................................................................... 386 Examples ............................................................................................................................................... 386 See Also ................................................................................................................................................ 387 GetDeployablePatchSnapshotForInstance .......................................................................................... 389 Request Syntax .................................................................................................................................... 389 API Version 2014-11-06 xvii AWS Systems Manager API Reference Request Parameters ........................................................................................................................... 390 Response Syntax ................................................................................................................................. 391 Response Elements ............................................................................................................................ 391 Errors ..................................................................................................................................................... 392 Examples ............................................................................................................................................... 393 See Also ................................................................................................................................................ 393 GetDocument ............................................................................................................................................ 395 Request Syntax .................................................................................................................................... 395 Request Parameters ........................................................................................................................... 395 Response Syntax ................................................................................................................................. 396 Response Elements ............................................................................................................................ 397 Errors ..................................................................................................................................................... 399 Examples ............................................................................................................................................... 400 See Also ................................................................................................................................................ 401 GetExecutionPreview ............................................................................................................................... 402 Request Syntax .................................................................................................................................... 402 Request Parameters ........................................................................................................................... 402 Response Syntax ................................................................................................................................. 402 Response Elements ............................................................................................................................ 403 Errors ..................................................................................................................................................... 404 Examples ............................................................................................................................................... 404 See Also ................................................................................................................................................ 405 GetInventory ............................................................................................................................................. 406 Request Syntax .................................................................................................................................... 406 Request Parameters ........................................................................................................................... 407 Response Syntax ................................................................................................................................. 408 Response Elements ............................................................................................................................ 408 Errors ..................................................................................................................................................... 409 Examples ............................................................................................................................................... 410 See Also ................................................................................................................................................ 411 GetInventorySchema ............................................................................................................................... 412 Request Syntax .................................................................................................................................... 412 Request Parameters ........................................................................................................................... 412 Response Syntax ................................................................................................................................. 413 Response Elements ............................................................................................................................ 414 Errors ..................................................................................................................................................... 414 API Version 2014-11-06 xviii AWS Systems Manager API Reference Examples ............................................................................................................................................... 415 See Also ................................................................................................................................................ 417 GetMaintenanceWindow ......................................................................................................................... 418 Request Syntax .................................................................................................................................... 418 Request Parameters ........................................................................................................................... 418 Response Syntax ................................................................................................................................. 418 Response Elements ............................................................................................................................ 419 Errors ..................................................................................................................................................... 421 Examples ............................................................................................................................................... 422 See Also ................................................................................................................................................ 423 GetMaintenanceWindowExecution ....................................................................................................... 424 Request Syntax .................................................................................................................................... 424 Request Parameters ........................................................................................................................... 424 Response Syntax ................................................................................................................................. 424 Response Elements ............................................................................................................................ 425 Errors ..................................................................................................................................................... 426 Examples ............................................................................................................................................... 426 See Also ................................................................................................................................................ 427 GetMaintenanceWindowExecutionTask ............................................................................................... 429 Request Syntax .................................................................................................................................... 429 Request Parameters ........................................................................................................................... 429 Response Syntax ................................................................................................................................. 430 Response Elements ............................................................................................................................ 430 Errors ..................................................................................................................................................... 433 Examples ............................................................................................................................................... 434 See Also ................................................................................................................................................ 436 GetMaintenanceWindowExecutionTaskInvocation ............................................................................ 437 Request Syntax .................................................................................................................................... 437 Request Parameters ........................................................................................................................... 437 Response Syntax ................................................................................................................................. 438 Response Elements ............................................................................................................................ 438 Errors ..................................................................................................................................................... 441 Examples ............................................................................................................................................... 441 See Also ................................................................................................................................................ 442 GetMaintenanceWindowTask ................................................................................................................. 443 Request Syntax .................................................................................................................................... 443 API Version 2014-11-06 xix AWS Systems Manager API Reference Request Parameters ........................................................................................................................... 443 Response Syntax ................................................................................................................................. 444 Response Elements ............................................................................................................................ 446 Errors ..................................................................................................................................................... 450 Examples ............................................................................................................................................... 450 See Also ................................................................................................................................................ 452 GetOpsItem ............................................................................................................................................... 453 Request Syntax .................................................................................................................................... 453 Request Parameters ........................................................................................................................... 453 Response Syntax ................................................................................................................................. 454 Response Elements ............................................................................................................................ 455 Errors ..................................................................................................................................................... 455 Examples ............................................................................................................................................... 456 See Also ................................................................................................................................................ 457 GetOpsMetadata ...................................................................................................................................... 459 Request Syntax .................................................................................................................................... 459 Request Parameters ........................................................................................................................... 459 Response Syntax ................................................................................................................................. 460 Response Elements ............................................................................................................................ 460 Errors ..................................................................................................................................................... 461 See Also ................................................................................................................................................ 461 GetOpsSummary ...................................................................................................................................... 463 Request Syntax .................................................................................................................................... 463 Request Parameters ........................................................................................................................... 464 Response Syntax ................................................................................................................................. 465 Response Elements ............................................................................................................................ 466 Errors ..................................................................................................................................................... 466 Examples ............................................................................................................................................... 467 See Also ................................................................................................................................................ 468 GetParameter ............................................................................................................................................ 470 Request Syntax .................................................................................................................................... 470 Request Parameters ........................................................................................................................... 470 Response Syntax ................................................................................................................................. 471 Response Elements ............................................................................................................................ 471 Errors ..................................................................................................................................................... 471 Examples ............................................................................................................................................... 472 API Version 2014-11-06 xx AWS Systems Manager API Reference See Also ................................................................................................................................................ 473 GetParameterHistory ............................................................................................................................... 475 Request Syntax .................................................................................................................................... 475 Request Parameters ........................................................................................................................... 475 Response Syntax ................................................................................................................................. 476 Response Elements ............................................................................................................................ 477 Errors ..................................................................................................................................................... 477 Examples ............................................................................................................................................... 478 See Also ................................................................................................................................................ 479 GetParameters .......................................................................................................................................... 481 Request Syntax .................................................................................................................................... 481 Request Parameters ........................................................................................................................... 481 Response Syntax ................................................................................................................................. 482 Response Elements ............................................................................................................................ 482 Errors ..................................................................................................................................................... 483 Examples ............................................................................................................................................... 483 See Also ................................................................................................................................................ 485 GetParametersByPath ............................................................................................................................. 486 Request Syntax .................................................................................................................................... 486 Request Parameters ........................................................................................................................... 486 Response Syntax ................................................................................................................................. 488 Response Elements ............................................................................................................................ 489 Errors ..................................................................................................................................................... 489 Examples ............................................................................................................................................... 490 See Also ................................................................................................................................................ 491 GetPatchBaseline ..................................................................................................................................... 493 Request Syntax .................................................................................................................................... 493 Request Parameters ........................................................................................................................... 493 Response Syntax ................................................................................................................................. 493 Response Elements ............................................................................................................................ 495 Errors ..................................................................................................................................................... 498 Examples ............................................................................................................................................... 498 See Also ................................................................................................................................................ 500 GetPatchBaselineForPatchGroup .......................................................................................................... 502 Request Syntax .................................................................................................................................... 502 Request Parameters ........................................................................................................................... 502 API Version 2014-11-06 xxi AWS Systems Manager API Reference Response Syntax ................................................................................................................................. 503 Response Elements ............................................................................................................................ 503 Errors ..................................................................................................................................................... 504 Examples ............................................................................................................................................... 504 See Also ................................................................................................................................................ 505 GetResourcePolicies ................................................................................................................................. 506 Request Syntax .................................................................................................................................... 506 Request Parameters ........................................................................................................................... 506 Response Syntax ................................................................................................................................. 507 Response Elements ............................................................................................................................ 507 Errors ..................................................................................................................................................... 507 See Also ................................................................................................................................................ 508 GetServiceSetting ..................................................................................................................................... 509 Request Syntax .................................................................................................................................... 509 Request Parameters ........................................................................................................................... 509 Response Syntax ................................................................................................................................. 510 Response Elements ............................................................................................................................ 510 Errors ..................................................................................................................................................... 510 Examples ............................................................................................................................................... 511 See Also ................................................................................................................................................ 512 LabelParameterVersion ........................................................................................................................... 513 Request Syntax .................................................................................................................................... 513 Request Parameters ........................................................................................................................... 513 Response Syntax ................................................................................................................................. 514 Response Elements ............................................................................................................................ 515 Errors ..................................................................................................................................................... 515 Examples ............................................................................................................................................... 516 See Also ................................................................................................................................................ 517 ListAssociations ........................................................................................................................................ 518 Request Syntax .................................................................................................................................... 518 Request Parameters ........................................................................................................................... 518 Response Syntax ................................................................................................................................. 519 Response Elements ............................................................................................................................ 520 Errors ..................................................................................................................................................... 520 Examples ............................................................................................................................................... 521 See Also ................................................................................................................................................ 522 API Version 2014-11-06 xxii AWS Systems Manager API
systems-manager-api-005	systems-manager-api.pdf	5	507 See Also ................................................................................................................................................ 508 GetServiceSetting ..................................................................................................................................... 509 Request Syntax .................................................................................................................................... 509 Request Parameters ........................................................................................................................... 509 Response Syntax ................................................................................................................................. 510 Response Elements ............................................................................................................................ 510 Errors ..................................................................................................................................................... 510 Examples ............................................................................................................................................... 511 See Also ................................................................................................................................................ 512 LabelParameterVersion ........................................................................................................................... 513 Request Syntax .................................................................................................................................... 513 Request Parameters ........................................................................................................................... 513 Response Syntax ................................................................................................................................. 514 Response Elements ............................................................................................................................ 515 Errors ..................................................................................................................................................... 515 Examples ............................................................................................................................................... 516 See Also ................................................................................................................................................ 517 ListAssociations ........................................................................................................................................ 518 Request Syntax .................................................................................................................................... 518 Request Parameters ........................................................................................................................... 518 Response Syntax ................................................................................................................................. 519 Response Elements ............................................................................................................................ 520 Errors ..................................................................................................................................................... 520 Examples ............................................................................................................................................... 521 See Also ................................................................................................................................................ 522 API Version 2014-11-06 xxii AWS Systems Manager API Reference ListAssociationVersions ........................................................................................................................... 523 Request Syntax .................................................................................................................................... 523 Request Parameters ........................................................................................................................... 523 Response Syntax ................................................................................................................................. 524 Response Elements ............................................................................................................................ 525 Errors ..................................................................................................................................................... 526 Examples ............................................................................................................................................... 526 See Also ................................................................................................................................................ 528 ListCommandInvocations ....................................................................................................................... 529 Request Syntax .................................................................................................................................... 529 Request Parameters ........................................................................................................................... 529 Response Syntax ................................................................................................................................. 531 Response Elements ............................................................................................................................ 532 Errors ..................................................................................................................................................... 532 Examples ............................................................................................................................................... 533 See Also ................................................................................................................................................ 535 ListCommands .......................................................................................................................................... 537 Request Syntax .................................................................................................................................... 537 Request Parameters ........................................................................................................................... 537 Response Syntax ................................................................................................................................. 538 Response Elements ............................................................................................................................ 540 Errors ..................................................................................................................................................... 540 Examples ............................................................................................................................................... 541 See Also ................................................................................................................................................ 543 ListComplianceItems ............................................................................................................................... 544 Request Syntax .................................................................................................................................... 544 Request Parameters ........................................................................................................................... 544 Response Syntax ................................................................................................................................. 545 Response Elements ............................................................................................................................ 546 Errors ..................................................................................................................................................... 546 Examples ............................................................................................................................................... 547 See Also ................................................................................................................................................ 549 ListComplianceSummaries ..................................................................................................................... 550 Request Syntax .................................................................................................................................... 550 Request Parameters ........................................................................................................................... 550 Response Syntax ................................................................................................................................. 551 API Version 2014-11-06 xxiii AWS Systems Manager API Reference Response Elements ............................................................................................................................ 552 Errors ..................................................................................................................................................... 552 Examples ............................................................................................................................................... 553 See Also ................................................................................................................................................ 555 ListDocumentMetadataHistory .............................................................................................................. 556 Request Syntax .................................................................................................................................... 556 Request Parameters ........................................................................................................................... 556 Response Syntax ................................................................................................................................. 557 Response Elements ............................................................................................................................ 558 Errors ..................................................................................................................................................... 559 Examples ............................................................................................................................................... 559 See Also ................................................................................................................................................ 560 ListDocuments .......................................................................................................................................... 562 Request Syntax .................................................................................................................................... 562 Request Parameters ........................................................................................................................... 562 Response Syntax ................................................................................................................................. 563 Response Elements ............................................................................................................................ 564 Errors ..................................................................................................................................................... 565 Examples ............................................................................................................................................... 565 See Also ................................................................................................................................................ 567 ListDocumentVersions ............................................................................................................................. 568 Request Syntax .................................................................................................................................... 568 Request Parameters ........................................................................................................................... 568 Response Syntax ................................................................................................................................. 569 Response Elements ............................................................................................................................ 569 Errors ..................................................................................................................................................... 570 Examples ............................................................................................................................................... 570 See Also ................................................................................................................................................ 571 ListInventoryEntries ................................................................................................................................. 572 Request Syntax .................................................................................................................................... 572 Request Parameters ........................................................................................................................... 572 Response Syntax ................................................................................................................................. 573 Response Elements ............................................................................................................................ 574 Errors ..................................................................................................................................................... 575 Examples ............................................................................................................................................... 576 See Also ................................................................................................................................................ 578 API Version 2014-11-06 xxiv AWS Systems Manager API Reference ListNodes ................................................................................................................................................... 579 Request Syntax .................................................................................................................................... 579 Request Parameters ........................................................................................................................... 579 Response Syntax ................................................................................................................................. 580 Response Elements ............................................................................................................................ 581 Errors ..................................................................................................................................................... 581 Examples ............................................................................................................................................... 582 See Also ................................................................................................................................................ 583 ListNodesSummary .................................................................................................................................. 585 Request Syntax .................................................................................................................................... 585 Request Parameters ........................................................................................................................... 585 Response Syntax ................................................................................................................................. 587 Response Elements ............................................................................................................................ 587 Errors ..................................................................................................................................................... 588 Examples ............................................................................................................................................... 588 See Also ................................................................................................................................................ 590 ListOpsItemEvents ................................................................................................................................... 591 Request Syntax .................................................................................................................................... 591 Request Parameters ........................................................................................................................... 591 Response Syntax ................................................................................................................................. 592 Response Elements ............................................................................................................................ 592 Errors ..................................................................................................................................................... 593 See Also ................................................................................................................................................ 593 ListOpsItemRelatedItems ....................................................................................................................... 595 Request Syntax .................................................................................................................................... 595 Request Parameters ........................................................................................................................... 595 Response Syntax ................................................................................................................................. 596 Response Elements ............................................................................................................................ 597 Errors ..................................................................................................................................................... 597 Examples ............................................................................................................................................... 597 See Also ................................................................................................................................................ 599 ListOpsMetadata ...................................................................................................................................... 600 Request Syntax .................................................................................................................................... 600 Request Parameters ........................................................................................................................... 600 Response Syntax ................................................................................................................................. 601 Response Elements ............................................................................................................................ 601 API Version 2014-11-06 xxv AWS Systems Manager API Reference Errors ..................................................................................................................................................... 602 See Also ................................................................................................................................................ 602 ListResourceComplianceSummaries ..................................................................................................... 603 Request Syntax .................................................................................................................................... 603 Request Parameters ........................................................................................................................... 603 Response Syntax ................................................................................................................................. 604 Response Elements ............................................................................................................................ 605 Errors ..................................................................................................................................................... 605 Examples ............................................................................................................................................... 606 See Also ................................................................................................................................................ 608 ListResourceDataSync .............................................................................................................................. 609 Request Syntax .................................................................................................................................... 609 Request Parameters ........................................................................................................................... 609 Response Syntax ................................................................................................................................. 610 Response Elements ............................................................................................................................ 611 Errors ..................................................................................................................................................... 611 Examples ............................................................................................................................................... 612 See Also ................................................................................................................................................ 613 ListTagsForResource ................................................................................................................................ 614 Request Syntax .................................................................................................................................... 614 Request Parameters ........................................................................................................................... 614 Response Syntax ................................................................................................................................. 614 Response Elements ............................................................................................................................ 615 Errors ..................................................................................................................................................... 615 Examples ............................................................................................................................................... 616 See Also ................................................................................................................................................ 617 ModifyDocumentPermission .................................................................................................................. 618 Request Syntax .................................................................................................................................... 618 Request Parameters ........................................................................................................................... 618 Response Elements ............................................................................................................................ 620 Errors ..................................................................................................................................................... 620 Examples ............................................................................................................................................... 621 See Also ................................................................................................................................................ 621 PutComplianceItems ................................................................................................................................ 623 Request Syntax .................................................................................................................................... 623 Request Parameters ........................................................................................................................... 624 API Version 2014-11-06 xxvi AWS Systems Manager API Reference Response Elements ............................................................................................................................ 626 Errors ..................................................................................................................................................... 626 Examples ............................................................................................................................................... 627 See Also ................................................................................................................................................ 628 PutInventory .............................................................................................................................................. 630 Request Syntax .................................................................................................................................... 630 Request Parameters ........................................................................................................................... 630 Response Syntax ................................................................................................................................. 631 Response Elements ............................................................................................................................ 631 Errors ..................................................................................................................................................... 631 Examples ............................................................................................................................................... 633 See Also ................................................................................................................................................ 634 PutParameter ............................................................................................................................................ 635 Request Syntax .................................................................................................................................... 635 Request Parameters ........................................................................................................................... 635 Response Syntax ................................................................................................................................. 642 Response Elements ............................................................................................................................ 642 Errors ..................................................................................................................................................... 643 Examples ............................................................................................................................................... 646 See Also ................................................................................................................................................ 646 PutResourcePolicy .................................................................................................................................... 648 Request Syntax .................................................................................................................................... 648 Request Parameters ........................................................................................................................... 649 Response Syntax ................................................................................................................................. 650 Response Elements ............................................................................................................................ 650 Errors ..................................................................................................................................................... 650 See Also ................................................................................................................................................ 651 RegisterDefaultPatchBaseline ................................................................................................................ 653 Request Syntax .................................................................................................................................... 653 Request Parameters ........................................................................................................................... 653 Response Syntax ................................................................................................................................. 653 Response Elements ............................................................................................................................ 654 Errors ..................................................................................................................................................... 654 Examples ............................................................................................................................................... 655 See Also ................................................................................................................................................ 655 RegisterPatchBaselineForPatchGroup .................................................................................................. 657 API Version 2014-11-06 xxvii AWS Systems Manager API Reference Request
systems-manager-api-006	systems-manager-api.pdf	6	Also ................................................................................................................................................ 634 PutParameter ............................................................................................................................................ 635 Request Syntax .................................................................................................................................... 635 Request Parameters ........................................................................................................................... 635 Response Syntax ................................................................................................................................. 642 Response Elements ............................................................................................................................ 642 Errors ..................................................................................................................................................... 643 Examples ............................................................................................................................................... 646 See Also ................................................................................................................................................ 646 PutResourcePolicy .................................................................................................................................... 648 Request Syntax .................................................................................................................................... 648 Request Parameters ........................................................................................................................... 649 Response Syntax ................................................................................................................................. 650 Response Elements ............................................................................................................................ 650 Errors ..................................................................................................................................................... 650 See Also ................................................................................................................................................ 651 RegisterDefaultPatchBaseline ................................................................................................................ 653 Request Syntax .................................................................................................................................... 653 Request Parameters ........................................................................................................................... 653 Response Syntax ................................................................................................................................. 653 Response Elements ............................................................................................................................ 654 Errors ..................................................................................................................................................... 654 Examples ............................................................................................................................................... 655 See Also ................................................................................................................................................ 655 RegisterPatchBaselineForPatchGroup .................................................................................................. 657 API Version 2014-11-06 xxvii AWS Systems Manager API Reference Request Syntax .................................................................................................................................... 657 Request Parameters ........................................................................................................................... 657 Response Syntax ................................................................................................................................. 658 Response Elements ............................................................................................................................ 658 Errors ..................................................................................................................................................... 658 Examples ............................................................................................................................................... 659 See Also ................................................................................................................................................ 660 RegisterTargetWithMaintenanceWindow ............................................................................................ 661 Request Syntax .................................................................................................................................... 661 Request Parameters ........................................................................................................................... 661 Response Syntax ................................................................................................................................. 664 Response Elements ............................................................................................................................ 664 Errors ..................................................................................................................................................... 664 Examples ............................................................................................................................................... 665 See Also ................................................................................................................................................ 666 RegisterTaskWithMaintenanceWindow ................................................................................................ 668 Request Syntax .................................................................................................................................... 668 Request Parameters ........................................................................................................................... 669 Response Syntax ................................................................................................................................. 675 Response Elements ............................................................................................................................ 675 Errors ..................................................................................................................................................... 676 Examples ............................................................................................................................................... 677 See Also ................................................................................................................................................ 678 RemoveTagsFromResource ..................................................................................................................... 679 Request Syntax .................................................................................................................................... 679 Request Parameters ........................................................................................................................... 679 Response Elements ............................................................................................................................ 681 Errors ..................................................................................................................................................... 681 Examples ............................................................................................................................................... 681 See Also ................................................................................................................................................ 682 ResetServiceSetting ................................................................................................................................. 683 Request Syntax .................................................................................................................................... 683 Request Parameters ........................................................................................................................... 683 Response Syntax ................................................................................................................................. 684 Response Elements ............................................................................................................................ 684 Errors ..................................................................................................................................................... 684 API Version 2014-11-06 xxviii AWS Systems Manager API Reference Examples ............................................................................................................................................... 685 See Also ................................................................................................................................................ 686 ResumeSession ......................................................................................................................................... 687 Request Syntax .................................................................................................................................... 687 Request Parameters ........................................................................................................................... 687 Response Syntax ................................................................................................................................. 687 Response Elements ............................................................................................................................ 688 Errors ..................................................................................................................................................... 688 Examples ............................................................................................................................................... 689 See Also ................................................................................................................................................ 690 SendAutomationSignal ........................................................................................................................... 691 Request Syntax .................................................................................................................................... 691 Request Parameters ........................................................................................................................... 691 Response Elements ............................................................................................................................ 692 Errors ..................................................................................................................................................... 692 Examples ............................................................................................................................................... 693 See Also ................................................................................................................................................ 694 SendCommand ......................................................................................................................................... 695 Request Syntax .................................................................................................................................... 695 Request Parameters ........................................................................................................................... 696 Response Syntax ................................................................................................................................. 701 Response Elements ............................................................................................................................ 703 Errors ..................................................................................................................................................... 703 Examples ............................................................................................................................................... 705 See Also ................................................................................................................................................ 707 StartAccessRequest .................................................................................................................................. 709 Request Syntax .................................................................................................................................... 709 Request Parameters ........................................................................................................................... 709 Response Syntax ................................................................................................................................. 710 Response Elements ............................................................................................................................ 710 Errors ..................................................................................................................................................... 710 See Also ................................................................................................................................................ 711 StartAssociationsOnce ............................................................................................................................ 713 Request Syntax .................................................................................................................................... 713 Request Parameters ........................................................................................................................... 713 Response Elements ............................................................................................................................ 713 API Version 2014-11-06 xxix AWS Systems Manager API Reference Errors ..................................................................................................................................................... 713 Examples ............................................................................................................................................... 714 See Also ................................................................................................................................................ 714 StartAutomationExecution ..................................................................................................................... 716 Request Syntax .................................................................................................................................... 716 Request Parameters ........................................................................................................................... 717 Response Syntax ................................................................................................................................. 722 Response Elements ............................................................................................................................ 722 Errors ..................................................................................................................................................... 723 Examples ............................................................................................................................................... 724 See Also ................................................................................................................................................ 725 StartChangeRequestExecution .............................................................................................................. 726 Request Syntax .................................................................................................................................... 726 Request Parameters ........................................................................................................................... 727 Response Syntax ................................................................................................................................. 731 Response Elements ............................................................................................................................ 731 Errors ..................................................................................................................................................... 732 Examples ............................................................................................................................................... 733 See Also ................................................................................................................................................ 734 StartExecutionPreview ............................................................................................................................ 736 Request Syntax .................................................................................................................................... 736 Request Parameters ........................................................................................................................... 736 Response Syntax ................................................................................................................................. 737 Response Elements ............................................................................................................................ 737 Errors ..................................................................................................................................................... 737 Examples ............................................................................................................................................... 738 See Also ................................................................................................................................................ 738 StartSession ............................................................................................................................................... 740 Request Syntax .................................................................................................................................... 740 Request Parameters ........................................................................................................................... 740 Response Syntax ................................................................................................................................. 742 Response Elements ............................................................................................................................ 742 Errors ..................................................................................................................................................... 743 Examples ............................................................................................................................................... 743 See Also ................................................................................................................................................ 744 StopAutomationExecution ..................................................................................................................... 745 API Version 2014-11-06 xxx AWS Systems Manager API Reference Request Syntax .................................................................................................................................... 745 Request Parameters ........................................................................................................................... 745 Response Elements ............................................................................................................................ 745 Errors ..................................................................................................................................................... 746 Examples ............................................................................................................................................... 746 See Also ................................................................................................................................................ 747 TerminateSession ..................................................................................................................................... 748 Request Syntax .................................................................................................................................... 748 Request Parameters ........................................................................................................................... 748 Response Syntax ................................................................................................................................. 748 Response Elements ............................................................................................................................ 748 Errors ..................................................................................................................................................... 749 Examples ............................................................................................................................................... 749 See Also ................................................................................................................................................ 750 UnlabelParameterVersion ....................................................................................................................... 751 Request Syntax .................................................................................................................................... 751 Request Parameters ........................................................................................................................... 751 Response Syntax ................................................................................................................................. 752 Response Elements ............................................................................................................................ 752 Errors ..................................................................................................................................................... 753 Examples ............................................................................................................................................... 753 See Also ................................................................................................................................................ 754 UpdateAssociation ................................................................................................................................... 756 Request Syntax .................................................................................................................................... 756 Request Parameters ........................................................................................................................... 758 Response Syntax ................................................................................................................................. 765 Response Elements ............................................................................................................................ 768 Errors ..................................................................................................................................................... 768 Examples ............................................................................................................................................... 770 See Also ................................................................................................................................................ 771 UpdateAssociationStatus ........................................................................................................................ 772 Request Syntax .................................................................................................................................... 772 Request Parameters ........................................................................................................................... 772 Response Syntax ................................................................................................................................. 773 Response Elements ............................................................................................................................ 775 Errors ..................................................................................................................................................... 775 API Version 2014-11-06 xxxi AWS Systems Manager API Reference See Also ................................................................................................................................................ 776 UpdateDocument ..................................................................................................................................... 778 Request Syntax .................................................................................................................................... 778 Request Parameters ........................................................................................................................... 778 Response Syntax ................................................................................................................................. 780 Response Elements ............................................................................................................................ 782 Errors ..................................................................................................................................................... 782 Examples ............................................................................................................................................... 784 See Also ................................................................................................................................................ 785 UpdateDocumentDefaultVersion .......................................................................................................... 787 Request Syntax .................................................................................................................................... 787 Request Parameters ........................................................................................................................... 787 Response Syntax ................................................................................................................................. 788 Response Elements ............................................................................................................................ 788 Errors ..................................................................................................................................................... 788 Examples ............................................................................................................................................... 789 See Also ................................................................................................................................................ 790 UpdateDocumentMetadata .................................................................................................................... 791 Request Syntax .................................................................................................................................... 791 Request Parameters ........................................................................................................................... 791 Response Elements ............................................................................................................................ 792 Errors ..................................................................................................................................................... 792 Examples ............................................................................................................................................... 793 See Also ................................................................................................................................................ 793 UpdateMaintenanceWindow .................................................................................................................. 795 Request Syntax .................................................................................................................................... 795 Request Parameters ........................................................................................................................... 795 Response Syntax ................................................................................................................................. 799 Response Elements ............................................................................................................................ 799 Errors ..................................................................................................................................................... 801 Examples ............................................................................................................................................... 802 See Also ................................................................................................................................................ 803 UpdateMaintenanceWindowTarget ...................................................................................................... 804 Request Syntax .................................................................................................................................... 804 Request Parameters ........................................................................................................................... 804 Response Syntax ................................................................................................................................. 806 API Version 2014-11-06 xxxii AWS Systems Manager API Reference Response Elements ............................................................................................................................
systems-manager-api-007	systems-manager-api.pdf	7	787 Response Syntax ................................................................................................................................. 788 Response Elements ............................................................................................................................ 788 Errors ..................................................................................................................................................... 788 Examples ............................................................................................................................................... 789 See Also ................................................................................................................................................ 790 UpdateDocumentMetadata .................................................................................................................... 791 Request Syntax .................................................................................................................................... 791 Request Parameters ........................................................................................................................... 791 Response Elements ............................................................................................................................ 792 Errors ..................................................................................................................................................... 792 Examples ............................................................................................................................................... 793 See Also ................................................................................................................................................ 793 UpdateMaintenanceWindow .................................................................................................................. 795 Request Syntax .................................................................................................................................... 795 Request Parameters ........................................................................................................................... 795 Response Syntax ................................................................................................................................. 799 Response Elements ............................................................................................................................ 799 Errors ..................................................................................................................................................... 801 Examples ............................................................................................................................................... 802 See Also ................................................................................................................................................ 803 UpdateMaintenanceWindowTarget ...................................................................................................... 804 Request Syntax .................................................................................................................................... 804 Request Parameters ........................................................................................................................... 804 Response Syntax ................................................................................................................................. 806 API Version 2014-11-06 xxxii AWS Systems Manager API Reference Response Elements ............................................................................................................................ 807 Errors ..................................................................................................................................................... 808 Examples ............................................................................................................................................... 809 See Also ................................................................................................................................................ 810 UpdateMaintenanceWindowTask .......................................................................................................... 811 Request Syntax .................................................................................................................................... 812 Request Parameters ........................................................................................................................... 814 Response Syntax ................................................................................................................................. 820 Response Elements ............................................................................................................................ 822 Errors ..................................................................................................................................................... 825 Examples ............................................................................................................................................... 826 See Also ................................................................................................................................................ 827 UpdateManagedInstanceRole ................................................................................................................ 829 Request Syntax .................................................................................................................................... 829 Request Parameters ........................................................................................................................... 829 Response Elements ............................................................................................................................ 830 Errors ..................................................................................................................................................... 830 Examples ............................................................................................................................................... 830 See Also ................................................................................................................................................ 831 UpdateOpsItem ........................................................................................................................................ 833 Request Syntax .................................................................................................................................... 833 Request Parameters ........................................................................................................................... 834 Response Elements ............................................................................................................................ 838 Errors ..................................................................................................................................................... 838 Examples ............................................................................................................................................... 839 See Also ................................................................................................................................................ 840 UpdateOpsMetadata ............................................................................................................................... 841 Request Syntax .................................................................................................................................... 841 Request Parameters ........................................................................................................................... 841 Response Syntax ................................................................................................................................. 842 Response Elements ............................................................................................................................ 842 Errors ..................................................................................................................................................... 843 See Also ................................................................................................................................................ 843 UpdatePatchBaseline ............................................................................................................................... 845 Request Syntax .................................................................................................................................... 845 Request Parameters ........................................................................................................................... 846 API Version 2014-11-06 xxxiii AWS Systems Manager API Reference Response Syntax ................................................................................................................................. 850 Response Elements ............................................................................................................................ 851 Errors ..................................................................................................................................................... 854 Examples ............................................................................................................................................... 855 See Also ................................................................................................................................................ 857 UpdateResourceDataSync ....................................................................................................................... 858 Request Syntax .................................................................................................................................... 858 Request Parameters ........................................................................................................................... 858 Response Elements ............................................................................................................................ 859 Errors ..................................................................................................................................................... 859 Examples ............................................................................................................................................... 860 See Also ................................................................................................................................................ 861 UpdateServiceSetting .............................................................................................................................. 862 Request Syntax .................................................................................................................................... 862 Request Parameters ........................................................................................................................... 862 Response Elements ............................................................................................................................ 864 Errors ..................................................................................................................................................... 864 Examples ............................................................................................................................................... 864 See Also ................................................................................................................................................ 865 Data Types ................................................................................................................................... 867 AccountSharingInfo ................................................................................................................................. 873 Contents ............................................................................................................................................... 873 See Also ................................................................................................................................................ 873 Activation ................................................................................................................................................... 874 Contents ............................................................................................................................................... 874 See Also ................................................................................................................................................ 876 Alarm .......................................................................................................................................................... 877 Contents ............................................................................................................................................... 877 See Also ................................................................................................................................................ 877 AlarmConﬁguration ................................................................................................................................. 878 Contents ............................................................................................................................................... 878 See Also ................................................................................................................................................ 878 AlarmStateInformation ........................................................................................................................... 879 Contents ............................................................................................................................................... 879 See Also ................................................................................................................................................ 879 Association ................................................................................................................................................. 880 API Version 2014-11-06 xxxiv AWS Systems Manager API Reference Contents ............................................................................................................................................... 880 See Also ................................................................................................................................................ 883 AssociationDescription ............................................................................................................................ 884 Contents ............................................................................................................................................... 884 See Also ................................................................................................................................................ 891 AssociationExecution ............................................................................................................................... 892 Contents ............................................................................................................................................... 892 See Also ................................................................................................................................................ 894 AssociationExecutionFilter ...................................................................................................................... 895 Contents ............................................................................................................................................... 895 See Also ................................................................................................................................................ 895 AssociationExecutionTarget ................................................................................................................... 897 Contents ............................................................................................................................................... 897 See Also ................................................................................................................................................ 899 AssociationExecutionTargetsFilter ........................................................................................................ 900 Contents ............................................................................................................................................... 900 See Also ................................................................................................................................................ 900 AssociationFilter ....................................................................................................................................... 901 Contents ............................................................................................................................................... 901 See Also ................................................................................................................................................ 901 AssociationOverview ............................................................................................................................... 903 Contents ............................................................................................................................................... 903 See Also ................................................................................................................................................ 903 AssociationStatus ..................................................................................................................................... 904 Contents ............................................................................................................................................... 904 See Also ................................................................................................................................................ 905 AssociationVersionInfo ............................................................................................................................ 906 Contents ............................................................................................................................................... 906 See Also ................................................................................................................................................ 911 AttachmentContent ................................................................................................................................. 912 Contents ............................................................................................................................................... 912 See Also ................................................................................................................................................ 913 AttachmentInformation .......................................................................................................................... 914 Contents ............................................................................................................................................... 914 See Also ................................................................................................................................................ 914 AttachmentsSource .................................................................................................................................. 915 API Version 2014-11-06 xxxv AWS Systems Manager API Reference Contents ............................................................................................................................................... 915 See Also ................................................................................................................................................ 916 AutomationExecution .............................................................................................................................. 917 Contents ............................................................................................................................................... 917 See Also ................................................................................................................................................ 925 AutomationExecutionFilter ..................................................................................................................... 926 Contents ............................................................................................................................................... 926 See Also ................................................................................................................................................ 926 AutomationExecutionInputs ................................................................................................................... 928 Contents ............................................................................................................................................... 928 See Also ................................................................................................................................................ 929 AutomationExecutionMetadata ............................................................................................................. 931 Contents ............................................................................................................................................... 931 See Also ................................................................................................................................................ 938 AutomationExecutionPreview ................................................................................................................ 939 Contents ............................................................................................................................................... 939 See Also ................................................................................................................................................ 940 BaselineOverride ...................................................................................................................................... 941 Contents ............................................................................................................................................... 941 See Also ................................................................................................................................................ 943 CloudWatchOutputConﬁg ...................................................................................................................... 944 Contents ............................................................................................................................................... 944 See Also ................................................................................................................................................ 944 Command .................................................................................................................................................. 945 Contents ............................................................................................................................................... 945 See Also ................................................................................................................................................ 951 CommandFilter ......................................................................................................................................... 952 Contents ............................................................................................................................................... 952 See Also ................................................................................................................................................ 954 CommandInvocation ................................................................................................................................ 955 Contents ............................................................................................................................................... 955 See Also ................................................................................................................................................ 959 CommandPlugin ....................................................................................................................................... 960 Contents ............................................................................................................................................... 960 See Also ................................................................................................................................................ 964 ComplianceExecutionSummary ............................................................................................................. 965 API Version 2014-11-06 xxxvi AWS Systems Manager API Reference Contents ............................................................................................................................................... 965 See Also ................................................................................................................................................ 965 ComplianceItem ........................................................................................................................................ 967 Contents ............................................................................................................................................... 967 See Also ................................................................................................................................................ 969 ComplianceItemEntry .............................................................................................................................. 970 Contents ............................................................................................................................................... 970 See Also ................................................................................................................................................ 971 ComplianceStringFilter ............................................................................................................................ 972 Contents ............................................................................................................................................... 972 See Also ................................................................................................................................................ 972 ComplianceSummaryItem ...................................................................................................................... 974 Contents ............................................................................................................................................... 974 See Also ................................................................................................................................................ 974 CompliantSummary ................................................................................................................................. 976 Contents ............................................................................................................................................... 976 See Also ................................................................................................................................................ 976 CreateAssociationBatchRequestEntry .................................................................................................. 977 Contents ............................................................................................................................................... 977 See Also ................................................................................................................................................ 983 Credentials ................................................................................................................................................. 984 Contents ............................................................................................................................................... 984 See Also ................................................................................................................................................ 984 DescribeActivationsFilter ........................................................................................................................ 986 Contents ............................................................................................................................................... 986 See Also ................................................................................................................................................ 986 DocumentDefaultVersionDescription ................................................................................................... 987 Contents ............................................................................................................................................... 987 See Also ................................................................................................................................................ 987 DocumentDescription .............................................................................................................................. 989 Contents ............................................................................................................................................... 989 See Also ................................................................................................................................................ 995 DocumentFilter ......................................................................................................................................... 997 Contents ............................................................................................................................................... 997 See Also ................................................................................................................................................ 997 DocumentIdentiﬁer .................................................................................................................................. 998 API Version 2014-11-06 xxxvii AWS Systems Manager API Reference Contents ............................................................................................................................................... 998 See Also .............................................................................................................................................. 1001 DocumentKeyValuesFilter .................................................................................................................... 1002 Contents ............................................................................................................................................. 1003 See Also .............................................................................................................................................. 1003 DocumentMetadataResponseInfo ...................................................................................................... 1005 Contents ............................................................................................................................................. 1005 See Also .............................................................................................................................................. 1005 DocumentParameter ............................................................................................................................. 1006 Contents ............................................................................................................................................. 1006 See Also .............................................................................................................................................. 1007 DocumentRequires ................................................................................................................................ 1008 Contents ............................................................................................................................................. 1008
systems-manager-api-008	systems-manager-api.pdf	8	984 See Also ................................................................................................................................................ 984 DescribeActivationsFilter ........................................................................................................................ 986 Contents ............................................................................................................................................... 986 See Also ................................................................................................................................................ 986 DocumentDefaultVersionDescription ................................................................................................... 987 Contents ............................................................................................................................................... 987 See Also ................................................................................................................................................ 987 DocumentDescription .............................................................................................................................. 989 Contents ............................................................................................................................................... 989 See Also ................................................................................................................................................ 995 DocumentFilter ......................................................................................................................................... 997 Contents ............................................................................................................................................... 997 See Also ................................................................................................................................................ 997 DocumentIdentiﬁer .................................................................................................................................. 998 API Version 2014-11-06 xxxvii AWS Systems Manager API Reference Contents ............................................................................................................................................... 998 See Also .............................................................................................................................................. 1001 DocumentKeyValuesFilter .................................................................................................................... 1002 Contents ............................................................................................................................................. 1003 See Also .............................................................................................................................................. 1003 DocumentMetadataResponseInfo ...................................................................................................... 1005 Contents ............................................................................................................................................. 1005 See Also .............................................................................................................................................. 1005 DocumentParameter ............................................................................................................................. 1006 Contents ............................................................................................................................................. 1006 See Also .............................................................................................................................................. 1007 DocumentRequires ................................................................................................................................ 1008 Contents ............................................................................................................................................. 1008 See Also .............................................................................................................................................. 1009 DocumentReviewCommentSource ..................................................................................................... 1010 Contents ............................................................................................................................................. 1010 See Also .............................................................................................................................................. 1010 DocumentReviewerResponseSource .................................................................................................. 1011 Contents ............................................................................................................................................. 1011 See Also .............................................................................................................................................. 1012 DocumentReviews ................................................................................................................................. 1013 Contents ............................................................................................................................................. 1013 See Also .............................................................................................................................................. 1013 DocumentVersionInfo ........................................................................................................................... 1014 Contents ............................................................................................................................................. 1014 See Also .............................................................................................................................................. 1016 EﬀectivePatch ......................................................................................................................................... 1017 Contents ............................................................................................................................................. 1017 See Also .............................................................................................................................................. 1017 ExecutionInputs ...................................................................................................................................... 1018 Contents ............................................................................................................................................. 1018 See Also .............................................................................................................................................. 1018 ExecutionPreview ................................................................................................................................... 1019 Contents ............................................................................................................................................. 1019 See Also .............................................................................................................................................. 1019 FailedCreateAssociation ........................................................................................................................ 1020 API Version 2014-11-06 xxxviii AWS Systems Manager API Reference Contents ............................................................................................................................................. 1020 See Also .............................................................................................................................................. 1020 FailureDetails .......................................................................................................................................... 1021 Contents ............................................................................................................................................. 1021 See Also .............................................................................................................................................. 1021 GetResourcePoliciesResponseEntry .................................................................................................... 1023 Contents ............................................................................................................................................. 1023 See Also .............................................................................................................................................. 1023 InstanceAggregatedAssociationOverview ......................................................................................... 1025 Contents ............................................................................................................................................. 1025 See Also .............................................................................................................................................. 1025 InstanceAssociation ............................................................................................................................... 1026 Contents ............................................................................................................................................. 1026 See Also .............................................................................................................................................. 1027 InstanceAssociationOutputLocation .................................................................................................. 1028 Contents ............................................................................................................................................. 1028 See Also .............................................................................................................................................. 1028 InstanceAssociationOutputUrl ............................................................................................................. 1029 Contents ............................................................................................................................................. 1029 See Also .............................................................................................................................................. 1029 InstanceAssociationStatusInfo ............................................................................................................ 1030 Contents ............................................................................................................................................. 1030 See Also .............................................................................................................................................. 1032 InstanceInfo ............................................................................................................................................ 1033 Contents ............................................................................................................................................. 1033 See Also .............................................................................................................................................. 1035 InstanceInformation .............................................................................................................................. 1036 Contents ............................................................................................................................................. 1036 See Also .............................................................................................................................................. 1040 InstanceInformationFilter ..................................................................................................................... 1042 Contents ............................................................................................................................................. 1042 See Also .............................................................................................................................................. 1042 InstanceInformationStringFilter .......................................................................................................... 1044 Contents ............................................................................................................................................. 1044 See Also .............................................................................................................................................. 1045 InstancePatchState ................................................................................................................................ 1046 API Version 2014-11-06 xxxix AWS Systems Manager API Reference Contents ............................................................................................................................................. 1046 See Also .............................................................................................................................................. 1051 InstancePatchStateFilter ....................................................................................................................... 1053 Contents ............................................................................................................................................. 1053 See Also .............................................................................................................................................. 1054 InstanceProperty .................................................................................................................................... 1055 Contents ............................................................................................................................................. 1055 See Also .............................................................................................................................................. 1060 InstancePropertyFilter .......................................................................................................................... 1061 Contents ............................................................................................................................................. 1061 See Also .............................................................................................................................................. 1061 InstancePropertyStringFilter ............................................................................................................... 1063 Contents ............................................................................................................................................. 1063 See Also .............................................................................................................................................. 1064 InventoryAggregator ............................................................................................................................. 1065 Contents ............................................................................................................................................. 1065 See Also .............................................................................................................................................. 1065 InventoryDeletionStatusItem .............................................................................................................. 1067 Contents ............................................................................................................................................. 1067 See Also .............................................................................................................................................. 1068 InventoryDeletionSummary ................................................................................................................. 1069 Contents ............................................................................................................................................. 1069 See Also .............................................................................................................................................. 1069 InventoryDeletionSummaryItem ........................................................................................................ 1070 Contents ............................................................................................................................................. 1070 See Also .............................................................................................................................................. 1070 InventoryFilter ........................................................................................................................................ 1071 Contents ............................................................................................................................................. 1071 See Also .............................................................................................................................................. 1072 InventoryGroup ...................................................................................................................................... 1073 Contents ............................................................................................................................................. 1073 See Also .............................................................................................................................................. 1073 InventoryItem ......................................................................................................................................... 1074 Contents ............................................................................................................................................. 1074 See Also .............................................................................................................................................. 1075 InventoryItemAttribute ......................................................................................................................... 1077 API Version 2014-11-06 xl AWS Systems Manager API Reference Contents ............................................................................................................................................. 1077 See Also .............................................................................................................................................. 1077 InventoryItemSchema ........................................................................................................................... 1078 Contents ............................................................................................................................................. 1078 See Also .............................................................................................................................................. 1079 InventoryResultEntity ........................................................................................................................... 1080 Contents ............................................................................................................................................. 1080 See Also .............................................................................................................................................. 1080 InventoryResultItem .............................................................................................................................. 1081 Contents ............................................................................................................................................. 1081 See Also .............................................................................................................................................. 1082 LoggingInfo ............................................................................................................................................. 1083 Contents ............................................................................................................................................. 1083 See Also .............................................................................................................................................. 1084 MaintenanceWindowAutomationParameters ................................................................................... 1085 Contents ............................................................................................................................................. 1085 See Also .............................................................................................................................................. 1086 MaintenanceWindowExecution ........................................................................................................... 1087 Contents ............................................................................................................................................. 1087 See Also .............................................................................................................................................. 1088 MaintenanceWindowExecutionTaskIdentity ..................................................................................... 1089 Contents ............................................................................................................................................. 1089 See Also .............................................................................................................................................. 1091 MaintenanceWindowExecutionTaskInvocationIdentity .................................................................. 1092 Contents ............................................................................................................................................. 1092 See Also .............................................................................................................................................. 1094 MaintenanceWindowFilter ................................................................................................................... 1096 Contents ............................................................................................................................................. 1096 See Also .............................................................................................................................................. 1096 MaintenanceWindowIdentity ............................................................................................................... 1098 Contents ............................................................................................................................................. 1098 See Also .............................................................................................................................................. 1100 MaintenanceWindowIdentityForTarget ............................................................................................. 1101 Contents ............................................................................................................................................. 1101 See Also .............................................................................................................................................. 1101 MaintenanceWindowLambdaParameters .......................................................................................... 1102 API Version 2014-11-06 xli AWS Systems Manager API Reference Contents ............................................................................................................................................. 1102 See Also .............................................................................................................................................. 1103 MaintenanceWindowRunCommandParameters .............................................................................. 1104 Contents ............................................................................................................................................. 1104 See Also .............................................................................................................................................. 1107 MaintenanceWindowStepFunctionsParameters .............................................................................. 1108 Contents ............................................................................................................................................. 1108 See Also .............................................................................................................................................. 1109 MaintenanceWindowTarget ................................................................................................................. 1110 Contents ............................................................................................................................................. 1110 See Also .............................................................................................................................................. 1112 MaintenanceWindowTask ..................................................................................................................... 1113 Contents ............................................................................................................................................. 1113 See Also .............................................................................................................................................. 1117 MaintenanceWindowTaskInvocationParameters ............................................................................. 1119 Contents ............................................................................................................................................. 1119 See Also .............................................................................................................................................. 1119 MaintenanceWindowTaskParameterValueExpression ..................................................................... 1121 Contents ............................................................................................................................................. 1121 See Also .............................................................................................................................................. 1121 MetadataValue ....................................................................................................................................... 1122 Contents ............................................................................................................................................. 1122 See Also .............................................................................................................................................. 1122 Node ......................................................................................................................................................... 1123 Contents ............................................................................................................................................. 1123 See Also .............................................................................................................................................. 1124 NodeAggregator ..................................................................................................................................... 1125 Contents ............................................................................................................................................. 1125 See Also .............................................................................................................................................. 1126 NodeFilter ................................................................................................................................................ 1127 Contents ............................................................................................................................................. 1127 See Also .............................................................................................................................................. 1128 NodeOwnerInfo ...................................................................................................................................... 1129 Contents ............................................................................................................................................. 1129 See Also .............................................................................................................................................. 1130 NodeType ................................................................................................................................................ 1131 API Version 2014-11-06 xlii AWS Systems Manager API Reference Contents ............................................................................................................................................. 1131 See Also .............................................................................................................................................. 1131 NonCompliantSummary ....................................................................................................................... 1132 Contents ............................................................................................................................................. 1132 See Also .............................................................................................................................................. 1132 NotiﬁcationConﬁg ................................................................................................................................. 1133 Contents ............................................................................................................................................. 1133 See Also .............................................................................................................................................. 1134 OpsAggregator ....................................................................................................................................... 1135 Contents ............................................................................................................................................. 1135 See Also .............................................................................................................................................. 1136 OpsEntity ................................................................................................................................................. 1137 Contents ............................................................................................................................................. 1137 See Also .............................................................................................................................................. 1137 OpsEntityItem ........................................................................................................................................ 1138 Contents ............................................................................................................................................. 1138 See Also .............................................................................................................................................. 1138 OpsFilter .................................................................................................................................................. 1140 Contents ............................................................................................................................................. 1140 See Also .............................................................................................................................................. 1140 OpsItem ................................................................................................................................................... 1142 Contents ............................................................................................................................................. 1142 See Also .............................................................................................................................................. 1148 OpsItemDataValue ................................................................................................................................. 1149 Contents ............................................................................................................................................. 1149 See Also .............................................................................................................................................. 1149 OpsItemEventFilter ................................................................................................................................ 1150 Contents ............................................................................................................................................. 1150 See Also .............................................................................................................................................. 1150 OpsItemEventSummary
systems-manager-api-009	systems-manager-api.pdf	9	API Reference Contents ............................................................................................................................................. 1131 See Also .............................................................................................................................................. 1131 NonCompliantSummary ....................................................................................................................... 1132 Contents ............................................................................................................................................. 1132 See Also .............................................................................................................................................. 1132 NotiﬁcationConﬁg ................................................................................................................................. 1133 Contents ............................................................................................................................................. 1133 See Also .............................................................................................................................................. 1134 OpsAggregator ....................................................................................................................................... 1135 Contents ............................................................................................................................................. 1135 See Also .............................................................................................................................................. 1136 OpsEntity ................................................................................................................................................. 1137 Contents ............................................................................................................................................. 1137 See Also .............................................................................................................................................. 1137 OpsEntityItem ........................................................................................................................................ 1138 Contents ............................................................................................................................................. 1138 See Also .............................................................................................................................................. 1138 OpsFilter .................................................................................................................................................. 1140 Contents ............................................................................................................................................. 1140 See Also .............................................................................................................................................. 1140 OpsItem ................................................................................................................................................... 1142 Contents ............................................................................................................................................. 1142 See Also .............................................................................................................................................. 1148 OpsItemDataValue ................................................................................................................................. 1149 Contents ............................................................................................................................................. 1149 See Also .............................................................................................................................................. 1149 OpsItemEventFilter ................................................................................................................................ 1150 Contents ............................................................................................................................................. 1150 See Also .............................................................................................................................................. 1150 OpsItemEventSummary ........................................................................................................................ 1152 Contents ............................................................................................................................................. 1152 See Also .............................................................................................................................................. 1153 OpsItemFilter .......................................................................................................................................... 1154 Contents ............................................................................................................................................. 1154 See Also .............................................................................................................................................. 1155 OpsItemIdentity ..................................................................................................................................... 1156 API Version 2014-11-06 xliii AWS Systems Manager API Reference Contents ............................................................................................................................................. 1156 See Also .............................................................................................................................................. 1156 OpsItemNotiﬁcation .............................................................................................................................. 1157 Contents ............................................................................................................................................. 1157 See Also .............................................................................................................................................. 1157 OpsItemRelatedItemsFilter .................................................................................................................. 1158 Contents ............................................................................................................................................. 1158 See Also .............................................................................................................................................. 1158 OpsItemRelatedItemSummary ............................................................................................................ 1160 Contents ............................................................................................................................................. 1160 See Also .............................................................................................................................................. 1161 OpsItemSummary .................................................................................................................................. 1162 Contents ............................................................................................................................................. 1162 See Also .............................................................................................................................................. 1166 OpsMetadata .......................................................................................................................................... 1167 Contents ............................................................................................................................................. 1167 See Also .............................................................................................................................................. 1168 OpsMetadataFilter ................................................................................................................................. 1169 Contents ............................................................................................................................................. 1169 See Also .............................................................................................................................................. 1169 OpsResultAttribute ................................................................................................................................ 1170 Contents ............................................................................................................................................. 1170 See Also .............................................................................................................................................. 1170 OutputSource ......................................................................................................................................... 1171 Contents ............................................................................................................................................. 1171 See Also .............................................................................................................................................. 1171 Parameter ................................................................................................................................................ 1172 Contents ............................................................................................................................................. 1172 See Also .............................................................................................................................................. 1174 ParameterHistory ................................................................................................................................... 1175 Contents ............................................................................................................................................. 1175 See Also .............................................................................................................................................. 1177 ParameterInlinePolicy ........................................................................................................................... 1179 Contents ............................................................................................................................................. 1179 See Also .............................................................................................................................................. 1179 ParameterMetadata ............................................................................................................................... 1181 API Version 2014-11-06 xliv AWS Systems Manager API Reference Contents ............................................................................................................................................. 1181 See Also .............................................................................................................................................. 1183 ParametersFilter ..................................................................................................................................... 1184 Contents ............................................................................................................................................. 1184 See Also .............................................................................................................................................. 1184 ParameterStringFilter ............................................................................................................................ 1185 Contents ............................................................................................................................................. 1185 See Also .............................................................................................................................................. 1186 ParentStepDetails .................................................................................................................................. 1187 Contents ............................................................................................................................................. 1187 See Also .............................................................................................................................................. 1188 Patch ......................................................................................................................................................... 1189 Contents ............................................................................................................................................. 1189 See Also .............................................................................................................................................. 1193 PatchBaselineIdentity ........................................................................................................................... 1194 Contents ............................................................................................................................................. 1194 See Also .............................................................................................................................................. 1195 PatchComplianceData ........................................................................................................................... 1196 Contents ............................................................................................................................................. 1196 See Also .............................................................................................................................................. 1197 PatchFilter ............................................................................................................................................... 1198 Contents ............................................................................................................................................. 1198 See Also .............................................................................................................................................. 1199 PatchFilterGroup .................................................................................................................................... 1200 Contents ............................................................................................................................................. 1200 See Also .............................................................................................................................................. 1200 PatchGroupPatchBaselineMapping .................................................................................................... 1201 Contents ............................................................................................................................................. 1201 See Also .............................................................................................................................................. 1201 PatchOrchestratorFilter ........................................................................................................................ 1202 Contents ............................................................................................................................................. 1202 See Also .............................................................................................................................................. 1202 PatchRule ................................................................................................................................................. 1204 Contents ............................................................................................................................................. 1204 See Also .............................................................................................................................................. 1206 PatchRuleGroup ..................................................................................................................................... 1207 API Version 2014-11-06 xlv AWS Systems Manager API Reference Contents ............................................................................................................................................. 1207 See Also .............................................................................................................................................. 1207 PatchSource ............................................................................................................................................ 1208 Contents ............................................................................................................................................. 1208 See Also .............................................................................................................................................. 1209 PatchStatus ............................................................................................................................................. 1210 Contents ............................................................................................................................................. 1210 See Also .............................................................................................................................................. 1210 ProgressCounters ................................................................................................................................... 1212 Contents ............................................................................................................................................. 1212 See Also .............................................................................................................................................. 1213 RegistrationMetadataItem ................................................................................................................... 1214 Contents ............................................................................................................................................. 1214 See Also .............................................................................................................................................. 1214 RelatedOpsItem ..................................................................................................................................... 1215 Contents ............................................................................................................................................. 1215 See Also .............................................................................................................................................. 1215 ResolvedTargets ..................................................................................................................................... 1216 Contents ............................................................................................................................................. 1216 See Also .............................................................................................................................................. 1216 ResourceComplianceSummaryItem .................................................................................................... 1217 Contents ............................................................................................................................................. 1217 See Also .............................................................................................................................................. 1218 ResourceDataSyncAwsOrganizationsSource ..................................................................................... 1220 Contents ............................................................................................................................................. 1220 See Also .............................................................................................................................................. 1220 ResourceDataSyncDestinationDataSharing ...................................................................................... 1221 Contents ............................................................................................................................................. 1221 See Also .............................................................................................................................................. 1221 ResourceDataSyncItem ......................................................................................................................... 1222 Contents ............................................................................................................................................. 1222 See Also .............................................................................................................................................. 1224 ResourceDataSyncOrganizationalUnit ............................................................................................... 1225 Contents ............................................................................................................................................. 1225 See Also .............................................................................................................................................. 1225 ResourceDataSyncS3Destination ........................................................................................................ 1226 API Version 2014-11-06 xlvi AWS Systems Manager API Reference Contents ............................................................................................................................................. 1226 See Also .............................................................................................................................................. 1227 ResourceDataSyncSource ..................................................................................................................... 1228 Contents ............................................................................................................................................. 1228 See Also .............................................................................................................................................. 1229 ResourceDataSyncSourceWithState ................................................................................................... 1230 Contents ............................................................................................................................................. 1230 See Also .............................................................................................................................................. 1232 ResultAttribute ....................................................................................................................................... 1233 Contents ............................................................................................................................................. 1233 See Also .............................................................................................................................................. 1233 ReviewInformation ................................................................................................................................ 1234 Contents ............................................................................................................................................. 1234 See Also .............................................................................................................................................. 1234 Runbook ................................................................................................................................................... 1236 Contents ............................................................................................................................................. 1236 See Also .............................................................................................................................................. 1238 S3OutputLocation ................................................................................................................................. 1240 Contents ............................................................................................................................................. 1240 See Also .............................................................................................................................................. 1240 S3OutputUrl ............................................................................................................................................ 1242 Contents ............................................................................................................................................. 1242 See Also .............................................................................................................................................. 1242 ScheduledWindowExecution ................................................................................................................ 1243 Contents ............................................................................................................................................. 1243 See Also .............................................................................................................................................. 1243 ServiceSetting ......................................................................................................................................... 1245 Contents ............................................................................................................................................. 1245 See Also .............................................................................................................................................. 1246 Session ..................................................................................................................................................... 1247 Contents ............................................................................................................................................. 1247 See Also .............................................................................................................................................. 1249 SessionFilter ............................................................................................................................................ 1250 Contents ............................................................................................................................................. 1250 See Also .............................................................................................................................................. 1251 SessionManagerOutputUrl ................................................................................................................... 1252 API Version 2014-11-06 xlvii AWS Systems Manager API Reference Contents ............................................................................................................................................. 1252 See Also .............................................................................................................................................. 1252 SeveritySummary ................................................................................................................................... 1253 Contents ............................................................................................................................................. 1253 See Also .............................................................................................................................................. 1254 StepExecution ......................................................................................................................................... 1255 Contents ............................................................................................................................................. 1255 See Also .............................................................................................................................................. 1260 StepExecutionFilter ............................................................................................................................... 1261 Contents ............................................................................................................................................. 1261 See Also .............................................................................................................................................. 1261 Tag ............................................................................................................................................................ 1262 Contents ............................................................................................................................................. 1262 See Also .............................................................................................................................................. 1262 Target ....................................................................................................................................................... 1264 Contents ............................................................................................................................................. 1265 See Also .............................................................................................................................................. 1266 TargetLocation ........................................................................................................................................ 1267 Contents ............................................................................................................................................. 1267 See Also .............................................................................................................................................. 1270 TargetPreview ......................................................................................................................................... 1271 Contents ............................................................................................................................................. 1271 See Also .............................................................................................................................................. 1271 Common Parameters ................................................................................................................. 1272 Common Errors .......................................................................................................................... 1275 API Version 2014-11-06 xlviii AWS Systems Manager Welcome API Reference AWS Systems Manager is the operations hub for your AWS applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale. This reference is intended to be used with the AWS Systems Manager User Guide. To get started, see Setting up AWS Systems Manager. Related resources • For
systems-manager-api-010	systems-manager-api.pdf	10	See Also .............................................................................................................................................. 1266 TargetLocation ........................................................................................................................................ 1267 Contents ............................................................................................................................................. 1267 See Also .............................................................................................................................................. 1270 TargetPreview ......................................................................................................................................... 1271 Contents ............................................................................................................................................. 1271 See Also .............................................................................................................................................. 1271 Common Parameters ................................................................................................................. 1272 Common Errors .......................................................................................................................... 1275 API Version 2014-11-06 xlviii AWS Systems Manager Welcome API Reference AWS Systems Manager is the operations hub for your AWS applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale. This reference is intended to be used with the AWS Systems Manager User Guide. To get started, see Setting up AWS Systems Manager. Related resources • For information about each of the tools that comprise Systems Manager, see Using Systems Manager tools in the AWS Systems Manager User Guide. • For details about predeﬁned runbooks for Automation, a tool in AWS Systems Manager, see the Systems Manager Automation runbook reference . • For information about AWS AppConﬁg, a tool in Systems Manager, see the AWS AppConﬁg User Guide and the AWS AppConﬁg API Reference . • For information about Incident Manager, a tool in Systems Manager, see the AWS Systems Manager Incident Manager User Guide and the AWS Systems Manager Incident Manager API Reference . This document was last published on May 21, 2025. API Version 2014-11-06 1 API Reference AWS Systems Manager Actions The following actions are supported: • AddTagsToResource • AssociateOpsItemRelatedItem • CancelCommand • CancelMaintenanceWindowExecution • CreateActivation • CreateAssociation • CreateAssociationBatch • CreateDocument • CreateMaintenanceWindow • CreateOpsItem • CreateOpsMetadata • CreatePatchBaseline • CreateResourceDataSync • DeleteActivation • DeleteAssociation • DeleteDocument • DeleteInventory • DeleteMaintenanceWindow • DeleteOpsItem • DeleteOpsMetadata • DeleteParameter • DeleteParameters • DeletePatchBaseline • DeleteResourceDataSync • DeleteResourcePolicy • DeregisterManagedInstance • DeregisterPatchBaselineForPatchGroup API Version 2014-11-06 2 AWS Systems Manager API Reference • DeregisterTargetFromMaintenanceWindow • DeregisterTaskFromMaintenanceWindow • DescribeActivations • DescribeAssociation • DescribeAssociationExecutions • DescribeAssociationExecutionTargets • DescribeAutomationExecutions • DescribeAutomationStepExecutions • DescribeAvailablePatches • DescribeDocument • DescribeDocumentPermission • DescribeEﬀectiveInstanceAssociations • DescribeEﬀectivePatchesForPatchBaseline • DescribeInstanceAssociationsStatus • DescribeInstanceInformation • DescribeInstancePatches • DescribeInstancePatchStates • DescribeInstancePatchStatesForPatchGroup • DescribeInstanceProperties • DescribeInventoryDeletions • DescribeMaintenanceWindowExecutions • DescribeMaintenanceWindowExecutionTaskInvocations • DescribeMaintenanceWindowExecutionTasks • DescribeMaintenanceWindows • DescribeMaintenanceWindowSchedule • DescribeMaintenanceWindowsForTarget • DescribeMaintenanceWindowTargets • DescribeMaintenanceWindowTasks • DescribeOpsItems • DescribeParameters API Version 2014-11-06 3 AWS Systems Manager • DescribePatchBaselines • DescribePatchGroups • DescribePatchGroupState • DescribePatchProperties • DescribeSessions • DisassociateOpsItemRelatedItem • GetAccessToken • GetAutomationExecution • GetCalendarState • GetCommandInvocation • GetConnectionStatus • GetDefaultPatchBaseline • GetDeployablePatchSnapshotForInstance • GetDocument • GetExecutionPreview • GetInventory • GetInventorySchema • GetMaintenanceWindow • GetMaintenanceWindowExecution • GetMaintenanceWindowExecutionTask • GetMaintenanceWindowExecutionTaskInvocation • GetMaintenanceWindowTask • GetOpsItem • GetOpsMetadata • GetOpsSummary • GetParameter • GetParameterHistory • GetParameters • GetParametersByPath • GetPatchBaseline API Reference API Version 2014-11-06 4 AWS Systems Manager API Reference • GetPatchBaselineForPatchGroup • GetResourcePolicies • GetServiceSetting • LabelParameterVersion • ListAssociations • ListAssociationVersions • ListCommandInvocations • ListCommands • ListComplianceItems • ListComplianceSummaries • ListDocumentMetadataHistory • ListDocuments • ListDocumentVersions • ListInventoryEntries • ListNodes • ListNodesSummary • ListOpsItemEvents • ListOpsItemRelatedItems • ListOpsMetadata • ListResourceComplianceSummaries • ListResourceDataSync • ListTagsForResource • ModifyDocumentPermission • PutComplianceItems • PutInventory • PutParameter • PutResourcePolicy • RegisterDefaultPatchBaseline • RegisterPatchBaselineForPatchGroup • RegisterTargetWithMaintenanceWindow API Version 2014-11-06 5 AWS Systems Manager API Reference • RegisterTaskWithMaintenanceWindow • RemoveTagsFromResource • ResetServiceSetting • ResumeSession • SendAutomationSignal • SendCommand • StartAccessRequest • StartAssociationsOnce • StartAutomationExecution • StartChangeRequestExecution • StartExecutionPreview • StartSession • StopAutomationExecution • TerminateSession • UnlabelParameterVersion • UpdateAssociation • UpdateAssociationStatus • UpdateDocument • UpdateDocumentDefaultVersion • UpdateDocumentMetadata • UpdateMaintenanceWindow • UpdateMaintenanceWindowTarget • UpdateMaintenanceWindowTask • UpdateManagedInstanceRole • UpdateOpsItem • UpdateOpsMetadata • UpdatePatchBaseline • UpdateResourceDataSync • UpdateServiceSetting API Version 2014-11-06 6 AWS Systems Manager API Reference AddTagsToResource Adds or overwrites one or more tags for the speciﬁed resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in diﬀerent ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you deﬁne. For example, you could deﬁne a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example: • Key=Owner,Value=DbAdmin • Key=Owner,Value=SysAdmin • Key=Owner,Value=Dev • Key=Stack,Value=Production • Key=Stack,Value=Pre-Production • Key=Stack,Value=Test Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and ﬁlter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters. For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide. Request Syntax { "ResourceId": "string", "ResourceType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } AddTagsToResource API Version 2014-11-06 7 AWS Systems Manager Request Parameters API Reference For information about
systems-manager-api-011	systems-manager-api.pdf	11	set of tag keys makes it easier for you to manage your resources. You can search and ﬁlter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters. For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide. Request Syntax { "ResourceId": "string", "ResourceType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } AddTagsToResource API Version 2014-11-06 7 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. ResourceId The resource ID you want to tag. Use the ID of the resource. Here are some examples: MaintenanceWindow: mw-012345abcde PatchBaseline: pb-012345abcde Automation: example-c160-4567-8519-012345abcde OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Speciﬁcally, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/ appmanager. For the Document and Parameter values, use the name of the resource. If you're tagging a shared document, you must use the full ARN of the document. ManagedInstance: mi-012345abcde Note The ManagedInstance type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f. Type: String Required: Yes Request Parameters API Version 2014-11-06 8 AWS Systems Manager ResourceType Speciﬁes the type of resource you are tagging. API Reference Note The ManagedInstance type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f. Type: String Valid Values: Document \| ManagedInstance \| MaintenanceWindow \| Parameter \| PatchBaseline \| OpsItem \| OpsMetadata \| Automation \| Association Required: Yes Tags One or more tags. The value parameter is required. Important Don't enter personally identiﬁable information in this ﬁeld. Type: Array of Tag objects Array Members: Maximum number of 1000 items. 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. Response Elements API Version 2014-11-06 9 AWS Systems Manager InternalServerError An error occurred on the server side. 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 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 TooManyTagsError The Targets parameter includes too many tags. Remove one or more tags and try the command 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 AddTagsToResource. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.AddTagsToResource Examples API Version 2014-11-06 10 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: 20240220T232503Z 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: 122 { "ResourceType": "PatchBaseline", "ResourceId": "pb-0c10e65780EXAMPLE", "Tags": [ { "Key": "Stack", "Value": "Production" } ] } Sample Response {} See Also For more information about using this API in one of the language-speciﬁc 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 11 AWS Systems Manager API Reference See Also API Version 2014-11-06 12 AWS Systems Manager API Reference AssociateOpsItemRelatedItem Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in AWS Systems Manager. Request Syntax { "AssociationType": "string", "OpsItemId": "string", "ResourceType": "string", "ResourceUri": "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. AssociationType The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types. Type: String Required: Yes OpsItemId The ID of the OpsItem to which you want to associate a resource as a related item. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: Yes ResourceType
systems-manager-api-012	systems-manager-api.pdf	12	OpsItem. Incident Manager and OpsCenter are tools in AWS Systems Manager. Request Syntax { "AssociationType": "string", "OpsItemId": "string", "ResourceType": "string", "ResourceUri": "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. AssociationType The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types. Type: String Required: Yes OpsItemId The ID of the OpsItem to which you want to associate a resource as a related item. Type: String Pattern: ^(oi)-[0-9a-f]{12}$ Required: Yes ResourceType The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types: AssociateOpsItemRelatedItem API Version 2014-11-06 13 AWS Systems Manager API Reference AWS::SSMIncidents::IncidentRecord: an Incident Manager incident. AWS::SSM::Document: a Systems Manager (SSM) document. Type: String Required: Yes ResourceUri The Amazon Resource Name (ARN) of the AWS resource that you want to associate with the OpsItem. Type: String Required: Yes Response Syntax { "AssociationId": "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. AssociationId The association ID. 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 Syntax API Version 2014-11-06 14 AWS Systems Manager HTTP Status Code: 500 OpsItemConﬂictException The speciﬁed OpsItem is in the process of being deleted. HTTP Status Code: 400 OpsItemInvalidParameterException API Reference A speciﬁed 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 speciﬁed OpsItem ID doesn't exist. Verify the ID and try again. HTTP Status Code: 400 OpsItemRelatedItemAlreadyExistsException The Amazon Resource Name (ARN) is already associated with the OpsItem. HTTP Status Code: 400 Examples Example This example illustrates one usage of AssociateOpsItemRelatedItem. Sample Request POST / HTTP/1.1 Host: ssm.us-east-1.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.AssociateOpsItemRelatedItem Content-Type: application/x-amz-json-1.1 Examples API Version 2014-11-06 15 AWS Systems Manager API Reference 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.associate-ops-item-related-item X-Amz-Date: 20240804T181929Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240804/us-east-1/ssm/ aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 229 { "OpsItemId": "oi-649fExample", "AssociationType": "RelatesTo", "ResourceType": "AWS::SSMIncidents::IncidentRecord", "ResourceUri": "arn:aws:ssm-incidents::111122223333:incident-record/Test/c6bd8931- efae-a4ff-7f98-4490Example" } Sample Response { "AssociationId": "61d7178d-a30d-4bc5-9b4e-a9e74EXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc 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 16 AWS Systems Manager CancelCommand API Reference Attempts to cancel the command speciﬁed by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. Request Syntax { "CommandId": "string", "InstanceIds": [ "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 The ID of the command you want to cancel. Type: String Length Constraints: Fixed length of 36. Required: Yes InstanceIds (Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested. 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: No CancelCommand API Version 2014-11-06 17 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. DuplicateInstanceId You can't specify a managed node ID in more than one association. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidCommandId The speciﬁed 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 Examples Example This example illustrates one usage of CancelCommand. Response Elements API Version 2014-11-06 18 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CancelCommand Content-Type: application/x-amz-json-1.1
systems-manager-api-013	systems-manager-api.pdf	13	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 CancelCommand. Response Elements API Version 2014-11-06 18 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CancelCommand Content-Type: application/x-amz-json-1.1 API Reference User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240220T233525Z 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: 53 { "CommandId": "25173b39-c88d-4459-ba3d-8704aEXAMPLE" } Sample Response {} See Also For more information about using this API in one of the language-speciﬁc 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 19 AWS Systems Manager API Reference See Also API Version 2014-11-06 20 AWS Systems Manager API Reference CancelMaintenanceWindowExecution Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion. 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 to stop. 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 { "WindowExecutionId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. CancelMaintenanceWindowExecution API Version 2014-11-06 21 AWS Systems Manager API Reference The following data is returned in JSON format by the service. WindowExecutionId The ID of the maintenance window execution that has been stopped. 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 speciﬁed 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 CancelMaintenanceWindowExecution. Sample Request POST / HTTP/1.1 Errors API Version 2014-11-06 22 AWS Systems Manager API Reference Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CancelMaintenanceWindowExecution 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: 20240225T010054Z 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: 61 { "WindowExecutionId": "02f05632-d0bc-470d-b1e5-c59a8EXAMPLE" } Sample Response { "WindowExecutionId": "02f05632-d0bc-470d-b1e5-c59a8EXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc 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 23 AWS Systems Manager CreateActivation API Reference Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with AWS Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager tools. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Using AWS Systems Manager in hybrid and multicloud environments in the AWS Systems Manager User Guide. Note Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are conﬁgured for Systems Manager are all called managed nodes. Request Syntax { "DefaultInstanceName": "string", "Description": "string", "ExpirationDate": number, "IamRole": "string", "RegistrationLimit": number, "RegistrationMetadata": [ { "Key": "string", "Value": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ] } CreateActivation API Version 2014-11-06 24 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. DefaultInstanceName The name of the registered, managed node as it will appear in the AWS Systems Manager console or when you use the AWS command line tools to list Systems Manager resources. Important Don't enter
systems-manager-api-014	systems-manager-api.pdf	14	{ "DefaultInstanceName": "string", "Description": "string", "ExpirationDate": number, "IamRole": "string", "RegistrationLimit": number, "RegistrationMetadata": [ { "Key": "string", "Value": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ] } CreateActivation API Version 2014-11-06 24 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. DefaultInstanceName The name of the registered, managed node as it will appear in the AWS Systems Manager console or when you use the AWS command line tools to list Systems Manager resources. Important Don't enter personally identiﬁable information in this ﬁeld. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: No Description A user-deﬁned description of the resource that you want to register with Systems Manager. Important Don't enter personally identiﬁable information in this ﬁeld. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ExpirationDate The date by which this activation request should expire, in timestamp format, such as "2024-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours. Request Parameters API Version 2014-11-06 25 AWS Systems Manager Type: Timestamp Required: No IamRole API Reference The name of the AWS Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the AWS Systems Manager service principal ssm.amazonaws.com. For more information, see Create the IAM service role required for Systems Manager in a hybrid and multicloud environments in the AWS Systems Manager User Guide. Note You can't specify an IAM service-linked role for this parameter. You must create a unique role. Type: String Length Constraints: Maximum length of 64. Required: Yes RegistrationLimit Specify the maximum number of managed nodes you want to register. The default value is 1. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No RegistrationMetadata Reserved for internal use. Type: Array of RegistrationMetadataItem objects Required: No Tags Optional metadata that you assign to a resource. Tags enable you to categorize a resource in diﬀerent ways, such as by purpose, owner, or environment. For example, you might want Request Parameters API Version 2014-11-06 26 AWS Systems Manager API Reference to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs: • Key=OS,Value=Windows • Key=Environment,Value=Production Important When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs. You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the ﬁrst time and are assigned a managed node ID. This means they are listed in the AWS Systems Manager console with an ID that is preﬁxed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No Response Syntax { "ActivationCode": "string", "ActivationId": "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 27 AWS Systems Manager ActivationCode API Reference The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID. Type: String Length Constraints: Minimum length of 20. Maximum length of 250. ActivationId The ID number generated by the system when it processed the activation. The activation ID functions like a user name. Type: String Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-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 InvalidParameters You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters deﬁned in the SSM document. HTTP Status Code: 400 Examples Example This example illustrates one usage of CreateActivation. Errors API Version 2014-11-06 28 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CreateActivation 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: 20240324T135329Z 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: 70 { "IamRole": "service-role/role_name" } Sample Response { "ActivationCode": "Fjz3/sZfSvv78EXAMPLE", "ActivationId": "e488f2f6-e686-4afb-8a04-ef6dfEXAMPLE" } See Also For more information about using this API in one of the
systems-manager-api-015	systems-manager-api.pdf	15	for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters deﬁned in the SSM document. HTTP Status Code: 400 Examples Example This example illustrates one usage of CreateActivation. Errors API Version 2014-11-06 28 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CreateActivation 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: 20240324T135329Z 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: 70 { "IamRole": "service-role/role_name" } Sample Response { "ActivationCode": "Fjz3/sZfSvv78EXAMPLE", "ActivationId": "e488f2f6-e686-4afb-8a04-ef6dfEXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc 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 29 AWS Systems Manager • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 30 AWS Systems Manager CreateAssociation API Reference A State Manager association deﬁnes the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association speciﬁes a schedule for when the conﬁguration is reapplied. For dynamic targets, such as an AWS resource group or an AWS autoscaling group, State Manager, a tool in AWS Systems Manager applies the conﬁguration when new managed nodes are added to the group. The association also speciﬁes actions to take when applying the conﬁguration. For example, an association for anti- virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service. Request Syntax { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "ApplyOnlyAtCronInterval": boolean, "AssociationName": "string", "AutomationTargetParameterName": "string", "CalendarNames": [ "string" ], "ComplianceSeverity": "string", "DocumentVersion": "string", "Duration": number, "InstanceId": "string", "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "OutputLocation": { "S3Location": { "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "OutputS3Region": "string" } CreateAssociation API Version 2014-11-06 31 AWS Systems Manager }, "Parameters": { "string" : [ "string" ] }, "ScheduleExpression": "string", "ScheduleOffset": number, "SyncCompliance": "string", "Tags": [ { "Key": "string", "Value": "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" ] } Request Syntax API Reference API Version 2014-11-06 32 API Reference AWS Systems Manager ], "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. AlarmConﬁguration The details for the CloudWatch alarm you want to apply to an automation or command. Type: AlarmConﬁguration object Required: No ApplyOnlyAtCronInterval By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you speciﬁed and when target changes are detected. Specify true for ApplyOnlyAtCronIntervalif you want the association to run only according to the schedule you speciﬁed. For more information, see Understanding when associations are applied to resources and >About target updates with Automation runbooks in the AWS Systems Manager User Guide. This parameter isn't supported for rate expressions. Type: Boolean Required: No AssociationName Specify a descriptive name for the association. Type: String Request Parameters API Version 2014-11-06 33 AWS Systems Manager API Reference Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: No AutomationTargetParameterName Choose the parameter that will deﬁne how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in AWS Systems Manager. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Required: No CalendarNames The names of Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide. Type: Array of strings Required: No ComplianceSeverity The severity level to assign to the association. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| UNSPECIFIED Required: No DocumentVersion The document version you want to associate with the targets. Can be a speciﬁc version or
systems-manager-api-016	systems-manager-api.pdf	16	Maximum length of 50. Required: No CalendarNames The names of Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide. Type: Array of strings Required: No ComplianceSeverity The severity level to assign to the association. Type: String Valid Values: CRITICAL \| HIGH \| MEDIUM \| LOW \| UNSPECIFIED Required: No DocumentVersion The document version you want to associate with the targets. Can be a speciﬁc version or the default version. Important State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs Request Parameters API Version 2014-11-06 34 AWS Systems Manager API Reference the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default. Type: String Pattern: ([$]LATEST\|[$]DEFAULT\|^[1-9][0-9]$) Required: No Duration The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken oﬄine for the association to run, it is made available again immediately, without a reboot. The Duration parameter applies only when both these conditions are true: • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution. • The command speciﬁes the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the speciﬁed schedule. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. 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 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 Request Parameters API Version 2014-11-06 35 AWS Systems Manager API Reference 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 MaxConcurrency The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit speciﬁed for MaxConcurrency. Type: String Length Constraints: Minimum length of 1. Maximum length of 7. Pattern: ^([1-9][0-9]\|[1-9][0-9]%\|[1-9]%\|100%)$ Required: No MaxErrors The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the ﬁrst error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there Request Parameters API Version 2014-11-06 36 AWS Systems Manager API Reference won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time. 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%)$ Required: No Name The name of the SSM Command document or Automation runbook that contains the conﬁguration information for the managed node. You can specify AWS-predeﬁned documents, documents you created, or a document that is shared with you from another AWS account. For Systems Manager documents (SSM documents) that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:partition:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predeﬁned documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or
systems-manager-api-017	systems-manager-api.pdf	17	of 7. Pattern: ^([1-9][0-9]\|[0]\|[1-9][0-9]%\|[0-9]%\|100%)$ Required: No Name The name of the SSM Command document or Automation runbook that contains the conﬁguration information for the managed node. You can specify AWS-predeﬁned documents, documents you created, or a document that is shared with you from another AWS account. For Systems Manager documents (SSM documents) that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:partition:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predeﬁned documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My- Document. Type: String Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$ Required: Yes OutputLocation An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request. Type: InstanceAssociationOutputLocation object Required: No Request Parameters API Version 2014-11-06 37 AWS Systems Manager Parameters API Reference The parameters for the runtime conﬁguration of the document. Type: String to array of strings map Required: No ScheduleExpression A cron expression when the association will be applied to the targets. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No ScheduleOﬀset Number of days to wait after the scheduled day to run an association. For example, if you speciﬁed a cron schedule of cron(0 0 ? THU#2 ), you could specify an oﬀset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the AWS Systems Manager User Guide. Note To use oﬀsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it. Type: Integer Valid Range: Minimum value of 1. Maximum value of 6. Required: No SyncCompliance The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT. Request Parameters API Version 2014-11-06 38 AWS Systems Manager API Reference In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager. It is managed by your direct call to the PutComplianceItems API operation. By default, all associations use AUTO mode. Type: String Valid Values: AUTO \| MANUAL Required: No Tags Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your AWS resources. Tags enable you to categorize your resources in diﬀerent ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you deﬁne. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No TargetLocations A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts. Type: Array of TargetLocation objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No TargetMaps A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be speciﬁed together. Type: Array of string to array of strings maps Array Members: Minimum number of 0 items. Maximum number of 300 items. Map Entries: Maximum number of 20 items. Request Parameters API Version 2014-11-06 39 AWS Systems Manager API Reference Key Length Constraints: Minimum length of 1. Maximum length of 50. Array Members: Minimum number of 0 items. Maximum number of 25 items. Length Constraints: Minimum length of 1. Maximum length of 50. Required: No Targets The targets for the association. You can target managed nodes by using tags, AWS resource groups, all managed nodes in an AWS account, or individual managed node IDs. You can target all managed nodes in an AWS account by specifying the InstanceIds key with a value of . For more information about choosing targets for an association, see Understanding targets and rate controls in State Manager associations in the AWS Systems Manager User Guide. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. 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", Response Syntax API Version 2014-11-06 40 AWS Systems Manager API Reference "Duration": number, "InstanceId": "string", "LastExecutionDate": number, "LastSuccessfulExecutionDate": number, "LastUpdateAssociationDate": number, "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "OutputLocation": { "S3Location": { "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "OutputS3Region": "string"
systems-manager-api-018	systems-manager-api.pdf	18	in the AWS Systems Manager User Guide. Type: Array of Target objects Array Members: Minimum number of 0 items. Maximum number of 5 items. 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", Response Syntax API Version 2014-11-06 40 AWS Systems Manager API Reference "Duration": number, "InstanceId": "string", "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": [ { Response Syntax API Version 2014-11-06 41 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" ] } ], "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. Response Elements API Version 2014-11-06 42 AWS Systems Manager AssociationDescription Information about the association. Type: AssociationDescription object Errors For information about the errors that are common to all actions, see Common Errors. API Reference AssociationAlreadyExists The speciﬁed association already exists. HTTP Status Code: 400 AssociationLimitExceeded You can have at most 2,000 active associations. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The speciﬁed SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentVersion The document version isn't valid or 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. Errors API Version 2014-11-06 43 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 InvalidOutputLocation The output location isn't valid or doesn't exist. HTTP Status Code: 400 InvalidParameters You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters deﬁned in the SSM document. HTTP Status Code: 400 InvalidSchedule The schedule is invalid. Verify your cron or rate expression and try again. HTTP Status Code: 400 InvalidTag The speciﬁed tag key or value isn't valid. HTTP Status Code: 400 InvalidTarget The target isn't valid or doesn't exist. It might not be conﬁgured for Systems Manager or you might not have permission to perform the operation. HTTP Status Code: 400 InvalidTargetMaps TargetMap parameter isn't valid. HTTP Status Code: 400 UnsupportedPlatformType The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node. Errors API Version 2014-11-06 44 API Reference AWS Systems Manager HTTP Status Code: 400 Examples Example This example illustrates one usage of CreateAssociation. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CreateAssociation 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: 20240324T140427Z 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: 67 { "Name": "AWS-UpdateSSMAgent", "InstanceId": "i-02573cafcfEXAMPLE" } Sample Response { "AssociationDescription": { "ApplyOnlyAtCronInterval": false, "AssociationId": "f7d193fe-7722-4f2b-ac53-d8736EXAMPLE", "AssociationVersion": "1", "Date": 1585058668.255, "DocumentVersion": "$DEFAULT", "InstanceId": "i-02573cafcfEXAMPLE", "LastUpdateAssociationDate": 1585058668.255, "Name": "AWS-UpdateSSMAgent", "Overview": { "DetailedStatus": "Creating", "Status": "Pending" Examples API Version 2014-11-06 45 API Reference AWS Systems Manager }, "Status": { "Date": 1585058668.255, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Targets": [ { "Key": "InstanceIds", "Values": [ "i-02573cafcfEXAMPLE" ] } ] } } See Also For more information about using this API in one of the language-speciﬁc 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 46 AWS Systems Manager API Reference CreateAssociationBatch Associates the speciﬁed AWS Systems Manager document (SSM document) with the speciﬁed managed
systems-manager-api-019	systems-manager-api.pdf	19	} See Also For more information about using this API in one of the language-speciﬁc 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 46 AWS Systems Manager API Reference CreateAssociationBatch Associates the speciﬁed AWS Systems Manager document (SSM document) with the speciﬁed managed nodes or targets. When you associate a document with one or more managed nodes using IDs or tags, AWS Systems Manager Agent (SSM Agent) running on the managed node processes the document and conﬁgures the node as speciﬁed. If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception. Request Syntax { "Entries": [ { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "ApplyOnlyAtCronInterval": boolean, "AssociationName": "string", "AutomationTargetParameterName": "string", "CalendarNames": [ "string" ], "ComplianceSeverity": "string", "DocumentVersion": "string", "Duration": number, "InstanceId": "string", "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "OutputLocation": { "S3Location": { "OutputS3BucketName": "string", "OutputS3KeyPrefix": "string", "OutputS3Region": "string" } CreateAssociationBatch API Version 2014-11-06 47 API Reference AWS Systems Manager }, "Parameters": { "string" : [ "string" ] }, "ScheduleExpression": "string", "ScheduleOffset": number, "SyncCompliance": "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" ] } ], "Targets": [ { "Key": "string", "Values": [ "string" ] } Request Syntax API Version 2014-11-06 48 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. Entries One or more associations. Type: Array of CreateAssociationBatchRequestEntry objects Array Members: Minimum number of 1 item. Required: Yes Response Syntax { "Failed": [ { "Entry": { "AlarmConfiguration": { "Alarms": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "ApplyOnlyAtCronInterval": boolean, "AssociationName": "string", "AutomationTargetParameterName": "string", "CalendarNames": [ "string" ], "ComplianceSeverity": "string", "DocumentVersion": "string", "Duration": number, "InstanceId": "string", Request Parameters API Version 2014-11-06 49 AWS Systems Manager API Reference "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": [ { "Name": "string" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "TargetsMaxConcurrency": "string", "TargetsMaxErrors": "string" } ], "TargetMaps": [ Response Syntax API Version 2014-11-06 50 AWS Systems Manager API Reference { "string" : [ "string" ] } ], "Targets": [ { "Key": "string", "Values": [ "string" ] } ] }, "Fault": "string", "Message": "string" } ], "Successful": [ { "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", "LastExecutionDate": number, "LastSuccessfulExecutionDate": number, "LastUpdateAssociationDate": number, "MaxConcurrency": "string", "MaxErrors": "string", "Name": "string", "OutputLocation": { "S3Location": { Response Syntax API Version 2014-11-06 51 AWS Systems Manager API Reference "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" } ], "IgnorePollAlarmFailure": boolean }, "TargetLocationMaxConcurrency": "string", "TargetLocationMaxErrors": "string", "Targets": [ { "Key": "string", Response Syntax API Version 2014-11-06 52 AWS Systems Manager API Reference "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. Failed Information about the associations that failed. Type: Array of FailedCreateAssociation objects Successful Information about the associations that succeeded. Response Elements API Version 2014-11-06 53 AWS
systems-manager-api-020	systems-manager-api.pdf	20	Manager API Reference "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. Failed Information about the associations that failed. Type: Array of FailedCreateAssociation objects Successful Information about the associations that succeeded. Response Elements API Version 2014-11-06 53 AWS Systems Manager API Reference Type: Array of AssociationDescription objects Errors For information about the errors that are common to all actions, see Common Errors. AssociationLimitExceeded You can have at most 2,000 active associations. HTTP Status Code: 400 DuplicateInstanceId You can't specify a managed node ID in more than one association. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocument The speciﬁed SSM document doesn't exist. HTTP Status Code: 400 InvalidDocumentVersion The document version isn't valid or 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. Errors API Version 2014-11-06 54 AWS Systems Manager HTTP Status Code: 400 InvalidOutputLocation The output location isn't valid or doesn't exist. HTTP Status Code: 400 InvalidParameters API Reference You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters deﬁned in the SSM document. HTTP Status Code: 400 InvalidSchedule The schedule is invalid. Verify your cron or rate expression and try again. HTTP Status Code: 400 InvalidTarget The target isn't valid or doesn't exist. It might not be conﬁgured for Systems Manager or you might not have permission to perform the operation. HTTP Status Code: 400 InvalidTargetMaps TargetMap parameter isn't valid. HTTP Status Code: 400 UnsupportedPlatformType The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node. HTTP Status Code: 400 Examples Example This example illustrates one usage of CreateAssociationBatch. Examples API Version 2014-11-06 55 AWS Systems Manager Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CreateAssociationBatch 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: 20240324T142446Z 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: 151 { "Entries": [ { "InstanceId": "i-0471e04240EXAMPLE", "Name": "AWS-UpdateSSMAgent" }, { "InstanceId": "i-07782c72faEXAMPLE", "Name": "AWS-UpdateSSMAgent" } ] } Sample Response { "Failed": [], "Successful": [ { "ApplyOnlyAtCronInterval": false, "AssociationId": "33858bec-0c55-4547-a054-eb5fcEXAMPLE", "AssociationVersion": "1", "Date": 1585059887.692, "DocumentVersion": "$DEFAULT", "InstanceId": "i-0471e04240EXAMPLE", "LastUpdateAssociationDate": 1585059887.692, "Name": "AWS-UpdateSSMAgent", "Overview": { "DetailedStatus": "Creating", Examples API Version 2014-11-06 56 AWS Systems Manager API Reference "Status": "Pending" }, "Status": { "Date": 1585059887.692, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Targets": [ { "Key": "InstanceIds", "Values": [ "i-0471e04240EXAMPLE" ] } ] }, { "ApplyOnlyAtCronInterval": false, "AssociationId": "e0e0a062-3dcb-4b3e-bb2b-d01b4EXAMPLE", "AssociationVersion": "1", "Date": 1585059887.726, "DocumentVersion": "$DEFAULT", "InstanceId": "i-07782c72faEXAMPLE", "LastUpdateAssociationDate": 1585059887.726, "Name": "AWS-UpdateSSMAgent", "Overview": { "DetailedStatus": "Creating", "Status": "Pending" }, "Status": { "Date": 1585059887.726, "Message": "Associated with AWS-UpdateSSMAgent", "Name": "Associated" }, "Targets": [ { "Key": "InstanceIds", "Values": [ "i-07782c72faEXAMPLE" ] } ] } ] Examples API Version 2014-11-06 57 AWS Systems Manager } See Also API Reference For more information about using this API in one of the language-speciﬁc 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 58 AWS Systems Manager CreateDocument API Reference Creates a AWS Systems Manager (SSM document). An SSM document deﬁnes the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide. Request Syntax { "Attachments": [ { "Key": "string", "Name": "string", "Values": [ "string" ] } ], "Content": "string", "DisplayName": "string", "DocumentFormat": "string", "DocumentType": "string", "Name": "string", "Requires": [ { "Name": "string", "RequireType": "string", "Version": "string", "VersionName": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "string", "VersionName": "string" } CreateDocument API Version 2014-11-06 59 AWS Systems Manager Request Parameters API Reference For information about the parameters that
systems-manager-api-021	systems-manager-api.pdf	21	your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide. Request Syntax { "Attachments": [ { "Key": "string", "Name": "string", "Values": [ "string" ] } ], "Content": "string", "DisplayName": "string", "DocumentFormat": "string", "DocumentType": "string", "Name": "string", "Requires": [ { "Name": "string", "RequireType": "string", "Version": "string", "VersionName": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "string", "VersionName": "string" } CreateDocument API Version 2014-11-06 59 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. Attachments A list of key-value pairs that describe attachments to a version of a document. Type: Array of AttachmentsSource objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No Content The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content speciﬁed for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML ﬁle and referencing the ﬁle in a command. For examples, see the following topics in the AWS Systems Manager User Guide. • Create an SSM document (console) • Create an SSM document (command line) • Create an SSM document (API) Type: String Length Constraints: Minimum length of 1. Required: Yes DisplayName An optional ﬁeld where you can specify a friendly name for the SSM document. This value can diﬀer for each version of the document. You can update this value at a later time using the UpdateDocument operation. Type: String Request Parameters API Version 2014-11-06 60 AWS Systems Manager API Reference Length Constraints: Maximum length of 1024. Pattern: ^[\w\.\-\:\/ ]$ Required: No DocumentFormat Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format. Type: String Valid Values: YAML \| JSON \| TEXT Required: No DocumentType The type of document to create. Note The DeploymentStrategy document type is an internal-use-only document type reserved for AWS AppConﬁg. Type: String Valid Values: Command \| Policy \| Automation \| Session \| Package \| ApplicationConfiguration \| ApplicationConfigurationSchema \| DeploymentStrategy \| ChangeCalendar \| Automation.ChangeTemplate \| ProblemAnalysis \| ProblemAnalysisTemplate \| CloudFormation \| ConformancePackTemplate \| QuickSetup \| ManualApprovalPolicy \| AutoApprovalPolicy Required: No Name A name for the SSM document. Request Parameters API Version 2014-11-06 61 AWS Systems Manager API Reference Important You can't use the following strings as document name preﬁxes. These are reserved by AWS for use as document name preﬁxes: • aws • amazon • amzn • AWSEC2 • AWSConfigRemediation • AWSSupport Type: String Pattern: ^[a-zA-Z0-9_\-.]{3,128}$ Required: Yes Requires A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConﬁg. When a user creates an AWS AppConﬁg conﬁguration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AWS AppConﬁg? in the AWS AppConﬁg User Guide. Type: Array of DocumentRequires objects Array Members: Minimum number of 1 item. Required: No Tags Optional metadata that you assign to a resource. Tags enable you to categorize a resource in diﬀerent ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs: Request Parameters API Version 2014-11-06 62 AWS Systems Manager API Reference • Key=OS,Value=Windows • Key=Environment,Value=Production Note To add tags to an existing SSM document, use the AddTagsToResource operation. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No TargetType Specify a target type to deﬁne the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide. Type: String Length Constraints: Maximum length of 200. Pattern: ^\/[\w\.\-\:\/]$ Required: No VersionName An optional ﬁeld specifying the version of the artifact you are creating with the document. For example, Release12.1. 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 Request Parameters API Version 2014-11-06 63 AWS Systems Manager Response Syntax { "DocumentDescription": { "ApprovedVersion": "string", "AttachmentsInformation": [ { "Name": "string" } ], "Author":
systems-manager-api-022	systems-manager-api.pdf	22	can't run on any resources. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide. Type: String Length Constraints: Maximum length of 200. Pattern: ^\/[\w\.\-\:\/]*$ Required: No VersionName An optional ﬁeld specifying the version of the artifact you are creating with the document. For example, Release12.1. 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 Request Parameters API Version 2014-11-06 63 AWS Systems Manager Response Syntax { "DocumentDescription": { "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", "Version": "string", "VersionName": "string" } ], Response Syntax API Reference API Version 2014-11-06 64 AWS Systems Manager API Reference "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. DocumentDescription Information about the SSM document. Type: DocumentDescription object Errors For information about the errors that are common to all actions, see Common Errors. DocumentAlreadyExists The speciﬁed document already exists. Response Elements API Version 2014-11-06 65 API Reference AWS Systems Manager HTTP Status Code: 400 DocumentLimitExceeded You can have at most 500 active SSM documents. HTTP Status Code: 400 InternalServerError An error occurred on the server side. HTTP Status Code: 500 InvalidDocumentContent The content for the document isn't valid. HTTP Status Code: 400 InvalidDocumentSchemaVersion The version of the document schema isn't supported. HTTP Status Code: 400 MaxDocumentSizeExceeded The size limit of a document is 64 KB. HTTP Status Code: 400 Examples Example This example illustrates one usage of CreateDocument. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CreateDocument Content-Type: application/x-amz-json-1.1 Examples API Version 2014-11-06 66 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: 20240324T145550Z 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: 963 { "Content": "---\ndescription: \"Example\"\nschemaVersion: '0.3'\nassumeRole: \"{{ AutomationAssumeRole }}\"--truncated--", "Name": "Example", "DocumentType": "Automation", "DocumentFormat": "YAML" } Sample Response { "DocumentDescription": { "CreatedDate": 1585061751.738, "DefaultVersion": "1", "Description": "Custom Automation Example", "DocumentFormat": "YAML", "DocumentType": "Automation", "DocumentVersion": "1", "Hash": "0d3d879b3ca072e03c12638d0255ebd004d2c65bd318f8354fcde820dEXAMPLE", "HashType": "Sha256", "LatestVersion": "1", "Name": "Example", "Owner": "111122223333", "Parameters": [ { "DefaultValue": "", "Description": "(Optional) 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", Examples API Version 2014-11-06 67 AWS Systems Manager API Reference "Type": "String" } ], "PlatformTypes": [ "Windows", "Linux" ], "SchemaVersion": "0.3", "Status": "Creating", "Tags": [] } } See Also For more information about using this API in one of the language-speciﬁc 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 68 AWS Systems Manager API Reference CreateMaintenanceWindow Creates a new maintenance window. Note The value you specify for Duration determines the speciﬁc end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM. Request Syntax { "AllowUnassociatedTargets": boolean, "ClientToken": "string", "Cutoff": number, "Description": "string", "Duration": number, "EndDate": "string", "Name": "string", "Schedule": "string", "ScheduleOffset": number, "ScheduleTimezone": "string", "StartDate": "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. CreateMaintenanceWindow API Version 2014-11-06 69 AWS Systems Manager AllowUnassociatedTargets API Reference Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register
systems-manager-api-023	systems-manager-api.pdf	23	"string", "Cutoff": number, "Description": "string", "Duration": number, "EndDate": "string", "Name": "string", "Schedule": "string", "ScheduleOffset": number, "ScheduleTimezone": "string", "StartDate": "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. CreateMaintenanceWindow API Version 2014-11-06 69 AWS Systems Manager AllowUnassociatedTargets API Reference Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window. If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window. Type: Boolean Required: Yes ClientToken User-provided idempotency token. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Cutoﬀ 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. Required: Yes Description An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Request Parameters API Version 2014-11-06 70 AWS Systems Manager Duration API Reference The duration of the maintenance window in hours. Type: Integer Valid Range: Minimum value of 1. Maximum value of 24. Required: Yes EndDate The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run. Type: String Required: No 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}$ Required: Yes Schedule The schedule of the maintenance window in the form of a cron or rate expression. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes ScheduleOﬀset The number of days to wait after the date and time speciﬁed by a cron expression before running the maintenance window. Request Parameters API Version 2014-11-06 71 AWS Systems Manager API Reference For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM. cron(30 23 ? * TUE#3 *) If the schedule oﬀset is 2, the maintenance window won't run until two days later. Type: Integer Valid Range: Minimum value of 1. Maximum value of 6. Required: No 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 Required: No StartDate The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the speciﬁed future date. Note When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date. Type: String Required: No Tags Optional metadata that you assign to a resource. Tags enable you to categorize a resource in diﬀerent ways, such as by purpose, owner, or environment. For example, you might want to Request Parameters API Version 2014-11-06 72 AWS Systems Manager API Reference tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs: • Key=TaskType,Value=AgentUpdate • Key=OS,Value=Windows • Key=Environment,Value=Production Note To add tags to an existing maintenance window, use the AddTagsToResource operation. Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No 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. WindowId The ID of the created maintenance window. Type: String Length Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Response Syntax API Version 2014-11-06 73 AWS Systems Manager Errors API Reference 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 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
systems-manager-api-024	systems-manager-api.pdf	24	Constraints: Fixed length of 20. Pattern: ^mw-[0-9a-f]{17}$ Response Syntax API Version 2014-11-06 73 AWS Systems Manager Errors API Reference 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 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 CreateMaintenanceWindow. Sample Request POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 186 X-Amz-Target: AmazonSSM.CreateMaintenanceWindow X-Amz-Date: 20240312T201809Z 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 Errors API Version 2014-11-06 74 AWS Systems Manager 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 { "Name": "My-Development-Maintenance-Window", "Cutoff": 2, "Schedule": "cron(0 12 ? * WED )", "AllowUnassociatedTargets": true, "Duration": 6, "Tags": [ { "Key": "Environment", "Value": "Development" } ], "ClientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE" } Sample Response { "WindowId": "mw-0c50858d01EXAMPLE" } See Also For more information about using this API in one of the language-speciﬁc 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 75 AWS Systems Manager • AWS SDK for Ruby V3 API Reference See Also API Version 2014-11-06 76 AWS Systems Manager CreateOpsItem API Reference Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new 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 { "AccountId": "string", "ActualEndTime": number, "ActualStartTime": number, "Category": "string", "Description": "string", "Notifications": [ { "Arn": "string" } ], "OperationalData": { "string" : { "Type": "string", "Value": "string" } }, "OpsItemType": "string", "PlannedEndTime": number, "PlannedStartTime": number, "Priority": number, "RelatedOpsItems": [ { "OpsItemId": "string" } ], "Severity": "string", "Source": "string", "Tags": [ CreateOpsItem API Version 2014-11-06 77 AWS Systems Manager { "Key": "string", "Value": "string" } ], "Title": "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. AccountId The target AWS account where you want to create an OpsItem. To make this call, your account must be conﬁgured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the AWS Systems Manager User Guide. Type: String Pattern: ^[0-9]{12}$ Required: No ActualEndTime The time a runbook workﬂow ended. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp Required: No ActualStartTime The time a runbook workﬂow started. Currently reported only for the OpsItem type /aws/ changerequest. Type: Timestamp Required: No Request Parameters API Version 2014-11-06 78 AWS Systems Manager Category Specify a category to assign to an OpsItem. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. API Reference Pattern: ^(?!\s$).+ Required: No Description User-deﬁned text that contains information about the OpsItem, in Markdown format. Note Provide enough information so that users viewing this OpsItem for the ﬁrst time understand the issue. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\s\S]\S[\s\S] Required: Yes Notiﬁcations The Amazon Resource Name (ARN) of an SNS topic where notiﬁcations are sent when this OpsItem is edited or changed. Type: Array of OpsItemNotiﬁcation objects Required: No OperationalData Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log ﬁles, error strings, license keys, troubleshooting tips, or other Request Parameters API Version 2014-11-06 79 AWS Systems Manager API Reference relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB. Important Operational data keys can't begin with the following: amazon, aws, amzn, ssm, / amazon, /aws, /amzn, /ssm. You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the speciﬁed
systems-manager-api-025	systems-manager-api.pdf	25	Version 2014-11-06 79 AWS Systems Manager API Reference relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB. Important Operational data keys can't begin with the following: amazon, aws, amzn, ssm, / amazon, /aws, /amzn, /ssm. You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the speciﬁed data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation). Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Create OpsItems manually in the AWS Systems Manager User Guide. Type: String to OpsItemDataValue object map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!\s$).+ Required: No OpsItemType The type of OpsItem to create. Systems Manager supports the following types of OpsItems: • /aws/issue This type of OpsItem is used for default OpsItems created by OpsCenter. • /aws/changerequest This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests. • /aws/insight Request Parameters API Version 2014-11-06 80 AWS Systems Manager API Reference This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. Type: String Required: No PlannedEndTime The time speciﬁed in a change request for a runbook workﬂow to end. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No PlannedStartTime The time speciﬁed in a change request for a runbook workﬂow to start. Currently supported only for the OpsItem type /aws/changerequest. Type: Timestamp Required: No Priority The importance of this OpsItem in relation to other OpsItems in the system. Type: Integer Valid Range: Minimum value of 1. Maximum value of 5. Required: No RelatedOpsItems One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource. Type: Array of RelatedOpsItem objects Required: No Request Parameters API Version 2014-11-06 81 AWS Systems Manager Severity Specify a severity to assign to an OpsItem. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. API Reference Pattern: ^(?!\s$).+ Required: No Source The origin of the OpsItem, such as Amazon EC2 or Systems Manager. Note The source name can't contain the following strings: aws, amazon, and amzn. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!\s$).+ Required: Yes Tags Optional metadata that you assign to a resource. Tags use a key-value pair. For example: Key=Department,Value=Finance Important To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation. Request Parameters API Version 2014-11-06 82 AWS Systems Manager Type: Array of Tag objects Array Members: Maximum number of 1000 items. Required: No Title API Reference A short heading that describes the nature of the OpsItem and the impacted resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^(?!\s$).+ Required: Yes Response Syntax { "OpsItemArn": "string", "OpsItemId": "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. 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. OpsItemId The ID of the OpsItem. Response Syntax API Version 2014-11-06 83 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 OpsItemAccessDeniedException You don't have permission to view OpsItems in the speciﬁed account. Verify that your account is conﬁgured either 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 speciﬁed 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

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.