From 3bf633b9783e8149694d8915b911c68d2b0ab2af Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Wed, 7 Feb 2024 19:09:23 +0000 Subject: [PATCH] Update to latest models --- .../api-change-datasync-92812.json | 5 + .../api-change-lexv2models-84110.json | 5 + .../api-change-redshift-56213.json | 5 + .../data/datasync/2018-11-09/service-2.json | 298 ++++++---- .../lexv2-models/2020-08-07/service-2.json | 525 ++++++++++++++++++ .../redshift/2012-12-01/paginators-1.json | 6 + .../data/redshift/2012-12-01/service-2.json | 177 ++++++ 7 files changed, 917 insertions(+), 104 deletions(-) create mode 100644 .changes/next-release/api-change-datasync-92812.json create mode 100644 .changes/next-release/api-change-lexv2models-84110.json create mode 100644 .changes/next-release/api-change-redshift-56213.json diff --git a/.changes/next-release/api-change-datasync-92812.json b/.changes/next-release/api-change-datasync-92812.json new file mode 100644 index 0000000000..decd2a21d0 --- /dev/null +++ b/.changes/next-release/api-change-datasync-92812.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``datasync``", + "description": "AWS DataSync now supports manifests for specifying files or objects to transfer." +} diff --git a/.changes/next-release/api-change-lexv2models-84110.json b/.changes/next-release/api-change-lexv2models-84110.json new file mode 100644 index 0000000000..0ec0b73df4 --- /dev/null +++ b/.changes/next-release/api-change-lexv2models-84110.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``lexv2-models``", + "description": "Update lexv2-models client to latest version" +} diff --git a/.changes/next-release/api-change-redshift-56213.json b/.changes/next-release/api-change-redshift-56213.json new file mode 100644 index 0000000000..14ff28482e --- /dev/null +++ b/.changes/next-release/api-change-redshift-56213.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``redshift``", + "description": "LisRecommendations API to fetch Amazon Redshift Advisor recommendations." +} diff --git a/botocore/data/datasync/2018-11-09/service-2.json b/botocore/data/datasync/2018-11-09/service-2.json index 0246bb0a35..c5ee7b7160 100644 --- a/botocore/data/datasync/2018-11-09/service-2.json +++ b/botocore/data/datasync/2018-11-09/service-2.json @@ -69,7 +69,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.

Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.

" + "documentation":"

Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination.

Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.

" }, "CreateLocationEfs":{ "name":"CreateLocationEfs", @@ -83,7 +83,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.

" + "documentation":"

Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems.

" }, "CreateLocationFsxLustre":{ "name":"CreateLocationFsxLustre", @@ -97,7 +97,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for an Amazon FSx for Lustre file system.

" + "documentation":"

Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems.

" }, "CreateLocationFsxOntap":{ "name":"CreateLocationFsxOntap", @@ -111,7 +111,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can use for a data transfer.

Before you begin, make sure that you understand how DataSync accesses an FSx for ONTAP file system.

" + "documentation":"

Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems.

" }, "CreateLocationFsxOpenZfs":{ "name":"CreateLocationFsxOpenZfs", @@ -125,7 +125,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.

Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.

" + "documentation":"

Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems.

Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.

" }, "CreateLocationFsxWindows":{ "name":"CreateLocationFsxWindows", @@ -139,7 +139,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data transfer.

Before you begin, make sure that you understand how DataSync accesses an FSx for Windows File Server.

" + "documentation":"

Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.

" }, "CreateLocationHdfs":{ "name":"CreateLocationHdfs", @@ -153,7 +153,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for a Hadoop Distributed File System (HDFS).

" + "documentation":"

Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses HDFS clusters.

" }, "CreateLocationNfs":{ "name":"CreateLocationNfs", @@ -167,7 +167,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.

For more information, see Configuring transfers to or from an NFS file server.

If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create your transfer location. For more information, see Configuring transfers with Snowcone.

" + "documentation":"

Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses NFS file servers.

If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create your transfer location. For more information, see Configuring transfers with Snowcone.

" }, "CreateLocationObjectStorage":{ "name":"CreateLocationObjectStorage", @@ -181,7 +181,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.

" + "documentation":"

Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.

" }, "CreateLocationS3":{ "name":"CreateLocationS3", @@ -195,7 +195,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

A location is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data.

Before you create your location, make sure that you read the following sections:

For more information, see Creating an Amazon S3 location.

" + "documentation":"

Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you read the following topics:

For more information, see Configuring transfers with Amazon S3.

" }, "CreateLocationSmb":{ "name":"CreateLocationSmb", @@ -209,7 +209,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.

Before you begin, make sure that you understand how DataSync accesses an SMB file server.

" + "documentation":"

Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses SMB file servers.

" }, "CreateTask":{ "name":"CreateTask", @@ -251,7 +251,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Deletes the configuration of a location used by DataSync.

" + "documentation":"

Deletes a transfer location resource from DataSync.

" }, "DeleteTask":{ "name":"DeleteTask", @@ -265,7 +265,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Deletes an DataSync transfer task.

" + "documentation":"

Deletes a transfer task resource from DataSync.

" }, "DescribeAgent":{ "name":"DescribeAgent", @@ -322,7 +322,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Returns metadata about your DataSync location for an Amazon EFS file system.

" + "documentation":"

Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

" }, "DescribeLocationFsxLustre":{ "name":"DescribeLocationFsxLustre", @@ -336,7 +336,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.

" + "documentation":"

Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.

" }, "DescribeLocationFsxOntap":{ "name":"DescribeLocationFsxOntap", @@ -350,7 +350,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

" + "documentation":"

Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

" }, "DescribeLocationFsxOpenZfs":{ "name":"DescribeLocationFsxOpenZfs", @@ -364,7 +364,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.

Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.

" + "documentation":"

Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.

Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.

" }, "DescribeLocationFsxWindows":{ "name":"DescribeLocationFsxWindows", @@ -378,7 +378,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.

" + "documentation":"

Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

" }, "DescribeLocationHdfs":{ "name":"DescribeLocationHdfs", @@ -392,7 +392,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.

" + "documentation":"

Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.

" }, "DescribeLocationNfs":{ "name":"DescribeLocationNfs", @@ -420,7 +420,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Returns metadata about your DataSync location for an object storage system.

" + "documentation":"

Provides details about how an DataSync transfer location for an object storage system is configured.

" }, "DescribeLocationS3":{ "name":"DescribeLocationS3", @@ -434,7 +434,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

" + "documentation":"

Provides details about how an DataSync transfer location for an S3 bucket is configured.

" }, "DescribeLocationSmb":{ "name":"DescribeLocationSmb", @@ -448,7 +448,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Returns metadata, such as the path and user information about an SMB location.

" + "documentation":"

Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.

" }, "DescribeStorageSystem":{ "name":"DescribeStorageSystem", @@ -622,7 +622,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Returns a list of executed tasks.

" + "documentation":"

Returns a list of executions for an DataSync transfer task.

" }, "ListTasks":{ "name":"ListTasks", @@ -851,7 +851,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Updates the configuration of a DataSync transfer task.

" + "documentation":"

Updates the configuration of an DataSync transfer task.

" }, "UpdateTaskExecution":{ "name":"UpdateTaskExecution", @@ -1353,15 +1353,15 @@ }, "User":{ "shape":"SmbUser", - "documentation":"

Specifies the user who has the permissions to access files, folders, and metadata in your file 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.

" + "documentation":"

Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file 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.

" }, "Domain":{ "shape":"SmbDomain", - "documentation":"

Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

For more information, see required permissions for FSx for Windows File Server locations.

" + "documentation":"

Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.

" }, "Password":{ "shape":"SmbPassword", - "documentation":"

Specifies the password of the user who has the permissions to access files and folders in the file system.

For more information, see required permissions for FSx for Windows File Server locations.

" + "documentation":"

Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

" } } }, @@ -1556,24 +1556,24 @@ "members":{ "Subdirectory":{ "shape":"S3Subdirectory", - "documentation":"

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

" + "documentation":"

Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).

DataSync can't transfer objects with a prefix that begins with a slash (/) or includes //, /./, or /../ patterns. For example:

" }, "S3BucketArn":{ "shape":"S3BucketArn", - "documentation":"

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

" + "documentation":"

Specifies the ARN of the S3 bucket that you want to use as a location. (When creating your DataSync task later, you specify whether this location is a transfer source or destination.)

If your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access point. For more information, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

" }, "S3StorageClass":{ "shape":"S3StorageClass", - "documentation":"

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

" + "documentation":"

Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.

For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to OUTPOSTS.

For more information, see Storage class considerations with Amazon S3 transfers.

" }, "S3Config":{"shape":"S3Config"}, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

" + "documentation":"

(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.

For more information, see Deploy your DataSync agent on Outposts.

" }, "Tags":{ "shape":"InputTagList", - "documentation":"

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

" + "documentation":"

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

" } }, "documentation":"

CreateLocationS3Request

" @@ -1583,7 +1583,7 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.

" + "documentation":"

The ARN of the S3 location that you created.

" } }, "documentation":"

CreateLocationS3Response

" @@ -1600,7 +1600,7 @@ "members":{ "Subdirectory":{ "shape":"SmbSubdirectory", - "documentation":"

Specifies the name of the share exported by your SMB file 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 specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.

" + "documentation":"

Specifies the name of the share exported by your SMB file 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 subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.

" }, "ServerHostname":{ "shape":"ServerHostname", @@ -1608,11 +1608,11 @@ }, "User":{ "shape":"SmbUser", - "documentation":"

Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.

For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

" + "documentation":"

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

" }, "Domain":{ "shape":"SmbDomain", - "documentation":"

Specifies the Windows domain name that your SMB file server belongs to.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

For more information, see required permissions for SMB locations.

" + "documentation":"

Specifies the name of the Active Directory domain that your SMB file server belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

" }, "Password":{ "shape":"SmbPassword", @@ -1686,9 +1686,13 @@ "shape":"FilterList", "documentation":"

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" }, + "ManifestConfig":{ + "shape":"ManifestConfig", + "documentation":"

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration 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.

" + }, "TaskReportConfig":{ "shape":"TaskReportConfig", - "documentation":"

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

" + "documentation":"

Specifies how you want to configure 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.

" } }, "documentation":"

CreateTaskRequest

" @@ -2054,7 +2058,7 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The Amazon Resource Name (ARN) of the FSx for Windows File Server location to describe.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.

" } } }, @@ -2063,15 +2067,15 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was described.

" + "documentation":"

The ARN of the FSx for Windows File Server location.

" }, "LocationUri":{ "shape":"LocationUri", - "documentation":"

The URL of the FSx for Windows File Server location that was described.

" + "documentation":"

The uniform resource identifier (URI) of the FSx for Windows File Server location.

" }, "SecurityGroupArns":{ "shape":"Ec2SecurityGroupArnList", - "documentation":"

The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Windows File Server file system.

" + "documentation":"

The ARNs of the security groups that are configured for the FSx for Windows File Server file system.

" }, "CreationTime":{ "shape":"Time", @@ -2079,11 +2083,11 @@ }, "User":{ "shape":"SmbUser", - "documentation":"

The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

" + "documentation":"

The user with the permissions to mount and access the FSx for Windows File Server file system.

" }, "Domain":{ "shape":"SmbDomain", - "documentation":"

The name of the Windows domain that the FSx for Windows File Server belongs to.

" + "documentation":"

The name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.

" } } }, @@ -2093,7 +2097,7 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The Amazon Resource Name (ARN) of the HDFS cluster location to describe.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the HDFS location.

" } } }, @@ -2102,15 +2106,15 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The ARN of the HDFS cluster location.

" + "documentation":"

The ARN of the HDFS location.

" }, "LocationUri":{ "shape":"LocationUri", - "documentation":"

The URI of the HDFS cluster location.

" + "documentation":"

The URI of the HDFS location.

" }, "NameNodes":{ "shape":"HdfsNameNodeList", - "documentation":"

The NameNode that manage the HDFS namespace.

" + "documentation":"

The NameNode that manages the HDFS namespace.

" }, "BlockSize":{ "shape":"HdfsBlockSize", @@ -2126,7 +2130,7 @@ }, "QopConfiguration":{ "shape":"QopConfiguration", - "documentation":"

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster.

" + "documentation":"

The Quality of Protection (QOP) configuration, which specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the HDFS cluster.

" }, "AuthenticationType":{ "shape":"HdfsAuthenticationType", @@ -2134,7 +2138,7 @@ }, "SimpleUser":{ "shape":"HdfsUser", - "documentation":"

The user name used to identify the client on the host operating system. This parameter is used if the AuthenticationType is defined as SIMPLE.

" + "documentation":"

The user name to identify the client on the host operating system. This parameter is used if the AuthenticationType is defined as SIMPLE.

" }, "KerberosPrincipal":{ "shape":"KerberosPrincipal", @@ -2142,7 +2146,7 @@ }, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

The ARNs of the agents that are used to connect to the HDFS cluster.

" + "documentation":"

The ARNs of the DataSync agents that can connect with your HDFS cluster.

" }, "CreationTime":{ "shape":"Time", @@ -2170,7 +2174,7 @@ }, "LocationUri":{ "shape":"LocationUri", - "documentation":"

The URL of the NFS location.

" + "documentation":"

The URI of the NFS location.

" }, "OnPremConfig":{"shape":"OnPremConfig"}, "MountOptions":{ @@ -2190,7 +2194,7 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The Amazon Resource Name (ARN) of the object storage system location that you want information about.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the object storage system location.

" } }, "documentation":"

DescribeLocationObjectStorageRequest

" @@ -2204,7 +2208,7 @@ }, "LocationUri":{ "shape":"LocationUri", - "documentation":"

The URL of the object storage system location.

" + "documentation":"

The URI of the object storage system location.

" }, "AccessKey":{ "shape":"ObjectStorageAccessKey", @@ -2220,7 +2224,7 @@ }, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

The ARNs of the DataSync agents that can securely connect with your location.

" + "documentation":"

The ARNs of the DataSync agents that can connect with your object storage system.

" }, "CreationTime":{ "shape":"Time", @@ -2239,7 +2243,7 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.

" } }, "documentation":"

DescribeLocationS3Request

" @@ -2249,7 +2253,7 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

" + "documentation":"

The ARN of the Amazon S3 location.

" }, "LocationUri":{ "shape":"LocationUri", @@ -2257,16 +2261,16 @@ }, "S3StorageClass":{ "shape":"S3StorageClass", - "documentation":"

The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

" + "documentation":"

When Amazon S3 is a destination location, this is the storage class that you chose for your objects.

Some storage classes have behaviors that can affect your Amazon S3 storage costs. For more information, see Storage class considerations with Amazon S3 transfers.

" }, "S3Config":{"shape":"S3Config"}, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

" + "documentation":"

The ARNs of the DataSync agents deployed on your Outpost when using working with Amazon S3 on Outposts.

For more information, see Deploy your DataSync agent on Outposts.

" }, "CreationTime":{ "shape":"Time", - "documentation":"

The time that the Amazon S3 bucket location was created.

" + "documentation":"

The time that the Amazon S3 location was created.

" } }, "documentation":"

DescribeLocationS3Response

" @@ -2277,7 +2281,7 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The Amazon Resource Name (ARN) of the SMB location to describe.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about.

" } }, "documentation":"

DescribeLocationSmbRequest

" @@ -2287,27 +2291,27 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The Amazon Resource Name (ARN) of the SMB location that was described.

" + "documentation":"

The ARN of the SMB location.

" }, "LocationUri":{ "shape":"LocationUri", - "documentation":"

The URL of the source SMB location that was described.

" + "documentation":"

The URI of the SMB location.

" }, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

" + "documentation":"

The ARNs of the DataSync agents that can connect with your SMB file server.

" }, "User":{ "shape":"SmbUser", - "documentation":"

The user who can mount the share, has the permissions to access files and folders in the SMB share.

" + "documentation":"

The user that can mount and access the files, folders, and file metadata in your SMB file server.

" }, "Domain":{ "shape":"SmbDomain", - "documentation":"

The name of the Windows domain that the SMB server belongs to.

" + "documentation":"

The name of the Microsoft Active Directory domain that the SMB file server belongs to.

" }, "MountOptions":{ "shape":"SmbMountOptions", - "documentation":"

The mount options that are available for DataSync to use to access an SMB location.

" + "documentation":"

The protocol that DataSync use to access your SMB file.

" }, "CreationTime":{ "shape":"Time", @@ -2499,6 +2503,10 @@ "shape":"FilterList", "documentation":"

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" }, + "ManifestConfig":{ + "shape":"ManifestConfig", + "documentation":"

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

" + }, "StartTime":{ "shape":"Time", "documentation":"

The time when the task execution started.

" @@ -2523,17 +2531,17 @@ "shape":"long", "documentation":"

The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

" }, - "Result":{ - "shape":"TaskExecutionResultDetail", - "documentation":"

The result of the task execution.

" - }, "BytesCompressed":{ "shape":"long", "documentation":"

The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than BytesTransferred unless the data isn't compressible.

" }, + "Result":{ + "shape":"TaskExecutionResultDetail", + "documentation":"

The result of the task execution.

" + }, "TaskReportConfig":{ "shape":"TaskReportConfig", - "documentation":"

The configuration of your task report, which provides detailed information about for your DataSync transfer.

" + "documentation":"

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

" }, "FilesDeleted":{ "shape":"long", @@ -2636,9 +2644,13 @@ "shape":"FilterList", "documentation":"

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" }, + "ManifestConfig":{ + "shape":"ManifestConfig", + "documentation":"

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

" + }, "TaskReportConfig":{ "shape":"TaskReportConfig", - "documentation":"

The configuration of your task report. For more information, see Creating a task report.

" + "documentation":"

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

" } }, "documentation":"

DescribeTaskResponse

" @@ -2919,7 +2931,7 @@ "members":{ "Domain":{ "shape":"SmbDomain", - "documentation":"

Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

" + "documentation":"

Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

" }, "MountOptions":{"shape":"SmbMountOptions"}, "Password":{ @@ -2928,7 +2940,7 @@ }, "User":{ "shape":"SmbUser", - "documentation":"

Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

If you provide a user in your Active Directory, note the following:

Make sure that the user has the permissions it needs to copy the data you want:

" + "documentation":"

Specifies a user that can mount and access the files, 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.

" } }, "documentation":"

Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see Accessing FSx for ONTAP file systems.

" @@ -3302,15 +3314,15 @@ "members":{ "TaskArn":{ "shape":"TaskArn", - "documentation":"

The Amazon Resource Name (ARN) of the task whose tasks you want to list.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the task that you want execution information about.

" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"

The maximum number of executed tasks to list.

" + "documentation":"

Specifies how many results you want in the response.

" }, "NextToken":{ "shape":"NextToken", - "documentation":"

An opaque string that indicates the position at which to begin the next list of the executed tasks.

" + "documentation":"

Specifies an opaque string that indicates the position at which to begin the next list of results in the response.

" } }, "documentation":"

ListTaskExecutions

" @@ -3320,11 +3332,11 @@ "members":{ "TaskExecutions":{ "shape":"TaskExecutionList", - "documentation":"

A list of executed tasks.

" + "documentation":"

A list of the task's executions.

" }, "NextToken":{ "shape":"NextToken", - "documentation":"

An opaque string that indicates the position at which to begin returning the next list of executed tasks.

" + "documentation":"

The opaque string that indicates the position to begin the next list of results in the response.

" } }, "documentation":"

ListTaskExecutionsResponse

" @@ -3437,6 +3449,32 @@ "TRANSFER" ] }, + "ManifestAction":{ + "type":"string", + "enum":["TRANSFER"] + }, + "ManifestConfig":{ + "type":"structure", + "members":{ + "Action":{ + "shape":"ManifestAction", + "documentation":"

Specifies what DataSync uses the manifest for.

" + }, + "Format":{ + "shape":"ManifestFormat", + "documentation":"

Specifies the file format of your manifest. For more information, see Creating a manifest.

" + }, + "Source":{ + "shape":"SourceManifestConfig", + "documentation":"

Specifies the manifest that you want DataSync to use and where it's hosted.

You must specify this parameter if you're configuring 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.

" + } + }, + "documentation":"

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

" + }, + "ManifestFormat":{ + "type":"string", + "enum":["CSV"] + }, "MaxP95Performance":{ "type":"structure", "members":{ @@ -3828,39 +3866,39 @@ "members":{ "VerifyMode":{ "shape":"VerifyMode", - "documentation":"

Specifies how and when DataSync checks the integrity of your data during a transfer.

Default value: POINT_IN_TIME_CONSISTENT

ONLY_FILES_TRANSFERRED (recommended): DataSync calculates the checksum of transferred files and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on those files at the destination.

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 scans the entire source and destination to verify that both locations are fully synchronized.

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 doesn't run additional verification at the end of the transfer. All data transmissions are still integrity-checked with checksum verification during the transfer.

" + "documentation":"

Specifies how and when DataSync checks the integrity of your data during a transfer.

" }, "OverwriteMode":{ "shape":"OverwriteMode", - "documentation":"

Specifies whether data at the destination location should be overwritten or preserved. If set to NEVER, a destination file for example will not be replaced by a source file (even if the destination file differs from the source file). If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your Amazon S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.

" + "documentation":"

Specifies whether DataSync should modify or preserve data at the destination location.

" }, "Atime":{ "shape":"Atime", - "documentation":"

Specifies whether to preserve metadata indicating the last time a file was read or written to. If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase of the task execution).

The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

" + "documentation":"

Specifies whether to preserve metadata indicating the last time a file was read or written to.

The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

" }, "Mtime":{ "shape":"Mtime", - "documentation":"

Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING phase of your task execution. This option is required when you need to run the a task more than once.

Default Value: PRESERVE

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

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.

" + "documentation":"

Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING phase of your task execution. This option is required when you need to run the a task more than once.

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.

" }, "Uid":{ "shape":"Uid", - "documentation":"

Specifies the POSIX user ID (UID) of the file's owner.

For more information, see Metadata copied by DataSync.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

" + "documentation":"

Specifies the POSIX user ID (UID) of the file's owner.

For more information, see Metadata copied by DataSync.

" }, "Gid":{ "shape":"Gid", - "documentation":"

Specifies the POSIX group ID (GID) of the file's owners.

For more information, see Metadata copied by DataSync.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

" + "documentation":"

Specifies the POSIX group ID (GID) of the file's owners.

For more information, see Metadata copied by DataSync.

" }, "PreserveDeletedFiles":{ "shape":"PreserveDeletedFiles", - "documentation":"

Specifies whether files in the destination location that don't exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, 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.

Default value: PRESERVE

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

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.

" + "documentation":"

Specifies whether files in the destination location that don't exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, 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.

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.

" }, "PreserveDevices":{ "shape":"PreserveDevices", - "documentation":"

Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.

DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option currently isn't supported for Amazon EFS.

" + "documentation":"

Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.

DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker.

" }, "PosixPermissions":{ "shape":"PosixPermissions", - "documentation":"

Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

For more information, see Metadata copied by DataSync.

Default value: PRESERVE

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

DataSync can preserve extant permissions of a source location.

" + "documentation":"

Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

For more information, see Metadata copied by DataSync.

DataSync can preserve extant permissions of a source location.

" }, "BytesPerSecond":{ "shape":"BytesPerSecond", @@ -3872,19 +3910,19 @@ }, "LogLevel":{ "shape":"LogLevel", - "documentation":"

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn.

If you set LogLevel to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred. TRANSFER publishes logs for every file or object that is transferred and integrity checked.

" + "documentation":"

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn.

" }, "TransferMode":{ "shape":"TransferMode", - "documentation":"

Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination).

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL: DataSync copies all source location content to the destination (without comparing what's in the destination).

" + "documentation":"

Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination).

" }, "SecurityDescriptorCopyFlags":{ "shape":"SmbSecurityDescriptorCopyFlags", - "documentation":"

Specifies 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 how DataSync handles metadata.

Default value: OWNER_DACL

OWNER_DACL: For each copied object, DataSync copies the following metadata:

OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:

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 configuration.

" + "documentation":"

Specifies 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 how DataSync handles metadata.

" }, "ObjectTags":{ "shape":"ObjectTags", - "documentation":"

Specifies whether object tags are preserved when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

Default Value: PRESERVE

" + "documentation":"

Specifies 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.

" } }, "documentation":"

Indicates how your transfer task is configured. These options include how DataSync handles files, 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 configure any of these options before starting your task.

" @@ -3945,7 +3983,7 @@ "members":{ "Version":{ "shape":"AgentVersion", - "documentation":"

The version of the DataSync agent.

Beginning December 7, 2023, we will discontinue version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, replace those agents before then to avoid data transfer or storage discovery disruptions. If you need more help, contact Amazon Web Services Support.

" + "documentation":"

The version of the DataSync agent.

On December 7, 2023, we discontinued version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, replace those agents or delete them if they aren't in use. If you need more help, contact Amazon Web Services Support.

" } }, "documentation":"

The platform-related details about the DataSync agent, such as the version number.

" @@ -4107,7 +4145,7 @@ }, "BucketAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"

Specifies 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.

" + "documentation":"

Specifies 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.

" } }, "documentation":"

Specifies the Amazon S3 bucket where DataSync uploads your task report.

" @@ -4246,10 +4284,43 @@ "members":{ "BucketAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"

The ARN of the IAM role for accessing the S3 bucket.

" + "documentation":"

Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.

" } }, - "documentation":"

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access an Amazon S3 bucket.

For detailed information about using such a role, see Creating a Location for Amazon S3 in the DataSync User Guide.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.

For more information, see Accessing S3 buckets.

" + }, + "S3ManifestConfig":{ + "type":"structure", + "required":[ + "ManifestObjectPath", + "BucketAccessRoleArn", + "S3BucketArn" + ], + "members":{ + "ManifestObjectPath":{ + "shape":"S3Subdirectory", + "documentation":"

Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example, prefix/my-manifest.csv).

" + }, + "BucketAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

Specifies the Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see Providing DataSync access to your manifest.

" + }, + "S3BucketArn":{ + "shape":"S3BucketArn", + "documentation":"

Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.

" + }, + "ManifestObjectVersionId":{ + "shape":"S3ObjectVersionId", + "documentation":"

Specifies 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.

" + } + }, + "documentation":"

Specifies the S3 bucket where you're hosting the manifest that you want DataSync to use. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

" + }, + "S3ObjectVersionId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^.+$" }, "S3StorageClass":{ "type":"string", @@ -4333,6 +4404,17 @@ "SMB2_0" ] }, + "SourceManifestConfig":{ + "type":"structure", + "required":["S3"], + "members":{ + "S3":{ + "shape":"S3ManifestConfig", + "documentation":"

Specifies the S3 bucket where you're hosting your manifest.

" + } + }, + "documentation":"

Specifies the manifest that you want DataSync to use and where it's hosted. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

" + }, "SourceNetworkInterfaceArns":{ "type":"list", "member":{"shape":"NetworkInterfaceArn"} @@ -4390,13 +4472,17 @@ "shape":"FilterList", "documentation":"

Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" }, - "Tags":{ - "shape":"InputTagList", - "documentation":"

Specifies 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, filter, and search for your DataSync resources.

" + "ManifestConfig":{ + "shape":"ManifestConfig", + "documentation":"

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration 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.

To remove a manifest configuration, specify this parameter with an empty value.

" }, "TaskReportConfig":{ "shape":"TaskReportConfig", - "documentation":"

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

" + "documentation":"

Specifies how you want to configure 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 configuration, specify this parameter as empty.

" + }, + "Tags":{ + "shape":"InputTagList", + "documentation":"

Specifies 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, filter, and search for your DataSync resources.

" } }, "documentation":"

StartTaskExecutionRequest

" @@ -4542,14 +4628,14 @@ "members":{ "TaskExecutionArn":{ "shape":"TaskExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the task that was executed.

" + "documentation":"

The Amazon Resource Name (ARN) of a task execution.

" }, "Status":{ "shape":"TaskExecutionStatus", - "documentation":"

The status of a task execution.

" + "documentation":"

The status of a task execution. For more information, see Task execution statuses.

" } }, - "documentation":"

Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when the ListTaskExecutions operation is called.

" + "documentation":"

Represents a single entry in a list of DataSync task executions that's returned with the ListTaskExecutions operation.

" }, "TaskExecutionResultDetail":{ "type":"structure", @@ -5105,9 +5191,13 @@ "shape":"FilterList", "documentation":"

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" }, + "ManifestConfig":{ + "shape":"ManifestConfig", + "documentation":"

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration 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 configuration, specify this parameter as empty.

" + }, "TaskReportConfig":{ "shape":"TaskReportConfig", - "documentation":"

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

" + "documentation":"

Specifies how you want to configure 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 configuration, specify this parameter as empty.

" } }, "documentation":"

UpdateTaskResponse

" diff --git a/botocore/data/lexv2-models/2020-08-07/service-2.json b/botocore/data/lexv2-models/2020-08-07/service-2.json index 37a10e5a4d..c55e824971 100644 --- a/botocore/data/lexv2-models/2020-08-07/service-2.json +++ b/botocore/data/lexv2-models/2020-08-07/service-2.json @@ -143,6 +143,25 @@ ], "documentation":"

Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.

" }, + "CreateBotReplica":{ + "name":"CreateBotReplica", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/replicas/", + "responseCode":202 + }, + "input":{"shape":"CreateBotReplicaRequest"}, + "output":{"shape":"CreateBotReplicaResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Action to create a replication of the source bot in the secondary region.

" + }, "CreateBotVersion":{ "name":"CreateBotVersion", "http":{ @@ -371,6 +390,25 @@ ], "documentation":"

Removes a locale from a bot.

When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

" }, + "DeleteBotReplica":{ + "name":"DeleteBotReplica", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botId}/replicas/{replicaRegion}/", + "responseCode":202 + }, + "input":{"shape":"DeleteBotReplicaRequest"}, + "output":{"shape":"DeleteBotReplicaResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

The action to delete the replicated bot in the secondary region.

" + }, "DeleteBotVersion":{ "name":"DeleteBotVersion", "http":{ @@ -639,6 +677,24 @@ ], "documentation":"

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

" }, + "DescribeBotReplica":{ + "name":"DescribeBotReplica", + "http":{ + "method":"GET", + "requestUri":"/bots/{botId}/replicas/{replicaRegion}/", + "responseCode":200 + }, + "input":{"shape":"DescribeBotReplicaRequest"}, + "output":{"shape":"DescribeBotReplicaResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Monitors the bot replication status through the UI console.

" + }, "DescribeBotResourceGeneration":{ "name":"DescribeBotResourceGeneration", "http":{ @@ -924,6 +980,23 @@ ], "documentation":"

Provides a list of utterances that users have sent to the bot.

Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase \"I want to order pizza\" are aggregated into the same line in the response.

You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.

Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.

Utterances statistics are not generated under the following conditions:

" }, + "ListBotAliasReplicas":{ + "name":"ListBotAliasReplicas", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/replicas/{replicaRegion}/botaliases/", + "responseCode":200 + }, + "input":{"shape":"ListBotAliasReplicasRequest"}, + "output":{"shape":"ListBotAliasReplicasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

The action to list the replicated bots created from the source bot alias.

" + }, "ListBotAliases":{ "name":"ListBotAliases", "http":{ @@ -975,6 +1048,23 @@ ], "documentation":"

Get a list of bot recommendations that meet the specified criteria.

" }, + "ListBotReplicas":{ + "name":"ListBotReplicas", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/replicas/", + "responseCode":200 + }, + "input":{"shape":"ListBotReplicasRequest"}, + "output":{"shape":"ListBotReplicasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

The action to list the replicated bots.

" + }, "ListBotResourceGenerations":{ "name":"ListBotResourceGenerations", "http":{ @@ -992,6 +1082,23 @@ ], "documentation":"

Lists the generation requests made for a bot locale.

" }, + "ListBotVersionReplicas":{ + "name":"ListBotVersionReplicas", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/replicas/{replicaRegion}/botversions/", + "responseCode":200 + }, + "input":{"shape":"ListBotVersionReplicasRequest"}, + "output":{"shape":"ListBotVersionReplicasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Contains information about all the versions replication statuses applicable for Global Resiliency.

" + }, "ListBotVersions":{ "name":"ListBotVersions", "http":{ @@ -3258,6 +3365,51 @@ "min":1, "pattern":"^(\\bAmazonLexTestAlias\\b|[0-9a-zA-Z][_-]?)+$" }, + "BotAliasReplicaSummary":{ + "type":"structure", + "members":{ + "botAliasId":{ + "shape":"BotAliasId", + "documentation":"

The bot alias ID for all the alias bot replications.

" + }, + "botAliasReplicationStatus":{ + "shape":"BotAliasReplicationStatus", + "documentation":"

The replication statuses for all the alias bot replications.

" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"

The bot version for all the alias bot replications.

" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"

The creation time and date for all the alias bot replications.

" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"

The last time and date updated for all the alias bot replications.

" + }, + "failureReasons":{ + "shape":"FailureReasons", + "documentation":"

The reasons for failure for the aliases bot replications.

" + } + }, + "documentation":"

Contains information about all the aliases replication statuses applicable for global resiliency.

" + }, + "BotAliasReplicaSummaryList":{ + "type":"list", + "member":{"shape":"BotAliasReplicaSummary"} + }, + "BotAliasReplicationStatus":{ + "type":"string", + "documentation":"

The status of the operation to replicate the bot alias. Values: Creating, Updating, Available, Deleting, Failed.

", + "enum":[ + "Creating", + "Updating", + "Available", + "Deleting", + "Failed" + ] + }, "BotAliasStatus":{ "type":"string", "enum":[ @@ -3721,6 +3873,42 @@ "type":"list", "member":{"shape":"BotRecommendationSummary"} }, + "BotReplicaStatus":{ + "type":"string", + "documentation":"

The status of the operation to replicate the bot. Values: Enabling, Enabled, Deleting, Failed.

", + "enum":[ + "Enabling", + "Enabled", + "Deleting", + "Failed" + ] + }, + "BotReplicaSummary":{ + "type":"structure", + "members":{ + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The replica region used in the replication statuses summary.

" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"

The creation time and date for the replicated bots.

" + }, + "botReplicaStatus":{ + "shape":"BotReplicaStatus", + "documentation":"

The operation status for the replicated bot applicable.

" + }, + "failureReasons":{ + "shape":"FailureReasons", + "documentation":"

The reasons for the failure for the replicated bot.

" + } + }, + "documentation":"

Contains summary information about all the replication statuses applicable for global resiliency.

" + }, + "BotReplicaSummaryList":{ + "type":"list", + "member":{"shape":"BotReplicaSummary"} + }, "BotSortAttribute":{ "type":"string", "enum":["BotName"] @@ -3824,6 +4012,64 @@ "value":{"shape":"BotVersionLocaleDetails"}, "min":1 }, + "BotVersionReplicaSortAttribute":{ + "type":"string", + "enum":["BotVersion"] + }, + "BotVersionReplicaSortBy":{ + "type":"structure", + "required":[ + "attribute", + "order" + ], + "members":{ + "attribute":{ + "shape":"BotVersionReplicaSortAttribute", + "documentation":"

The attribute of the sort category for the version replicated bots.

" + }, + "order":{ + "shape":"SortOrder", + "documentation":"

The order of the sort category for the version replicated bots.

" + } + }, + "documentation":"

The sort category for the version replicated bots.

" + }, + "BotVersionReplicaSummary":{ + "type":"structure", + "members":{ + "botVersion":{ + "shape":"BotVersion", + "documentation":"

The bot version for the summary information for all the version replication statuses.

" + }, + "botVersionReplicationStatus":{ + "shape":"BotVersionReplicationStatus", + "documentation":"

The version replication status for all the replicated bots.

" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"

The creation date and time of the replication status for all the replicated bots.

" + }, + "failureReasons":{ + "shape":"FailureReasons", + "documentation":"

The reasons for replication failure for all the replicated bots.

" + } + }, + "documentation":"

Contains summary information for all the version replication statuses applicable for Global resiliency.

" + }, + "BotVersionReplicaSummaryList":{ + "type":"list", + "member":{"shape":"BotVersionReplicaSummary"} + }, + "BotVersionReplicationStatus":{ + "type":"string", + "documentation":"

The status of the operation to replicate the bot version. Values: Creating, Available, Deleting, Failed.

", + "enum":[ + "Creating", + "Available", + "Deleting", + "Failed" + ] + }, "BotVersionSortAttribute":{ "type":"string", "enum":["BotVersion"] @@ -4609,6 +4855,50 @@ "generativeAISettings":{"shape":"GenerativeAISettings"} } }, + "CreateBotReplicaRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The request for the unique bot ID of the source bot to be replicated in the secondary region.

", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The request for the secondary region that will be used in the replication of the source bot.

" + } + } + }, + "CreateBotReplicaResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The unique bot ID of the replicated bot generated.

" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The region of the replicated bot generated.

" + }, + "sourceRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The source region for the source bot used for the replicated bot generated.

" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"

The creation date and time of the replicated bot generated.

" + }, + "botReplicaStatus":{ + "shape":"BotReplicaStatus", + "documentation":"

The operational status of the replicated bot generated.

" + } + } + }, "CreateBotRequest":{ "type":"structure", "required":[ @@ -5620,6 +5910,44 @@ } } }, + "DeleteBotReplicaRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The unique ID of the replicated bot to be deleted from the secondary region

", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The secondary region of the replicated bot that will be deleted.

", + "location":"uri", + "locationName":"replicaRegion" + } + } + }, + "DeleteBotReplicaResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The unique bot ID of the replicated bot generated.

" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The region of the replicated bot generated.

" + }, + "botReplicaStatus":{ + "shape":"BotReplicaStatus", + "documentation":"

The operational status of the replicated bot generated.

" + } + } + }, "DeleteBotRequest":{ "type":"structure", "required":["botId"], @@ -6290,6 +6618,56 @@ } } }, + "DescribeBotReplicaRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The request for the unique bot ID of the replicated bot being monitored.

", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The request for the region of the replicated bot being monitored.

", + "location":"uri", + "locationName":"replicaRegion" + } + } + }, + "DescribeBotReplicaResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The unique bot ID of the replicated bot being monitored.

" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The region of the replicated bot being monitored.

" + }, + "sourceRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The source region of the replicated bot being monitored.

" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"

The creation date and time of the replicated bot being monitored.

" + }, + "botReplicaStatus":{ + "shape":"BotReplicaStatus", + "documentation":"

The operational status of the replicated bot being monitored.

" + }, + "failureReasons":{ + "shape":"FailureReasons", + "documentation":"

The failure reasons the bot being monitored failed to replicate.

" + } + } + }, "DescribeBotRequest":{ "type":"structure", "required":["botId"], @@ -8629,6 +9007,60 @@ } } }, + "ListBotAliasReplicasRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The request for the unique bot ID of the replicated bot created from the source bot alias.

", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The request for the secondary region of the replicated bot created from the source bot alias.

", + "location":"uri", + "locationName":"replicaRegion" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The request for maximum results to list the replicated bots created from the source bot alias.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The request for the next token for the replicated bot created from the source bot alias.

" + } + } + }, + "ListBotAliasReplicasResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The unique bot ID of the replicated bot created from the source bot alias.

" + }, + "sourceRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The source region of the replicated bot created from the source bot alias.

" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The secondary region of the replicated bot created from the source bot alias.

" + }, + "botAliasReplicaSummaries":{ + "shape":"BotAliasReplicaSummaryList", + "documentation":"

The summary information of the replicated bot created from the source bot alias.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The next token for the replicated bots created from the source bot alias.

" + } + } + }, "ListBotAliasesRequest":{ "type":"structure", "required":["botId"], @@ -8785,6 +9217,35 @@ } } }, + "ListBotReplicasRequest":{ + "type":"structure", + "required":["botId"], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The request for the unique bot IDs in the list of replicated bots.

", + "location":"uri", + "locationName":"botId" + } + } + }, + "ListBotReplicasResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

the unique bot IDs in the list of replicated bots.

" + }, + "sourceRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The source region of the source bots in the list of replicated bots.

" + }, + "botReplicaSummaries":{ + "shape":"BotReplicaSummaryList", + "documentation":"

The summary details for the replicated bots.

" + } + } + }, "ListBotResourceGenerationsRequest":{ "type":"structure", "required":[ @@ -8850,6 +9311,64 @@ } } }, + "ListBotVersionReplicasRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The request for the unique ID in the list of replicated bots.

", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The request for the region used in the list of replicated bots.

", + "location":"uri", + "locationName":"replicaRegion" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum results given in the list of replicated bots.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The next token given in the list of replicated bots.

" + }, + "sortBy":{ + "shape":"BotVersionReplicaSortBy", + "documentation":"

The requested sort category for the list of replicated bots.

" + } + } + }, + "ListBotVersionReplicasResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"

The unique ID of the bots in the list of replicated bots.

" + }, + "sourceRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The source region used for the bots in the list of replicated bots.

" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "documentation":"

The region used for the replicated bots in the list of replicated bots.

" + }, + "botVersionReplicaSummaries":{ + "shape":"BotVersionReplicaSummaryList", + "documentation":"

The information summary used for the replicated bots in the list of replicated bots.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The next token used for the replicated bots in the list of replicated bots.

" + } + } + }, "ListBotVersionsRequest":{ "type":"structure", "required":["botId"], @@ -10599,6 +11118,12 @@ }, "documentation":"

Specifies the time window that utterance statistics are returned for. The time window is always relative to the last time that the that utterances were aggregated. For example, if the ListAggregatedUtterances operation is called at 1600, the time window is set to 1 hour, and the last refresh time was 1530, only utterances made between 1430 and 1530 are returned.

You can choose the time window that statistics should be returned for.

" }, + "ReplicaRegion":{ + "type":"string", + "documentation":"

The region that contains the replicated bots. Minimum value = 2, maximum value = 25.

", + "max":25, + "min":2 + }, "ResourceCount":{"type":"integer"}, "ResourceNotFoundException":{ "type":"structure", diff --git a/botocore/data/redshift/2012-12-01/paginators-1.json b/botocore/data/redshift/2012-12-01/paginators-1.json index a103fac93a..f59049396e 100644 --- a/botocore/data/redshift/2012-12-01/paginators-1.json +++ b/botocore/data/redshift/2012-12-01/paginators-1.json @@ -209,6 +209,12 @@ "limit_key": "MaxRecords", "output_token": "Marker", "result_key": "RedshiftIdcApplications" + }, + "ListRecommendations": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Recommendations" } } } diff --git a/botocore/data/redshift/2012-12-01/service-2.json b/botocore/data/redshift/2012-12-01/service-2.json index edb670c9cb..90d00cc05b 100644 --- a/botocore/data/redshift/2012-12-01/service-2.json +++ b/botocore/data/redshift/2012-12-01/service-2.json @@ -1760,6 +1760,23 @@ ], "documentation":"

Get the resource policy for a specified resource.

" }, + "ListRecommendations":{ + "name":"ListRecommendations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRecommendationsMessage"}, + "output":{ + "shape":"ListRecommendationsResult", + "resultWrapper":"ListRecommendationsResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"

List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.

" + }, "ModifyAquaConfiguration":{ "name":"ModifyAquaConfiguration", "http":{ @@ -7264,6 +7281,14 @@ "min":1, "pattern":"^[a-zA-Z0-9_+.#@$-]+$" }, + "ImpactRankingType":{ + "type":"string", + "enum":[ + "HIGH", + "MEDIUM", + "LOW" + ] + }, "ImportTablesCompleted":{ "type":"list", "member":{"shape":"String"} @@ -7832,6 +7857,40 @@ }, "exception":true }, + "ListRecommendationsMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

The unique identifier of the Amazon Redshift cluster for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

" + }, + "NamespaceArn":{ + "shape":"String", + "documentation":"

The Amazon Redshift cluster namespace Amazon Resource Name (ARN) for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" + } + } + }, + "ListRecommendationsResult":{ + "type":"structure", + "members":{ + "Recommendations":{ + "shape":"RecommendationList", + "documentation":"

The Advisor recommendations for action on the Amazon Redshift cluster.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" + } + } + }, "LogDestinationType":{ "type":"string", "enum":[ @@ -9013,6 +9072,103 @@ "Cluster":{"shape":"Cluster"} } }, + "Recommendation":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"

A unique identifier of the Advisor recommendation.

" + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

The unique identifier of the cluster for which the recommendation is returned.

" + }, + "NamespaceArn":{ + "shape":"String", + "documentation":"

The Amazon Redshift cluster namespace ARN for which the recommendations is returned.

" + }, + "CreatedAt":{ + "shape":"TStamp", + "documentation":"

The date and time (UTC) that the recommendation was created.

" + }, + "RecommendationType":{ + "shape":"String", + "documentation":"

The type of Advisor recommendation.

" + }, + "Title":{ + "shape":"String", + "documentation":"

The title of the recommendation.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the recommendation.

" + }, + "Observation":{ + "shape":"String", + "documentation":"

The description of what was observed about your cluster.

" + }, + "ImpactRanking":{ + "shape":"ImpactRankingType", + "documentation":"

The scale of the impact that the Advisor recommendation has to the performance and cost of the cluster.

" + }, + "RecommendationText":{ + "shape":"String", + "documentation":"

The description of the recommendation.

" + }, + "RecommendedActions":{ + "shape":"RecommendedActionList", + "documentation":"

List of Amazon Redshift recommended actions.

" + }, + "ReferenceLinks":{ + "shape":"ReferenceLinkList", + "documentation":"

List of helpful links for more information about the Advisor recommendation.

" + } + }, + "documentation":"

An Amazon Redshift Advisor recommended action on the Amazon Redshift cluster.

" + }, + "RecommendationList":{ + "type":"list", + "member":{ + "shape":"Recommendation", + "locationName":"Recommendation" + } + }, + "RecommendedAction":{ + "type":"structure", + "members":{ + "Text":{ + "shape":"String", + "documentation":"

The specific instruction about the command.

" + }, + "Database":{ + "shape":"String", + "documentation":"

The database name to perform the action on. Only applicable if the type of command is SQL.

" + }, + "Command":{ + "shape":"String", + "documentation":"

The command to run.

" + }, + "Type":{ + "shape":"RecommendedActionType", + "documentation":"

The type of command.

" + } + }, + "documentation":"

The recommended action from the Amazon Redshift Advisor recommendation.

" + }, + "RecommendedActionList":{ + "type":"list", + "member":{ + "shape":"RecommendedAction", + "locationName":"RecommendedAction" + } + }, + "RecommendedActionType":{ + "type":"string", + "enum":[ + "SQL", + "CLI" + ] + }, "RecurringCharge":{ "type":"structure", "members":{ @@ -9128,6 +9284,27 @@ }, "exception":true }, + "ReferenceLink":{ + "type":"structure", + "members":{ + "Text":{ + "shape":"String", + "documentation":"

The hyperlink text that describes the link to more information.

" + }, + "Link":{ + "shape":"String", + "documentation":"

The URL address to find more information.

" + } + }, + "documentation":"

A link to an Amazon Redshift Advisor reference for more information about a recommendation.

" + }, + "ReferenceLinkList":{ + "type":"list", + "member":{ + "shape":"ReferenceLink", + "locationName":"ReferenceLink" + } + }, "RejectDataShareMessage":{ "type":"structure", "required":["DataShareArn"],