diff --git a/apis/datasync/2018-11-09/api-2.json b/apis/datasync/2018-11-09/api-2.json index 1fe510083d3..0a6d5abe82c 100644 --- a/apis/datasync/2018-11-09/api-2.json +++ b/apis/datasync/2018-11-09/api-2.json @@ -1246,6 +1246,7 @@ "Schedule":{"shape":"TaskSchedule"}, "Tags":{"shape":"InputTagList"}, "Includes":{"shape":"FilterList"}, + "ManifestConfig":{"shape":"ManifestConfig"}, "TaskReportConfig":{"shape":"TaskReportConfig"} } }, @@ -1629,14 +1630,15 @@ "Options":{"shape":"Options"}, "Excludes":{"shape":"FilterList"}, "Includes":{"shape":"FilterList"}, + "ManifestConfig":{"shape":"ManifestConfig"}, "StartTime":{"shape":"Time"}, "EstimatedFilesToTransfer":{"shape":"long"}, "EstimatedBytesToTransfer":{"shape":"long"}, "FilesTransferred":{"shape":"long"}, "BytesWritten":{"shape":"long"}, "BytesTransferred":{"shape":"long"}, - "Result":{"shape":"TaskExecutionResultDetail"}, "BytesCompressed":{"shape":"long"}, + "Result":{"shape":"TaskExecutionResultDetail"}, "TaskReportConfig":{"shape":"TaskReportConfig"}, "FilesDeleted":{"shape":"long"}, "FilesSkipped":{"shape":"long"}, @@ -1671,6 +1673,7 @@ "ErrorDetail":{"shape":"string"}, "CreationTime":{"shape":"Time"}, "Includes":{"shape":"FilterList"}, + "ManifestConfig":{"shape":"ManifestConfig"}, "TaskReportConfig":{"shape":"TaskReportConfig"} } }, @@ -2255,6 +2258,22 @@ "TRANSFER" ] }, + "ManifestAction":{ + "type":"string", + "enum":["TRANSFER"] + }, + "ManifestConfig":{ + "type":"structure", + "members":{ + "Action":{"shape":"ManifestAction"}, + "Format":{"shape":"ManifestFormat"}, + "Source":{"shape":"SourceManifestConfig"} + } + }, + "ManifestFormat":{ + "type":"string", + "enum":["CSV"] + }, "MaxP95Performance":{ "type":"structure", "members":{ @@ -2737,6 +2756,26 @@ "BucketAccessRoleArn":{"shape":"IamRoleArn"} } }, + "S3ManifestConfig":{ + "type":"structure", + "required":[ + "ManifestObjectPath", + "BucketAccessRoleArn", + "S3BucketArn" + ], + "members":{ + "ManifestObjectPath":{"shape":"S3Subdirectory"}, + "BucketAccessRoleArn":{"shape":"IamRoleArn"}, + "S3BucketArn":{"shape":"S3BucketArn"}, + "ManifestObjectVersionId":{"shape":"S3ObjectVersionId"} + } + }, + "S3ObjectVersionId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^.+$" + }, "S3StorageClass":{ "type":"string", "enum":[ @@ -2815,6 +2854,13 @@ "SMB2_0" ] }, + "SourceManifestConfig":{ + "type":"structure", + "required":["S3"], + "members":{ + "S3":{"shape":"S3ManifestConfig"} + } + }, "SourceNetworkInterfaceArns":{ "type":"list", "member":{"shape":"NetworkInterfaceArn"} @@ -2850,8 +2896,9 @@ "OverrideOptions":{"shape":"Options"}, "Includes":{"shape":"FilterList"}, "Excludes":{"shape":"FilterList"}, - "Tags":{"shape":"InputTagList"}, - "TaskReportConfig":{"shape":"TaskReportConfig"} + "ManifestConfig":{"shape":"ManifestConfig"}, + "TaskReportConfig":{"shape":"TaskReportConfig"}, + "Tags":{"shape":"InputTagList"} } }, "StartTaskExecutionResponse":{ @@ -3275,6 +3322,7 @@ "Name":{"shape":"TagValue"}, "CloudWatchLogGroupArn":{"shape":"LogGroupArn"}, "Includes":{"shape":"FilterList"}, + "ManifestConfig":{"shape":"ManifestConfig"}, "TaskReportConfig":{"shape":"TaskReportConfig"} } }, diff --git a/apis/datasync/2018-11-09/docs-2.json b/apis/datasync/2018-11-09/docs-2.json index add630c67f8..6cfacd9bc1f 100644 --- a/apis/datasync/2018-11-09/docs-2.json +++ b/apis/datasync/2018-11-09/docs-2.json @@ -5,34 +5,34 @@ "AddStorageSystem": "

Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.

", "CancelTaskExecution": "

Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.

However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.

", "CreateAgent": "

Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.

If you haven't deployed an agent yet, see the following topics to learn more:

If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.

", - "CreateLocationAzureBlob": "

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.

", - "CreateLocationEfs": "

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.

", - "CreateLocationFsxLustre": "

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

", - "CreateLocationFsxOntap": "

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.

", - "CreateLocationFsxOpenZfs": "

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.

", - "CreateLocationFsxWindows": "

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.

", - "CreateLocationHdfs": "

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

", - "CreateLocationNfs": "

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.

", - "CreateLocationObjectStorage": "

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.

", - "CreateLocationS3": "

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.

", - "CreateLocationSmb": "

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.

", + "CreateLocationAzureBlob": "

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": "

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": "

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": "

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": "

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": "

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": "

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": "

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": "

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": "

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": "

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": "

Configures a transfer task, which defines where and how DataSync moves your data.

A task includes a source location, destination location, and the options for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).

If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.

", "DeleteAgent": "

Removes an DataSync agent resource from your Amazon Web Services account.

Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.

", - "DeleteLocation": "

Deletes the configuration of a location used by DataSync.

", - "DeleteTask": "

Deletes an DataSync transfer task.

", + "DeleteLocation": "

Deletes a transfer location resource from DataSync.

", + "DeleteTask": "

Deletes a transfer task resource from DataSync.

", "DescribeAgent": "

Returns information about an DataSync agent, such as its name, service endpoint type, and status.

", "DescribeDiscoveryJob": "

Returns information about a DataSync discovery job.

", "DescribeLocationAzureBlob": "

Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.

", - "DescribeLocationEfs": "

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

", - "DescribeLocationFsxLustre": "

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

", - "DescribeLocationFsxOntap": "

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.

", - "DescribeLocationFsxOpenZfs": "

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.

", - "DescribeLocationFsxWindows": "

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

", - "DescribeLocationHdfs": "

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

", + "DescribeLocationEfs": "

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

", + "DescribeLocationFsxLustre": "

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

", + "DescribeLocationFsxOntap": "

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": "

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": "

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

", + "DescribeLocationHdfs": "

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

", "DescribeLocationNfs": "

Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.

", - "DescribeLocationObjectStorage": "

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

", - "DescribeLocationS3": "

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

", - "DescribeLocationSmb": "

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

", + "DescribeLocationObjectStorage": "

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

", + "DescribeLocationS3": "

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

", + "DescribeLocationSmb": "

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

", "DescribeStorageSystem": "

Returns information about an on-premises storage system that you're using with DataSync Discovery.

", "DescribeStorageSystemResourceMetrics": "

Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.

", "DescribeStorageSystemResources": "

Returns information that DataSync Discovery collects about resources in your on-premises storage system.

", @@ -44,7 +44,7 @@ "ListLocations": "

Returns a list of source and destination locations.

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.

", "ListStorageSystems": "

Lists the on-premises storage systems that you're using with DataSync Discovery.

", "ListTagsForResource": "

Returns all the tags associated with an Amazon Web Services resource.

", - "ListTaskExecutions": "

Returns a list of executed tasks.

", + "ListTaskExecutions": "

Returns a list of executions for an DataSync transfer task.

", "ListTasks": "

Returns a list of the DataSync tasks you created.

", "RemoveStorageSystem": "

Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.

", "StartDiscoveryJob": "

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 first by using the AddStorageSystem operation.

", @@ -60,7 +60,7 @@ "UpdateLocationObjectStorage": "

Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.

", "UpdateLocationSmb": "

Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.

", "UpdateStorageSystem": "

Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.

", - "UpdateTask": "

Updates the configuration of a DataSync transfer task.

", + "UpdateTask": "

Updates the configuration of an DataSync transfer task.

", "UpdateTaskExecution": "

Updates the configuration of a running DataSync task execution.

Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution.

" }, "shapes": { @@ -99,13 +99,13 @@ "CreateLocationAzureBlobRequest$AgentArns": "

Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

You can specify more than one agent. For more information, see Using multiple agents for your transfer.

", "CreateLocationHdfsRequest$AgentArns": "

The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.

", "CreateLocationObjectStorageRequest$AgentArns": "

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

", - "CreateLocationS3Request$AgentArns": "

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.

", + "CreateLocationS3Request$AgentArns": "

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

", "CreateLocationSmbRequest$AgentArns": "

Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

", "DescribeLocationAzureBlobResponse$AgentArns": "

The ARNs of the DataSync agents that can connect with your Azure Blob Storage container.

", - "DescribeLocationHdfsResponse$AgentArns": "

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

", - "DescribeLocationObjectStorageResponse$AgentArns": "

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

", - "DescribeLocationS3Response$AgentArns": "

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.

", - "DescribeLocationSmbResponse$AgentArns": "

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

", + "DescribeLocationHdfsResponse$AgentArns": "

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

", + "DescribeLocationObjectStorageResponse$AgentArns": "

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

", + "DescribeLocationS3Response$AgentArns": "

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.

", + "DescribeLocationSmbResponse$AgentArns": "

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

", "OnPremConfig$AgentArns": "

The Amazon Resource Names (ARNs) of the agents connecting to a transfer location.

", "UpdateLocationAzureBlobRequest$AgentArns": "

Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

You can specify more than one agent. For more information, see Using multiple agents for your transfer.

", "UpdateLocationHdfsRequest$AgentArns": "

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

", @@ -135,13 +135,13 @@ "AgentVersion": { "base": null, "refs": { - "Platform$Version": "

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.

" + "Platform$Version": "

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.

" } }, "Atime": { "base": null, "refs": { - "Options$Atime": "

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.

" + "Options$Atime": "

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.

" } }, "AzureAccessTier": { @@ -724,7 +724,7 @@ "DescribeLocationFsxLustreResponse$SecurityGroupArns": "

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

", "DescribeLocationFsxOntapResponse$SecurityGroupArns": "

The security groups that DataSync uses to access your FSx for ONTAP file system.

", "DescribeLocationFsxOpenZfsResponse$SecurityGroupArns": "

The ARNs of the security groups that are configured for the FSx for OpenZFS file system.

", - "DescribeLocationFsxWindowsResponse$SecurityGroupArns": "

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

", + "DescribeLocationFsxWindowsResponse$SecurityGroupArns": "

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

", "Ec2Config$SecurityGroupArns": "

Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.

" } }, @@ -904,7 +904,7 @@ "Gid": { "base": null, "refs": { - "Options$Gid": "

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.

" + "Options$Gid": "

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

For more information, see Metadata copied by DataSync.

" } }, "HdfsAuthenticationType": { @@ -939,7 +939,7 @@ "base": null, "refs": { "CreateLocationHdfsRequest$NameNodes": "

The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.

", - "DescribeLocationHdfsResponse$NameNodes": "

The NameNode that manage the HDFS namespace.

", + "DescribeLocationHdfsResponse$NameNodes": "

The NameNode that manages the HDFS namespace.

", "UpdateLocationHdfsRequest$NameNodes": "

The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.

" } }, @@ -980,7 +980,7 @@ "base": null, "refs": { "CreateLocationHdfsRequest$SimpleUser": "

The user name used to identify the client on the host operating system.

If SIMPLE is specified for AuthenticationType, this parameter is required.

", - "DescribeLocationHdfsResponse$SimpleUser": "

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

", + "DescribeLocationHdfsResponse$SimpleUser": "

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

", "UpdateLocationHdfsRequest$SimpleUser": "

The user name used to identify the client on the host operating system.

" } }, @@ -995,8 +995,9 @@ "refs": { "CreateLocationEfsRequest$FileSystemAccessRoleArn": "

Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

", "DescribeLocationEfsResponse$FileSystemAccessRoleArn": "

The Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

", - "ReportDestinationS3$BucketAccessRoleArn": "

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.

", - "S3Config$BucketAccessRoleArn": "

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

" + "ReportDestinationS3$BucketAccessRoleArn": "

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.

", + "S3Config$BucketAccessRoleArn": "

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

", + "S3ManifestConfig$BucketAccessRoleArn": "

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.

" } }, "InputTagList": { @@ -1013,7 +1014,7 @@ "CreateLocationHdfsRequest$Tags": "

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.

", "CreateLocationNfsRequest$Tags": "

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

", "CreateLocationObjectStorageRequest$Tags": "

Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.

", - "CreateLocationS3Request$Tags": "

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.

", + "CreateLocationS3Request$Tags": "

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.

", "CreateLocationSmbRequest$Tags": "

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

", "CreateTaskRequest$Tags": "

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

", "StartDiscoveryJobRequest$Tags": "

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.

", @@ -1149,7 +1150,7 @@ "CreateLocationHdfsResponse$LocationArn": "

The ARN of the source HDFS cluster location that's created.

", "CreateLocationNfsResponse$LocationArn": "

The ARN of the transfer location that you created for your NFS file server.

", "CreateLocationObjectStorageResponse$LocationArn": "

Specifies the ARN of the object storage system location that you create.

", - "CreateLocationS3Response$LocationArn": "

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

", + "CreateLocationS3Response$LocationArn": "

The ARN of the S3 location that you created.

", "CreateLocationSmbResponse$LocationArn": "

The ARN of the SMB location that you created.

", "CreateTaskRequest$SourceLocationArn": "

The Amazon Resource Name (ARN) of the source location for the task.

", "CreateTaskRequest$DestinationLocationArn": "

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

", @@ -1164,18 +1165,18 @@ "DescribeLocationFsxOntapResponse$LocationArn": "

The ARN of the FSx for ONTAP file system location.

", "DescribeLocationFsxOpenZfsRequest$LocationArn": "

The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.

", "DescribeLocationFsxOpenZfsResponse$LocationArn": "

The ARN of the FSx for OpenZFS location that was described.

", - "DescribeLocationFsxWindowsRequest$LocationArn": "

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

", - "DescribeLocationFsxWindowsResponse$LocationArn": "

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

", - "DescribeLocationHdfsRequest$LocationArn": "

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

", - "DescribeLocationHdfsResponse$LocationArn": "

The ARN of the HDFS cluster location.

", + "DescribeLocationFsxWindowsRequest$LocationArn": "

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

", + "DescribeLocationFsxWindowsResponse$LocationArn": "

The ARN of the FSx for Windows File Server location.

", + "DescribeLocationHdfsRequest$LocationArn": "

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

", + "DescribeLocationHdfsResponse$LocationArn": "

The ARN of the HDFS location.

", "DescribeLocationNfsRequest$LocationArn": "

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

", "DescribeLocationNfsResponse$LocationArn": "

The ARN of the NFS location.

", - "DescribeLocationObjectStorageRequest$LocationArn": "

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

", + "DescribeLocationObjectStorageRequest$LocationArn": "

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

", "DescribeLocationObjectStorageResponse$LocationArn": "

The ARN of the object storage system location.

", - "DescribeLocationS3Request$LocationArn": "

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

", - "DescribeLocationS3Response$LocationArn": "

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

", - "DescribeLocationSmbRequest$LocationArn": "

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

", - "DescribeLocationSmbResponse$LocationArn": "

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

", + "DescribeLocationS3Request$LocationArn": "

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

", + "DescribeLocationS3Response$LocationArn": "

The ARN of the Amazon S3 location.

", + "DescribeLocationSmbRequest$LocationArn": "

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

", + "DescribeLocationSmbResponse$LocationArn": "

The ARN of the SMB location.

", "DescribeTaskResponse$SourceLocationArn": "

The Amazon Resource Name (ARN) of the source file system's location.

", "DescribeTaskResponse$DestinationLocationArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.

", "LocationListEntry$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 prefix path that you want to mount and use as the root of the location.

", @@ -1224,12 +1225,12 @@ "DescribeLocationFsxLustreResponse$LocationUri": "

The URI of the FSx for Lustre location that was described.

", "DescribeLocationFsxOntapResponse$LocationUri": "

The uniform resource identifier (URI) of the FSx for ONTAP file system location.

", "DescribeLocationFsxOpenZfsResponse$LocationUri": "

The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.

Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder

", - "DescribeLocationFsxWindowsResponse$LocationUri": "

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

", - "DescribeLocationHdfsResponse$LocationUri": "

The URI of the HDFS cluster location.

", - "DescribeLocationNfsResponse$LocationUri": "

The URL of the NFS location.

", - "DescribeLocationObjectStorageResponse$LocationUri": "

The URL of the object storage system location.

", + "DescribeLocationFsxWindowsResponse$LocationUri": "

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

", + "DescribeLocationHdfsResponse$LocationUri": "

The URI of the HDFS location.

", + "DescribeLocationNfsResponse$LocationUri": "

The URI of the NFS location.

", + "DescribeLocationObjectStorageResponse$LocationUri": "

The URI of the object storage system location.

", "DescribeLocationS3Response$LocationUri": "

The URL of the Amazon S3 location that was described.

", - "DescribeLocationSmbResponse$LocationUri": "

The URL of the source SMB location that was described.

", + "DescribeLocationSmbResponse$LocationUri": "

The URI of the SMB location.

", "LocationListEntry$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 identifier 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 file 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 prefix path that you mount to and treat as the root of the location.

" } }, @@ -1247,7 +1248,29 @@ "LogLevel": { "base": null, "refs": { - "Options$LogLevel": "

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.

" + "Options$LogLevel": "

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

" + } + }, + "ManifestAction": { + "base": null, + "refs": { + "ManifestConfig$Action": "

Specifies what DataSync uses the manifest for.

" + } + }, + "ManifestConfig": { + "base": "

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.

", + "refs": { + "CreateTaskRequest$ManifestConfig": "

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.

", + "DescribeTaskExecutionResponse$ManifestConfig": "

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.

", + "DescribeTaskResponse$ManifestConfig": "

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.

", + "StartTaskExecutionRequest$ManifestConfig": "

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.

", + "UpdateTaskRequest$ManifestConfig": "

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.

" + } + }, + "ManifestFormat": { + "base": null, + "refs": { + "ManifestConfig$Format": "

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

" } }, "MaxP95Performance": { @@ -1264,7 +1287,7 @@ "ListAgentsRequest$MaxResults": "

Specifies the maximum number of DataSync agents to list in a response. By default, a response shows a maximum of 100 agents.

", "ListLocationsRequest$MaxResults": "

The maximum number of locations to return.

", "ListTagsForResourceRequest$MaxResults": "

Specifies how many results that you want in the response.

", - "ListTaskExecutionsRequest$MaxResults": "

The maximum number of executed tasks to list.

", + "ListTaskExecutionsRequest$MaxResults": "

Specifies how many results you want in the response.

", "ListTasksRequest$MaxResults": "

The maximum number of tasks to return.

" } }, @@ -1277,7 +1300,7 @@ "Mtime": { "base": null, "refs": { - "Options$Mtime": "

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.

" + "Options$Mtime": "

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.

" } }, "Name": { @@ -1341,8 +1364,8 @@ "ListLocationsResponse$NextToken": "

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

", "ListTagsForResourceRequest$NextToken": "

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

", "ListTagsForResourceResponse$NextToken": "

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

", - "ListTaskExecutionsRequest$NextToken": "

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

", - "ListTaskExecutionsResponse$NextToken": "

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

", + "ListTaskExecutionsRequest$NextToken": "

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

", + "ListTaskExecutionsResponse$NextToken": "

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

", "ListTasksRequest$NextToken": "

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

", "ListTasksResponse$NextToken": "

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

" } @@ -1473,7 +1496,7 @@ "ObjectTags": { "base": null, "refs": { - "Options$ObjectTags": "

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

" + "Options$ObjectTags": "

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.

" } }, "ObjectVersionIds": { @@ -1517,7 +1540,7 @@ "OverwriteMode": { "base": null, "refs": { - "Options$OverwriteMode": "

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.

" + "Options$OverwriteMode": "

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

" } }, "P95Metrics": { @@ -1559,19 +1582,19 @@ "PosixPermissions": { "base": null, "refs": { - "Options$PosixPermissions": "

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.

" + "Options$PosixPermissions": "

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.

" } }, "PreserveDeletedFiles": { "base": null, "refs": { - "Options$PreserveDeletedFiles": "

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.

" + "Options$PreserveDeletedFiles": "

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": { "base": null, "refs": { - "Options$PreserveDevices": "

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.

" + "Options$PreserveDevices": "

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.

" } }, "PrivateLinkConfig": { @@ -1630,7 +1653,7 @@ "base": "

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

", "refs": { "CreateLocationHdfsRequest$QopConfiguration": "

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. If QopConfiguration isn't specified, RpcProtection and DataTransferProtection default to PRIVACY. If you set RpcProtection or DataTransferProtection, the other parameter assumes the same value.

", - "DescribeLocationHdfsResponse$QopConfiguration": "

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.

", + "DescribeLocationHdfsResponse$QopConfiguration": "

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

", "UpdateLocationHdfsRequest$QopConfiguration": "

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

" } }, @@ -1754,30 +1777,44 @@ "S3BucketArn": { "base": null, "refs": { - "CreateLocationS3Request$S3BucketArn": "

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

", - "ReportDestinationS3$S3BucketArn": "

Specifies the ARN of the S3 bucket where DataSync uploads your report.

" + "CreateLocationS3Request$S3BucketArn": "

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.

", + "ReportDestinationS3$S3BucketArn": "

Specifies the ARN of the S3 bucket where DataSync uploads your report.

", + "S3ManifestConfig$S3BucketArn": "

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

" } }, "S3Config": { - "base": "

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.

", + "base": "

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.

", "refs": { "CreateLocationS3Request$S3Config": null, "DescribeLocationS3Response$S3Config": null } }, + "S3ManifestConfig": { + "base": "

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.

", + "refs": { + "SourceManifestConfig$S3": "

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

" + } + }, + "S3ObjectVersionId": { + "base": null, + "refs": { + "S3ManifestConfig$ManifestObjectVersionId": "

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.

" + } + }, "S3StorageClass": { "base": null, "refs": { - "CreateLocationS3Request$S3StorageClass": "

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.

", - "DescribeLocationS3Response$S3StorageClass": "

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.

" + "CreateLocationS3Request$S3StorageClass": "

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.

", + "DescribeLocationS3Response$S3StorageClass": "

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.

" } }, "S3Subdirectory": { "base": null, "refs": { "CreateLocationObjectStorageRequest$Subdirectory": "

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

", - "CreateLocationS3Request$Subdirectory": "

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.

", + "CreateLocationS3Request$Subdirectory": "

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:

", "ReportDestinationS3$Subdirectory": "

Specifies a bucket prefix for your report.

", + "S3ManifestConfig$ManifestObjectPath": "

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

", "UpdateLocationObjectStorageRequest$Subdirectory": "

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

" } }, @@ -1804,11 +1841,11 @@ "SmbDomain": { "base": null, "refs": { - "CreateLocationFsxWindowsRequest$Domain": "

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.

", - "CreateLocationSmbRequest$Domain": "

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.

", - "DescribeLocationFsxWindowsResponse$Domain": "

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

", - "DescribeLocationSmbResponse$Domain": "

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

", - "FsxProtocolSmb$Domain": "

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

", + "CreateLocationFsxWindowsRequest$Domain": "

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.

", + "CreateLocationSmbRequest$Domain": "

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.

", + "DescribeLocationFsxWindowsResponse$Domain": "

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

", + "DescribeLocationSmbResponse$Domain": "

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

", + "FsxProtocolSmb$Domain": "

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.

", "UpdateLocationSmbRequest$Domain": "

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.

" } }, @@ -1816,7 +1853,7 @@ "base": "

Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

", "refs": { "CreateLocationSmbRequest$MountOptions": "

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

", - "DescribeLocationSmbResponse$MountOptions": "

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

", + "DescribeLocationSmbResponse$MountOptions": "

The protocol that DataSync use to access your SMB file.

", "FsxProtocolSmb$MountOptions": null, "UpdateLocationSmbRequest$MountOptions": null } @@ -1824,7 +1861,7 @@ "SmbPassword": { "base": null, "refs": { - "CreateLocationFsxWindowsRequest$Password": "

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.

", + "CreateLocationFsxWindowsRequest$Password": "

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.

", "CreateLocationSmbRequest$Password": "

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

For more information, see required permissions for SMB locations.

", "FsxProtocolSmb$Password": "

Specifies the password of a user who has permission to access your SVM.

", "UpdateLocationSmbRequest$Password": "

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

For more information, see required permissions for SMB locations.

" @@ -1833,24 +1870,24 @@ "SmbSecurityDescriptorCopyFlags": { "base": null, "refs": { - "Options$SecurityDescriptorCopyFlags": "

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.

" + "Options$SecurityDescriptorCopyFlags": "

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.

" } }, "SmbSubdirectory": { "base": null, "refs": { - "CreateLocationSmbRequest$Subdirectory": "

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.

", + "CreateLocationSmbRequest$Subdirectory": "

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.

", "UpdateLocationSmbRequest$Subdirectory": "

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.

" } }, "SmbUser": { "base": null, "refs": { - "CreateLocationFsxWindowsRequest$User": "

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.

", - "CreateLocationSmbRequest$User": "

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.

", - "DescribeLocationFsxWindowsResponse$User": "

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

", - "DescribeLocationSmbResponse$User": "

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

", - "FsxProtocolSmb$User": "

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:

", + "CreateLocationFsxWindowsRequest$User": "

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.

", + "CreateLocationSmbRequest$User": "

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.

", + "DescribeLocationFsxWindowsResponse$User": "

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

", + "DescribeLocationSmbResponse$User": "

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

", + "FsxProtocolSmb$User": "

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.

", "UpdateLocationSmbRequest$User": "

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.

" } }, @@ -1860,6 +1897,12 @@ "SmbMountOptions$Version": "

By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

These are the following options for configuring the SMB version:

" } }, + "SourceManifestConfig": { + "base": "

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.

", + "refs": { + "ManifestConfig$Source": "

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.

" + } + }, "SourceNetworkInterfaceArns": { "base": null, "refs": { @@ -1994,7 +2037,7 @@ "DeleteTaskRequest$TaskArn": "

Specifies the Amazon Resource Name (ARN) of the task that you want to delete.

", "DescribeTaskRequest$TaskArn": "

Specifies the Amazon Resource Name (ARN) of the transfer task.

", "DescribeTaskResponse$TaskArn": "

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

", - "ListTaskExecutionsRequest$TaskArn": "

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

", + "ListTaskExecutionsRequest$TaskArn": "

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

", "StartTaskExecutionRequest$TaskArn": "

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

", "TaskListEntry$TaskArn": "

The Amazon Resource Name (ARN) of the task.

", "UpdateTaskRequest$TaskArn": "

The Amazon Resource Name (ARN) of the resource name of the task to update.

" @@ -2008,18 +2051,18 @@ "DescribeTaskExecutionResponse$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.

", "DescribeTaskResponse$CurrentTaskExecutionArn": "

The Amazon Resource Name (ARN) of the task execution that is transferring files.

", "StartTaskExecutionResponse$TaskExecutionArn": "

The ARN of the running task execution.

", - "TaskExecutionListEntry$TaskExecutionArn": "

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

", + "TaskExecutionListEntry$TaskExecutionArn": "

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

", "UpdateTaskExecutionRequest$TaskExecutionArn": "

Specifies the Amazon Resource Name (ARN) of the task execution that you're updating.

" } }, "TaskExecutionList": { "base": null, "refs": { - "ListTaskExecutionsResponse$TaskExecutions": "

A list of executed tasks.

" + "ListTaskExecutionsResponse$TaskExecutions": "

A list of the task's executions.

" } }, "TaskExecutionListEntry": { - "base": "

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.

", + "base": "

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

", "refs": { "TaskExecutionList$member": null } @@ -2034,7 +2077,7 @@ "base": null, "refs": { "DescribeTaskExecutionResponse$Status": "

The status of the task execution.

", - "TaskExecutionListEntry$Status": "

The status of a task execution.

" + "TaskExecutionListEntry$Status": "

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

" } }, "TaskFilter": { @@ -2076,11 +2119,11 @@ "TaskReportConfig": { "base": "

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

For more information, see Task reports.

", "refs": { - "CreateTaskRequest$TaskReportConfig": "

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

", - "DescribeTaskExecutionResponse$TaskReportConfig": "

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

", - "DescribeTaskResponse$TaskReportConfig": "

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

", - "StartTaskExecutionRequest$TaskReportConfig": "

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

", - "UpdateTaskRequest$TaskReportConfig": "

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

" + "CreateTaskRequest$TaskReportConfig": "

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.

", + "DescribeTaskExecutionResponse$TaskReportConfig": "

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

", + "DescribeTaskResponse$TaskReportConfig": "

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

", + "StartTaskExecutionRequest$TaskReportConfig": "

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.

", + "UpdateTaskRequest$TaskReportConfig": "

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.

" } }, "TaskSchedule": { @@ -2118,7 +2161,7 @@ "DescribeLocationHdfsResponse$CreationTime": "

The time that the HDFS location was created.

", "DescribeLocationNfsResponse$CreationTime": "

The time when the NFS location was created.

", "DescribeLocationObjectStorageResponse$CreationTime": "

The time that the location was created.

", - "DescribeLocationS3Response$CreationTime": "

The time that the Amazon S3 bucket location was created.

", + "DescribeLocationS3Response$CreationTime": "

The time that the Amazon S3 location was created.

", "DescribeLocationSmbResponse$CreationTime": "

The time that the SMB location was created.

", "DescribeTaskExecutionResponse$StartTime": "

The time when the task execution started.

", "DescribeTaskResponse$CreationTime": "

The time that the task was created.

" @@ -2134,13 +2177,13 @@ "TransferMode": { "base": null, "refs": { - "Options$TransferMode": "

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

" + "Options$TransferMode": "

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

" } }, "Uid": { "base": null, "refs": { - "Options$Uid": "

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.

" + "Options$Uid": "

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

For more information, see Metadata copied by DataSync.

" } }, "UntagResourceRequest": { @@ -2256,7 +2299,7 @@ "VerifyMode": { "base": null, "refs": { - "Options$VerifyMode": "

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.

" + "Options$VerifyMode": "

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

" } }, "VpcEndpointId": { diff --git a/apis/models.lex.v2/2020-08-07/api-2.json b/apis/models.lex.v2/2020-08-07/api-2.json index 26eef62b894..0b6c234d719 100644 --- a/apis/models.lex.v2/2020-08-07/api-2.json +++ b/apis/models.lex.v2/2020-08-07/api-2.json @@ -136,6 +136,24 @@ {"shape":"InternalServerException"} ] }, + "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"} + ] + }, "CreateBotVersion":{ "name":"CreateBotVersion", "http":{ @@ -352,6 +370,24 @@ {"shape":"InternalServerException"} ] }, + "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"} + ] + }, "DeleteBotVersion":{ "name":"DeleteBotVersion", "http":{ @@ -605,6 +641,23 @@ {"shape":"InternalServerException"} ] }, + "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"} + ] + }, "DescribeBotResourceGeneration":{ "name":"DescribeBotResourceGeneration", "http":{ @@ -874,6 +927,22 @@ {"shape":"InternalServerException"} ] }, + "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"} + ] + }, "ListBotAliases":{ "name":"ListBotAliases", "http":{ @@ -922,6 +991,22 @@ {"shape":"ResourceNotFoundException"} ] }, + "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"} + ] + }, "ListBotResourceGenerations":{ "name":"ListBotResourceGenerations", "http":{ @@ -938,6 +1023,22 @@ {"shape":"ResourceNotFoundException"} ] }, + "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"} + ] + }, "ListBotVersions":{ "name":"ListBotVersions", "http":{ @@ -2713,6 +2814,31 @@ "min":1, "pattern":"^(\\bAmazonLexTestAlias\\b|[0-9a-zA-Z][_-]?)+$" }, + "BotAliasReplicaSummary":{ + "type":"structure", + "members":{ + "botAliasId":{"shape":"BotAliasId"}, + "botAliasReplicationStatus":{"shape":"BotAliasReplicationStatus"}, + "botVersion":{"shape":"BotVersion"}, + "creationDateTime":{"shape":"Timestamp"}, + "lastUpdatedDateTime":{"shape":"Timestamp"}, + "failureReasons":{"shape":"FailureReasons"} + } + }, + "BotAliasReplicaSummaryList":{ + "type":"list", + "member":{"shape":"BotAliasReplicaSummary"} + }, + "BotAliasReplicationStatus":{ + "type":"string", + "enum":[ + "Creating", + "Updating", + "Available", + "Deleting", + "Failed" + ] + }, "BotAliasStatus":{ "type":"string", "enum":[ @@ -2999,6 +3125,28 @@ "type":"list", "member":{"shape":"BotRecommendationSummary"} }, + "BotReplicaStatus":{ + "type":"string", + "enum":[ + "Enabling", + "Enabled", + "Deleting", + "Failed" + ] + }, + "BotReplicaSummary":{ + "type":"structure", + "members":{ + "replicaRegion":{"shape":"ReplicaRegion"}, + "creationDateTime":{"shape":"Timestamp"}, + "botReplicaStatus":{"shape":"BotReplicaStatus"}, + "failureReasons":{"shape":"FailureReasons"} + } + }, + "BotReplicaSummaryList":{ + "type":"list", + "member":{"shape":"BotReplicaSummary"} + }, "BotSortAttribute":{ "type":"string", "enum":["BotName"] @@ -3069,6 +3217,43 @@ "value":{"shape":"BotVersionLocaleDetails"}, "min":1 }, + "BotVersionReplicaSortAttribute":{ + "type":"string", + "enum":["BotVersion"] + }, + "BotVersionReplicaSortBy":{ + "type":"structure", + "required":[ + "attribute", + "order" + ], + "members":{ + "attribute":{"shape":"BotVersionReplicaSortAttribute"}, + "order":{"shape":"SortOrder"} + } + }, + "BotVersionReplicaSummary":{ + "type":"structure", + "members":{ + "botVersion":{"shape":"BotVersion"}, + "botVersionReplicationStatus":{"shape":"BotVersionReplicationStatus"}, + "creationDateTime":{"shape":"Timestamp"}, + "failureReasons":{"shape":"FailureReasons"} + } + }, + "BotVersionReplicaSummaryList":{ + "type":"list", + "member":{"shape":"BotVersionReplicaSummary"} + }, + "BotVersionReplicationStatus":{ + "type":"string", + "enum":[ + "Creating", + "Available", + "Deleting", + "Failed" + ] + }, "BotVersionSortAttribute":{ "type":"string", "enum":["BotVersion"] @@ -3569,6 +3754,31 @@ "generativeAISettings":{"shape":"GenerativeAISettings"} } }, + "CreateBotReplicaRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{"shape":"ReplicaRegion"} + } + }, + "CreateBotReplicaResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "replicaRegion":{"shape":"ReplicaRegion"}, + "sourceRegion":{"shape":"ReplicaRegion"}, + "creationDateTime":{"shape":"Timestamp"}, + "botReplicaStatus":{"shape":"BotReplicaStatus"} + } + }, "CreateBotRequest":{ "type":"structure", "required":[ @@ -4103,6 +4313,33 @@ "botLocaleStatus":{"shape":"BotLocaleStatus"} } }, + "DeleteBotReplicaRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "location":"uri", + "locationName":"replicaRegion" + } + } + }, + "DeleteBotReplicaResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "replicaRegion":{"shape":"ReplicaRegion"}, + "botReplicaStatus":{"shape":"BotReplicaStatus"} + } + }, "DeleteBotRequest":{ "type":"structure", "required":["botId"], @@ -4560,6 +4797,36 @@ "botRecommendationResults":{"shape":"BotRecommendationResults"} } }, + "DescribeBotReplicaRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "location":"uri", + "locationName":"replicaRegion" + } + } + }, + "DescribeBotReplicaResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "replicaRegion":{"shape":"ReplicaRegion"}, + "sourceRegion":{"shape":"ReplicaRegion"}, + "creationDateTime":{"shape":"Timestamp"}, + "botReplicaStatus":{"shape":"BotReplicaStatus"}, + "failureReasons":{"shape":"FailureReasons"} + } + }, "DescribeBotRequest":{ "type":"structure", "required":["botId"], @@ -5898,6 +6165,37 @@ "nextToken":{"shape":"NextToken"} } }, + "ListBotAliasReplicasRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "location":"uri", + "locationName":"replicaRegion" + }, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListBotAliasReplicasResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "sourceRegion":{"shape":"ReplicaRegion"}, + "replicaRegion":{"shape":"ReplicaRegion"}, + "botAliasReplicaSummaries":{"shape":"BotAliasReplicaSummaryList"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListBotAliasesRequest":{ "type":"structure", "required":["botId"], @@ -5988,6 +6286,25 @@ "nextToken":{"shape":"NextToken"} } }, + "ListBotReplicasRequest":{ + "type":"structure", + "required":["botId"], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + } + } + }, + "ListBotReplicasResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "sourceRegion":{"shape":"ReplicaRegion"}, + "botReplicaSummaries":{"shape":"BotReplicaSummaryList"} + } + }, "ListBotResourceGenerationsRequest":{ "type":"structure", "required":[ @@ -6026,6 +6343,38 @@ "nextToken":{"shape":"NextToken"} } }, + "ListBotVersionReplicasRequest":{ + "type":"structure", + "required":[ + "botId", + "replicaRegion" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "replicaRegion":{ + "shape":"ReplicaRegion", + "location":"uri", + "locationName":"replicaRegion" + }, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"}, + "sortBy":{"shape":"BotVersionReplicaSortBy"} + } + }, + "ListBotVersionReplicasResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "sourceRegion":{"shape":"ReplicaRegion"}, + "replicaRegion":{"shape":"ReplicaRegion"}, + "botVersionReplicaSummaries":{"shape":"BotVersionReplicaSummaryList"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListBotVersionsRequest":{ "type":"structure", "required":["botId"], @@ -7035,6 +7384,11 @@ "timeValue":{"shape":"TimeValue"} } }, + "ReplicaRegion":{ + "type":"string", + "max":25, + "min":2 + }, "ResourceCount":{"type":"integer"}, "ResourceNotFoundException":{ "type":"structure", diff --git a/apis/models.lex.v2/2020-08-07/docs-2.json b/apis/models.lex.v2/2020-08-07/docs-2.json index 94feee5baa3..09386fc7e29 100644 --- a/apis/models.lex.v2/2020-08-07/docs-2.json +++ b/apis/models.lex.v2/2020-08-07/docs-2.json @@ -9,6 +9,7 @@ "CreateBot": "

Creates an Amazon Lex conversational bot.

", "CreateBotAlias": "

Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.

For example, you can create an alias called \"PROD\" that your applications use to call the Amazon Lex bot.

", "CreateBotLocale": "

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": "

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

", "CreateBotVersion": "

Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.

", "CreateExport": "

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.

You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.

For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots

", "CreateIntent": "

Creates an intent.

To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.

When you create an intent, you must provide a name. You can optionally provide the following:

", @@ -21,6 +22,7 @@ "DeleteBot": "

Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation.

When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.

If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true.

", "DeleteBotAlias": "

Deletes the specified bot alias.

", "DeleteBotLocale": "

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": "

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

", "DeleteBotVersion": "

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

", "DeleteCustomVocabulary": "

Removes a custom vocabulary from the specified locale in the specified bot.

", "DeleteExport": "

Removes a previous export and the associated files stored in an S3 bucket.

", @@ -36,6 +38,7 @@ "DescribeBotAlias": "

Get information about a specific bot alias.

", "DescribeBotLocale": "

Describes the settings that a bot has for a specific locale.

", "DescribeBotRecommendation": "

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": "

Monitors the bot replication status through the UI console.

", "DescribeBotResourceGeneration": "

Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

", "DescribeBotVersion": "

Provides metadata about a version of a bot.

", "DescribeCustomVocabularyMetadata": "

Provides metadata information about a custom vocabulary.

", @@ -52,10 +55,13 @@ "GenerateBotElement": "

Generates sample utterances for an intent.

", "GetTestExecutionArtifactsUrl": "

The pre-signed Amazon S3 URL to download the test execution result artifacts.

", "ListAggregatedUtterances": "

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": "

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

", "ListBotAliases": "

Gets a list of aliases for the specified bot.

", "ListBotLocales": "

Gets a list of locales for the specified bot.

", "ListBotRecommendations": "

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

", + "ListBotReplicas": "

The action to list the replicated bots.

", "ListBotResourceGenerations": "

Lists the generation requests made for a bot locale.

", + "ListBotVersionReplicas": "

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

", "ListBotVersions": "

Gets information about all of the versions of a bot.

The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

The ListBotVersions operation always returns at least one version, the DRAFT version.

", "ListBots": "

Gets a list of available bots.

", "ListBuiltInIntents": "

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.

", @@ -994,6 +1000,7 @@ "BotAliasId": { "base": null, "refs": { + "BotAliasReplicaSummary$botAliasId": "

The bot alias ID for all the alias bot replications.

", "BotAliasSummary$botAliasId": "

The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the DescribeBotAlias operation.

", "BotAliasTestExecutionTarget$botAliasId": "

The bot alias Id of the bot alias used in the test set execution.

", "BotMember$botMemberAliasId": "

The alias ID of a bot that is a member of this network of bots.

", @@ -1034,6 +1041,24 @@ "BotMember$botMemberAliasName": "

The alias name of a bot that is a member of this network of bots.

" } }, + "BotAliasReplicaSummary": { + "base": "

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

", + "refs": { + "BotAliasReplicaSummaryList$member": null + } + }, + "BotAliasReplicaSummaryList": { + "base": null, + "refs": { + "ListBotAliasReplicasResponse$botAliasReplicaSummaries": "

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

" + } + }, + "BotAliasReplicationStatus": { + "base": "

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

", + "refs": { + "BotAliasReplicaSummary$botAliasReplicationStatus": "

The replication statuses for all the alias bot replications.

" + } + }, "BotAliasStatus": { "base": null, "refs": { @@ -1238,6 +1263,27 @@ "ListBotRecommendationsResponse$botRecommendationSummaries": "

Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.

" } }, + "BotReplicaStatus": { + "base": "

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

", + "refs": { + "BotReplicaSummary$botReplicaStatus": "

The operation status for the replicated bot applicable.

", + "CreateBotReplicaResponse$botReplicaStatus": "

The operational status of the replicated bot generated.

", + "DeleteBotReplicaResponse$botReplicaStatus": "

The operational status of the replicated bot generated.

", + "DescribeBotReplicaResponse$botReplicaStatus": "

The operational status of the replicated bot being monitored.

" + } + }, + "BotReplicaSummary": { + "base": "

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

", + "refs": { + "BotReplicaSummaryList$member": null + } + }, + "BotReplicaSummaryList": { + "base": null, + "refs": { + "ListBotReplicasResponse$botReplicaSummaries": "

The summary details for the replicated bots.

" + } + }, "BotSortAttribute": { "base": null, "refs": { @@ -1298,11 +1344,13 @@ "BatchUpdateCustomVocabularyItemRequest$botVersion": "

The identifier of the version of the bot associated with this custom vocabulary.

", "BatchUpdateCustomVocabularyItemResponse$botVersion": "

The identifier of the version of the bot associated with this custom vocabulary.

", "BotAliasHistoryEvent$botVersion": "

The version of the bot that was used in the event.

", + "BotAliasReplicaSummary$botVersion": "

The bot version for all the alias bot replications.

", "BotAliasSummary$botVersion": "

The version of the bot that the bot alias references.

", "BotExportSpecification$botVersion": "

The version of the bot that was exported. This will be either DRAFT or the version number.

", "BotLocaleExportSpecification$botVersion": "

The version of the bot to export.

", "BotMember$botMemberVersion": "

The version of a bot that is a member of this network of bots.

", "BotVersionLocaleDetails$sourceBotVersion": "

The version of a bot used for a bot locale.

", + "BotVersionReplicaSummary$botVersion": "

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

", "BotVersionSummary$botVersion": "

The numeric version of the bot, or DRAFT to indicate that this is the version of the bot that can be updated..

", "CustomVocabularyExportSpecification$botVersion": "

The version of the bot that contains the custom vocabulary to export.

", "DescribeBotAliasResponse$botVersion": "

The version of the bot associated with the bot alias.

", @@ -1356,6 +1404,36 @@ "CreateBotVersionResponse$botVersionLocaleSpecification": "

The source versions used for each locale in the new version.

" } }, + "BotVersionReplicaSortAttribute": { + "base": null, + "refs": { + "BotVersionReplicaSortBy$attribute": "

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

" + } + }, + "BotVersionReplicaSortBy": { + "base": "

The sort category for the version replicated bots.

", + "refs": { + "ListBotVersionReplicasRequest$sortBy": "

The requested sort category for the list of replicated bots.

" + } + }, + "BotVersionReplicaSummary": { + "base": "

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

", + "refs": { + "BotVersionReplicaSummaryList$member": null + } + }, + "BotVersionReplicaSummaryList": { + "base": null, + "refs": { + "ListBotVersionReplicasResponse$botVersionReplicaSummaries": "

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

" + } + }, + "BotVersionReplicationStatus": { + "base": "

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

", + "refs": { + "BotVersionReplicaSummary$botVersionReplicationStatus": "

The version replication status for all the replicated bots.

" + } + }, "BotVersionSortAttribute": { "base": null, "refs": { @@ -1776,6 +1854,16 @@ "refs": { } }, + "CreateBotReplicaRequest": { + "base": null, + "refs": { + } + }, + "CreateBotReplicaResponse": { + "base": null, + "refs": { + } + }, "CreateBotRequest": { "base": null, "refs": { @@ -1992,6 +2080,16 @@ "refs": { } }, + "DeleteBotReplicaRequest": { + "base": null, + "refs": { + } + }, + "DeleteBotReplicaResponse": { + "base": null, + "refs": { + } + }, "DeleteBotRequest": { "base": null, "refs": { @@ -2128,6 +2226,16 @@ "refs": { } }, + "DescribeBotReplicaRequest": { + "base": null, + "refs": { + } + }, + "DescribeBotReplicaResponse": { + "base": null, + "refs": { + } + }, "DescribeBotRequest": { "base": null, "refs": { @@ -2588,8 +2696,12 @@ "FailureReasons": { "base": null, "refs": { + "BotAliasReplicaSummary$failureReasons": "

The reasons for failure for the aliases bot replications.

", + "BotReplicaSummary$failureReasons": "

The reasons for the failure for the replicated bot.

", + "BotVersionReplicaSummary$failureReasons": "

The reasons for replication failure for all the replicated bots.

", "DescribeBotLocaleResponse$failureReasons": "

if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

", "DescribeBotRecommendationResponse$failureReasons": "

If botRecommendationStatus is Failed, Amazon Lex explains why.

", + "DescribeBotReplicaResponse$failureReasons": "

The failure reasons the bot being monitored failed to replicate.

", "DescribeBotResourceGenerationResponse$failureReasons": "

A list of reasons why the generation of bot resources through natural language description failed.

", "DescribeBotResponse$failureReasons": "

If the botStatus is Failed, this contains a list of reasons that the bot couldn't be built.

", "DescribeBotVersionResponse$failureReasons": "

If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

", @@ -2785,6 +2897,8 @@ "CreateBotAliasResponse$botId": "

The unique identifier of the bot that this alias applies to.

", "CreateBotLocaleRequest$botId": "

The identifier of the bot to create the locale for.

", "CreateBotLocaleResponse$botId": "

The specified bot identifier.

", + "CreateBotReplicaRequest$botId": "

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

", + "CreateBotReplicaResponse$botId": "

The unique bot ID of the replicated bot generated.

", "CreateBotResponse$botId": "

A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

", "CreateBotVersionRequest$botId": "

The identifier of the bot to create the version for.

", "CreateBotVersionResponse$botId": "

The bot identifier specified in the request.

", @@ -2810,6 +2924,8 @@ "DeleteBotAliasResponse$botId": "

The unique identifier of the bot that contains the alias to delete.

", "DeleteBotLocaleRequest$botId": "

The unique identifier of the bot that contains the locale.

", "DeleteBotLocaleResponse$botId": "

The identifier of the bot that contained the deleted locale.

", + "DeleteBotReplicaRequest$botId": "

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

", + "DeleteBotReplicaResponse$botId": "

The unique bot ID of the replicated bot generated.

", "DeleteBotRequest$botId": "

The identifier of the bot to delete.

", "DeleteBotResponse$botId": "

The unique identifier of the bot that Amazon Lex is deleting.

", "DeleteBotVersionRequest$botId": "

The identifier of the bot that contains the version.

", @@ -2837,6 +2953,8 @@ "DescribeBotRecommendationRequest$botRecommendationId": "

The identifier of the bot recommendation to describe.

", "DescribeBotRecommendationResponse$botId": "

The identifier of the bot associated with the bot recommendation.

", "DescribeBotRecommendationResponse$botRecommendationId": "

The identifier of the bot recommendation being described.

", + "DescribeBotReplicaRequest$botId": "

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

", + "DescribeBotReplicaResponse$botId": "

The unique bot ID of the replicated bot being monitored.

", "DescribeBotRequest$botId": "

The unique identifier of the bot to describe.

", "DescribeBotResourceGenerationRequest$botId": "

The unique identifier of the bot for which to return the generation details.

", "DescribeBotResourceGenerationRequest$generationId": "

The unique identifier of the generation request for which to return the generation details.

", @@ -2888,14 +3006,20 @@ "IntentSummary$intentId": "

The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the DescribeIntent operation.

", "ListAggregatedUtterancesRequest$botId": "

The unique identifier of the bot associated with this request.

", "ListAggregatedUtterancesResponse$botId": "

The identifier of the bot that contains the utterances.

", + "ListBotAliasReplicasRequest$botId": "

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

", + "ListBotAliasReplicasResponse$botId": "

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

", "ListBotAliasesRequest$botId": "

The identifier of the bot to list aliases for.

", "ListBotAliasesResponse$botId": "

The identifier of the bot associated with the aliases.

", "ListBotLocalesRequest$botId": "

The identifier of the bot to list locales for.

", "ListBotLocalesResponse$botId": "

The identifier of the bot to list locales for.

", "ListBotRecommendationsRequest$botId": "

The unique identifier of the bot that contains the bot recommendation list.

", "ListBotRecommendationsResponse$botId": "

The unique identifier of the bot that contains the bot recommendation list.

", + "ListBotReplicasRequest$botId": "

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

", + "ListBotReplicasResponse$botId": "

the unique bot IDs in the list of replicated bots.

", "ListBotResourceGenerationsRequest$botId": "

The unique identifier of the bot whose generation requests you want to view.

", "ListBotResourceGenerationsResponse$botId": "

The unique identifier of the bot for which the generation requests were made.

", + "ListBotVersionReplicasRequest$botId": "

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

", + "ListBotVersionReplicasResponse$botId": "

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

", "ListBotVersionsRequest$botId": "

The identifier of the bot to list versions for.

", "ListBotVersionsResponse$botId": "

The identifier of the bot to list versions for.

", "ListCustomVocabularyItemsRequest$botId": "

The identifier of the version of the bot associated with this custom vocabulary.

", @@ -3347,6 +3471,16 @@ "refs": { } }, + "ListBotAliasReplicasRequest": { + "base": null, + "refs": { + } + }, + "ListBotAliasReplicasResponse": { + "base": null, + "refs": { + } + }, "ListBotAliasesRequest": { "base": null, "refs": { @@ -3377,6 +3511,16 @@ "refs": { } }, + "ListBotReplicasRequest": { + "base": null, + "refs": { + } + }, + "ListBotReplicasResponse": { + "base": null, + "refs": { + } + }, "ListBotResourceGenerationsRequest": { "base": null, "refs": { @@ -3387,6 +3531,16 @@ "refs": { } }, + "ListBotVersionReplicasRequest": { + "base": null, + "refs": { + } + }, + "ListBotVersionReplicasResponse": { + "base": null, + "refs": { + } + }, "ListBotVersionsRequest": { "base": null, "refs": { @@ -3736,10 +3890,12 @@ "base": null, "refs": { "ListAggregatedUtterancesRequest$maxResults": "

The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the maxResults parameter, 1,000 results are returned.

", + "ListBotAliasReplicasRequest$maxResults": "

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

", "ListBotAliasesRequest$maxResults": "

The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListBotLocalesRequest$maxResults": "

The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListBotRecommendationsRequest$maxResults": "

The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListBotResourceGenerationsRequest$maxResults": "

The maximum number of results to return in the response.

", + "ListBotVersionReplicasRequest$maxResults": "

The maximum results given in the list of replicated bots.

", "ListBotVersionsRequest$maxResults": "

The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

", "ListBotsRequest$maxResults": "

The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

", "ListCustomVocabularyItemsRequest$maxResults": "

The maximum number of items returned by the list operation.

", @@ -3928,6 +4084,8 @@ "refs": { "ListAggregatedUtterancesRequest$nextToken": "

If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", "ListAggregatedUtterancesResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListAggregatedUtterances operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListAggregatedUtterances operation request to get the next page of results.

", + "ListBotAliasReplicasRequest$nextToken": "

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

", + "ListBotAliasReplicasResponse$nextToken": "

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

", "ListBotAliasesRequest$nextToken": "

If the response from the ListBotAliases operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", "ListBotAliasesResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListBotAliases operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

", "ListBotLocalesRequest$nextToken": "

If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

", @@ -3936,6 +4094,8 @@ "ListBotRecommendationsResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.

", "ListBotResourceGenerationsRequest$nextToken": "

If the total number of results is greater than the number specified in the maxResults, the response returns a token in the nextToken field. Use this token when making a request to return the next batch of results.

", "ListBotResourceGenerationsResponse$nextToken": "

If the total number of results is greater than the number specified in the maxResults, the response returns a token in the nextToken field. Use this token when making a request to return the next batch of results.

", + "ListBotVersionReplicasRequest$nextToken": "

The next token given in the list of replicated bots.

", + "ListBotVersionReplicasResponse$nextToken": "

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

", "ListBotVersionsRequest$nextToken": "

If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

", "ListBotVersionsResponse$nextToken": "

A token that indicates whether there are more results to return in a response to the ListBotVersions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

", "ListBotsRequest$nextToken": "

If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListBots request to return the next page of results. For a complete set of results, call the ListBots operation until the nextToken returned in the response is null.

", @@ -4264,6 +4424,27 @@ "UtteranceAggregationDuration$relativeAggregationDuration": "

The desired time window for aggregating utterances.

" } }, + "ReplicaRegion": { + "base": "

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

", + "refs": { + "BotReplicaSummary$replicaRegion": "

The replica region used in the replication statuses summary.

", + "CreateBotReplicaRequest$replicaRegion": "

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

", + "CreateBotReplicaResponse$replicaRegion": "

The region of the replicated bot generated.

", + "CreateBotReplicaResponse$sourceRegion": "

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

", + "DeleteBotReplicaRequest$replicaRegion": "

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

", + "DeleteBotReplicaResponse$replicaRegion": "

The region of the replicated bot generated.

", + "DescribeBotReplicaRequest$replicaRegion": "

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

", + "DescribeBotReplicaResponse$replicaRegion": "

The region of the replicated bot being monitored.

", + "DescribeBotReplicaResponse$sourceRegion": "

The source region of the replicated bot being monitored.

", + "ListBotAliasReplicasRequest$replicaRegion": "

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

", + "ListBotAliasReplicasResponse$sourceRegion": "

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

", + "ListBotAliasReplicasResponse$replicaRegion": "

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

", + "ListBotReplicasResponse$sourceRegion": "

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

", + "ListBotVersionReplicasRequest$replicaRegion": "

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

", + "ListBotVersionReplicasResponse$sourceRegion": "

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

", + "ListBotVersionReplicasResponse$replicaRegion": "

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

" + } + }, "ResourceCount": { "base": null, "refs": { @@ -4847,6 +5028,7 @@ "AggregatedUtterancesSortBy$order": "

Specifies whether to sort the aggregated utterances in ascending or descending order.

", "BotLocaleSortBy$order": "

Specifies whether to sort the bot locales in ascending or descending order.

", "BotSortBy$order": "

The order to sort the list. You can choose ascending or descending.

", + "BotVersionReplicaSortBy$order": "

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

", "BotVersionSortBy$order": "

The order to sort the list. You can specify ascending or descending order.

", "BuiltInIntentSortBy$order": "

The order to sort the list. You can specify ascending or descending order.

", "BuiltInSlotTypeSortBy$order": "

The order to sort the list. You can choose ascending or descending.

", @@ -5407,6 +5589,8 @@ "AggregatedUtterancesSummary$utteranceLastRecordedInAggregationDuration": "

The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.

", "BotAliasHistoryEvent$startDate": "

The date and time that the event started.

", "BotAliasHistoryEvent$endDate": "

The date and time that the event ended.

", + "BotAliasReplicaSummary$creationDateTime": "

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

", + "BotAliasReplicaSummary$lastUpdatedDateTime": "

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

", "BotAliasSummary$creationDateTime": "

A timestamp of the date and time that the bot alias was created.

", "BotAliasSummary$lastUpdatedDateTime": "

A timestamp of the date and time that the bot alias was last updated.

", "BotLocaleHistoryEvent$eventDate": "

A timestamp of the date and time that the event occurred.

", @@ -5414,13 +5598,16 @@ "BotLocaleSummary$lastBuildSubmittedDateTime": "

A timestamp of the date and time that the bot locale was last built.

", "BotRecommendationSummary$creationDateTime": "

A timestamp of the date and time that the bot recommendation was created.

", "BotRecommendationSummary$lastUpdatedDateTime": "

A timestamp of the date and time that the bot recommendation was last updated.

", + "BotReplicaSummary$creationDateTime": "

The creation time and date for the replicated bots.

", "BotSummary$lastUpdatedDateTime": "

The date and time that the bot was last updated.

", + "BotVersionReplicaSummary$creationDateTime": "

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

", "BotVersionSummary$creationDateTime": "

A timestamp of the date and time that the version was created.

", "BuildBotLocaleResponse$lastBuildSubmittedDateTime": "

A timestamp indicating the date and time that the bot was last built for this locale.

", "ConversationLogsDataSourceFilterBy$startTime": "

The start time for the conversation log.

", "ConversationLogsDataSourceFilterBy$endTime": "

The end time for the conversation log.

", "CreateBotAliasResponse$creationDateTime": "

A Unix timestamp indicating the date and time that the bot alias was created.

", "CreateBotLocaleResponse$creationDateTime": "

A timestamp specifying the date and time that the bot locale was created.

", + "CreateBotReplicaResponse$creationDateTime": "

The creation date and time of the replicated bot generated.

", "CreateBotResponse$creationDateTime": "

A timestamp indicating the date and time that the bot was created.

", "CreateBotVersionResponse$creationDateTime": "

A timestamp of the date and time that the version was created.

", "CreateExportResponse$creationDateTime": "

The date and time that the request to export a bot was created.

", @@ -5437,6 +5624,7 @@ "DescribeBotLocaleResponse$lastBuildSubmittedDateTime": "

The date and time that the locale was last submitted for building.

", "DescribeBotRecommendationResponse$creationDateTime": "

The date and time that the bot recommendation was created.

", "DescribeBotRecommendationResponse$lastUpdatedDateTime": "

The date and time that the bot recommendation was last updated.

", + "DescribeBotReplicaResponse$creationDateTime": "

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

", "DescribeBotResourceGenerationResponse$creationDateTime": "

The date and time at which the item was generated.

", "DescribeBotResourceGenerationResponse$lastUpdatedDateTime": "

The date and time at which the generated item was updated.

", "DescribeBotResponse$creationDateTime": "

A timestamp of the date and time that the bot was created.

", diff --git a/apis/models.lex.v2/2020-08-07/paginators-1.json b/apis/models.lex.v2/2020-08-07/paginators-1.json index 3ccc0d6b5e2..73893bc54ad 100644 --- a/apis/models.lex.v2/2020-08-07/paginators-1.json +++ b/apis/models.lex.v2/2020-08-07/paginators-1.json @@ -5,6 +5,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListBotAliasReplicas": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListBotAliases": { "input_token": "nextToken", "output_token": "nextToken", @@ -25,6 +30,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListBotVersionReplicas": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListBotVersions": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/apis/redshift/2012-12-01/api-2.json b/apis/redshift/2012-12-01/api-2.json index 8ad963fcb6d..80f9d891b33 100644 --- a/apis/redshift/2012-12-01/api-2.json +++ b/apis/redshift/2012-12-01/api-2.json @@ -1661,6 +1661,22 @@ {"shape":"UnsupportedOperationFault"} ] }, + "ListRecommendations":{ + "name":"ListRecommendations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRecommendationsMessage"}, + "output":{ + "shape":"ListRecommendationsResult", + "resultWrapper":"ListRecommendationsResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ] + }, "ModifyAquaConfiguration":{ "name":"ModifyAquaConfiguration", "http":{ @@ -5003,6 +5019,14 @@ "min":1, "pattern":"^[a-zA-Z0-9_+.#@$-]+$" }, + "ImpactRankingType":{ + "type":"string", + "enum":[ + "HIGH", + "MEDIUM", + "LOW" + ] + }, "ImportTablesCompleted":{ "type":"list", "member":{"shape":"String"} @@ -5493,6 +5517,22 @@ }, "exception":true }, + "ListRecommendationsMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "NamespaceArn":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "ListRecommendationsResult":{ + "type":"structure", + "members":{ + "Recommendations":{"shape":"RecommendationList"}, + "Marker":{"shape":"String"} + } + }, "LogDestinationType":{ "type":"string", "enum":[ @@ -6153,6 +6193,53 @@ "Cluster":{"shape":"Cluster"} } }, + "Recommendation":{ + "type":"structure", + "members":{ + "Id":{"shape":"String"}, + "ClusterIdentifier":{"shape":"String"}, + "NamespaceArn":{"shape":"String"}, + "CreatedAt":{"shape":"TStamp"}, + "RecommendationType":{"shape":"String"}, + "Title":{"shape":"String"}, + "Description":{"shape":"String"}, + "Observation":{"shape":"String"}, + "ImpactRanking":{"shape":"ImpactRankingType"}, + "RecommendationText":{"shape":"String"}, + "RecommendedActions":{"shape":"RecommendedActionList"}, + "ReferenceLinks":{"shape":"ReferenceLinkList"} + } + }, + "RecommendationList":{ + "type":"list", + "member":{ + "shape":"Recommendation", + "locationName":"Recommendation" + } + }, + "RecommendedAction":{ + "type":"structure", + "members":{ + "Text":{"shape":"String"}, + "Database":{"shape":"String"}, + "Command":{"shape":"String"}, + "Type":{"shape":"RecommendedActionType"} + } + }, + "RecommendedActionList":{ + "type":"list", + "member":{ + "shape":"RecommendedAction", + "locationName":"RecommendedAction" + } + }, + "RecommendedActionType":{ + "type":"string", + "enum":[ + "SQL", + "CLI" + ] + }, "RecurringCharge":{ "type":"structure", "members":{ @@ -6227,6 +6314,20 @@ }, "exception":true }, + "ReferenceLink":{ + "type":"structure", + "members":{ + "Text":{"shape":"String"}, + "Link":{"shape":"String"} + } + }, + "ReferenceLinkList":{ + "type":"list", + "member":{ + "shape":"ReferenceLink", + "locationName":"ReferenceLink" + } + }, "RejectDataShareMessage":{ "type":"structure", "required":["DataShareArn"], diff --git a/apis/redshift/2012-12-01/docs-2.json b/apis/redshift/2012-12-01/docs-2.json index efb607c3071..c9f950df528 100644 --- a/apis/redshift/2012-12-01/docs-2.json +++ b/apis/redshift/2012-12-01/docs-2.json @@ -101,6 +101,7 @@ "GetReservedNodeExchangeConfigurationOptions": "

Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type.

", "GetReservedNodeExchangeOfferings": "

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.

", "GetResourcePolicy": "

Get the resource policy for a specified resource.

", + "ListRecommendations": "

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

", "ModifyAquaConfiguration": "

This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

", "ModifyAuthenticationProfile": "

Modifies an authentication profile.

", "ModifyCluster": "

Modifies the settings for a cluster.

You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.

You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

", @@ -1868,6 +1869,12 @@ "RedshiftIdcApplication$IdentityNamespace": "

The identity namespace for the Amazon Redshift IAM Identity Center application. It determines which managed application verifies the connection token.

" } }, + "ImpactRankingType": { + "base": null, + "refs": { + "Recommendation$ImpactRanking": "

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

" + } + }, "ImportTablesCompleted": { "base": null, "refs": { @@ -1997,6 +2004,7 @@ "GetClusterCredentialsWithIAMMessage$DurationSeconds": "

The number of seconds until the returned temporary password expires.

Range: 900-3600. Default: 900.

", "GetReservedNodeExchangeConfigurationOptionsInputMessage$MaxRecords": "

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.

", "GetReservedNodeExchangeOfferingsInputMessage$MaxRecords": "

An integer setting the maximum number of ReservedNodeOfferings to retrieve.

", + "ListRecommendationsMessage$MaxRecords": "

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.

", "ModifyClusterMaintenanceMessage$DeferMaintenanceDuration": "

An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.

", "ModifyClusterMessage$NumberOfNodes": "

The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Valid Values: Integer greater than 0.

", "ModifyClusterMessage$AutomatedSnapshotRetentionPeriod": "

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

", @@ -2217,6 +2225,16 @@ "refs": { } }, + "ListRecommendationsMessage": { + "base": null, + "refs": { + } + }, + "ListRecommendationsResult": { + "base": null, + "refs": { + } + }, "LogDestinationType": { "base": null, "refs": { @@ -2666,6 +2684,36 @@ "refs": { } }, + "Recommendation": { + "base": "

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

", + "refs": { + "RecommendationList$member": null + } + }, + "RecommendationList": { + "base": null, + "refs": { + "ListRecommendationsResult$Recommendations": "

The Advisor recommendations for action on the Amazon Redshift cluster.

" + } + }, + "RecommendedAction": { + "base": "

The recommended action from the Amazon Redshift Advisor recommendation.

", + "refs": { + "RecommendedActionList$member": null + } + }, + "RecommendedActionList": { + "base": null, + "refs": { + "Recommendation$RecommendedActions": "

List of Amazon Redshift recommended actions.

" + } + }, + "RecommendedActionType": { + "base": null, + "refs": { + "RecommendedAction$Type": "

The type of command.

" + } + }, "RecurringCharge": { "base": "

Describes a recurring charge.

", "refs": { @@ -2715,6 +2763,18 @@ "refs": { } }, + "ReferenceLink": { + "base": "

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

", + "refs": { + "ReferenceLinkList$member": null + } + }, + "ReferenceLinkList": { + "base": null, + "refs": { + "Recommendation$ReferenceLinks": "

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

" + } + }, "RejectDataShareMessage": { "base": null, "refs": { @@ -3666,6 +3726,10 @@ "InboundIntegrationsMessage$Marker": "

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.

", "IntegrationError$ErrorCode": "

The error code of an inbound integration error.

", "IntegrationError$ErrorMessage": "

The error message of an inbound integration error.

", + "ListRecommendationsMessage$ClusterIdentifier": "

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.

", + "ListRecommendationsMessage$NamespaceArn": "

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.

", + "ListRecommendationsMessage$Marker": "

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$Marker": "

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.

", "LogTypeList$member": null, "LoggingStatus$BucketName": "

The name of the S3 bucket where the log files are stored.

", "LoggingStatus$S3KeyPrefix": "

The prefix applied to the log file names.

", @@ -3749,12 +3813,25 @@ "PutResourcePolicyMessage$ResourceArn": "

The Amazon Resource Name (ARN) of the resource of which its resource policy is updated.

", "PutResourcePolicyMessage$Policy": "

The content of the resource policy being updated.

", "RebootClusterMessage$ClusterIdentifier": "

The cluster identifier.

", + "Recommendation$Id": "

A unique identifier of the Advisor recommendation.

", + "Recommendation$ClusterIdentifier": "

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

", + "Recommendation$NamespaceArn": "

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

", + "Recommendation$RecommendationType": "

The type of Advisor recommendation.

", + "Recommendation$Title": "

The title of the recommendation.

", + "Recommendation$Description": "

The description of the recommendation.

", + "Recommendation$Observation": "

The description of what was observed about your cluster.

", + "Recommendation$RecommendationText": "

The description of the recommendation.

", + "RecommendedAction$Text": "

The specific instruction about the command.

", + "RecommendedAction$Database": "

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

", + "RecommendedAction$Command": "

The command to run.

", "RecurringCharge$RecurringChargeFrequency": "

The frequency at which the recurring charge amount is applied.

", "RedshiftIdcApplication$IdcInstanceArn": "

The ARN for the IAM Identity Center instance that Redshift integrates with.

", "RedshiftIdcApplication$RedshiftIdcApplicationArn": "

The ARN for the Redshift application that integrates with IAM Identity Center.

", "RedshiftIdcApplication$IamRoleArn": "

The ARN for the Amazon Redshift IAM Identity Center application. It has the required permissions to be assumed and invoke the IDC Identity Center API.

", "RedshiftIdcApplication$IdcManagedApplicationArn": "

The ARN for the Amazon Redshift IAM Identity Center application.

", "RedshiftIdcApplication$IdcOnboardStatus": "

The onboarding status for the Amazon Redshift IAM Identity Center application.

", + "ReferenceLink$Text": "

The hyperlink text that describes the link to more information.

", + "ReferenceLink$Link": "

The URL address to find more information.

", "RejectDataShareMessage$DataShareArn": "

The Amazon Resource Name (ARN) of the datashare to reject.

", "ReservedNode$ReservedNodeId": "

The unique identifier for the reservation.

", "ReservedNode$ReservedNodeOfferingId": "

The identifier for the reserved node offering.

", @@ -4018,6 +4095,7 @@ "ModifyScheduledActionMessage$EndTime": "

A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

", "PartnerIntegrationInfo$CreatedAt": "

The date (UTC) that the partner integration was created.

", "PartnerIntegrationInfo$UpdatedAt": "

The date (UTC) that the partner integration status was last updated by the partner.

", + "Recommendation$CreatedAt": "

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

", "ReservedNode$StartTime": "

The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

", "ReservedNodeExchangeStatus$RequestTime": "

A date and time that indicate when the reserved-node exchange was requested.

", "RevisionTarget$DatabaseRevisionReleaseDate": "

The date on which the database revision was released.

", diff --git a/apis/redshift/2012-12-01/paginators-1.json b/apis/redshift/2012-12-01/paginators-1.json index 4403ac87b2b..8dc4a35f6b6 100644 --- a/apis/redshift/2012-12-01/paginators-1.json +++ b/apis/redshift/2012-12-01/paginators-1.json @@ -209,6 +209,12 @@ "limit_key": "MaxRecords", "output_token": "Marker", "result_key": "ReservedNodeOfferings" + }, + "ListRecommendations": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Recommendations" } } } \ No newline at end of file diff --git a/gems/aws-partitions/CHANGELOG.md b/gems/aws-partitions/CHANGELOG.md index 3f148e0b291..b20f43a68b6 100644 --- a/gems/aws-partitions/CHANGELOG.md +++ b/gems/aws-partitions/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.888.0 (2024-02-07) +------------------ + +* Feature - Updated the partitions source data the determines the AWS service regions and endpoints. + 1.887.0 (2024-02-02) ------------------ diff --git a/gems/aws-partitions/VERSION b/gems/aws-partitions/VERSION index d52147c542f..29e753448d2 100644 --- a/gems/aws-partitions/VERSION +++ b/gems/aws-partitions/VERSION @@ -1 +1 @@ -1.887.0 +1.888.0 diff --git a/gems/aws-partitions/partitions.json b/gems/aws-partitions/partitions.json index 4cef7a07075..c7687dd4ec6 100644 --- a/gems/aws-partitions/partitions.json +++ b/gems/aws-partitions/partitions.json @@ -14350,12 +14350,6 @@ } ] }, "endpoints" : { - "af-south-1" : { - "hostname" : "resource-explorer-2.af-south-1.api.aws" - }, - "ap-east-1" : { - "hostname" : "resource-explorer-2.ap-east-1.api.aws" - }, "ap-northeast-1" : { "hostname" : "resource-explorer-2.ap-northeast-1.api.aws" }, @@ -14368,9 +14362,6 @@ "ap-south-1" : { "hostname" : "resource-explorer-2.ap-south-1.api.aws" }, - "ap-south-2" : { - "hostname" : "resource-explorer-2.ap-south-2.api.aws" - }, "ap-southeast-1" : { "hostname" : "resource-explorer-2.ap-southeast-1.api.aws" }, @@ -14380,24 +14371,15 @@ "ap-southeast-3" : { "hostname" : "resource-explorer-2.ap-southeast-3.api.aws" }, - "ap-southeast-4" : { - "hostname" : "resource-explorer-2.ap-southeast-4.api.aws" - }, "ca-central-1" : { "hostname" : "resource-explorer-2.ca-central-1.api.aws" }, "eu-central-1" : { "hostname" : "resource-explorer-2.eu-central-1.api.aws" }, - "eu-central-2" : { - "hostname" : "resource-explorer-2.eu-central-2.api.aws" - }, "eu-north-1" : { "hostname" : "resource-explorer-2.eu-north-1.api.aws" }, - "eu-south-1" : { - "hostname" : "resource-explorer-2.eu-south-1.api.aws" - }, "eu-west-1" : { "hostname" : "resource-explorer-2.eu-west-1.api.aws" }, @@ -14407,12 +14389,6 @@ "eu-west-3" : { "hostname" : "resource-explorer-2.eu-west-3.api.aws" }, - "il-central-1" : { - "hostname" : "resource-explorer-2.il-central-1.api.aws" - }, - "me-central-1" : { - "hostname" : "resource-explorer-2.me-central-1.api.aws" - }, "me-south-1" : { "hostname" : "resource-explorer-2.me-south-1.api.aws" }, @@ -20726,6 +20702,12 @@ "cn-northwest-1" : { } } }, + "inspector2" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "internetmonitor" : { "defaults" : { "dnsSuffix" : "api.amazonwebservices.com.cn", diff --git a/gems/aws-sdk-core/CHANGELOG.md b/gems/aws-sdk-core/CHANGELOG.md index ff633b5e0a3..9a988b5fce2 100644 --- a/gems/aws-sdk-core/CHANGELOG.md +++ b/gems/aws-sdk-core/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +3.191.1 (2024-02-07) +------------------ + * Issue - Warn on previously silent credential failures (#2981). 3.191.0 (2024-01-26) diff --git a/gems/aws-sdk-core/VERSION b/gems/aws-sdk-core/VERSION index c9f6efba246..2944d86876b 100644 --- a/gems/aws-sdk-core/VERSION +++ b/gems/aws-sdk-core/VERSION @@ -1 +1 @@ -3.191.0 +3.191.1 diff --git a/gems/aws-sdk-core/lib/aws-sdk-sso.rb b/gems/aws-sdk-core/lib/aws-sdk-sso.rb index 82c4593a8f8..74f6244bb18 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-sso.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-sso.rb @@ -54,6 +54,6 @@ # @!group service module Aws::SSO - GEM_VERSION = '3.191.0' + GEM_VERSION = '3.191.1' end diff --git a/gems/aws-sdk-core/lib/aws-sdk-sso/client.rb b/gems/aws-sdk-core/lib/aws-sdk-sso/client.rb index c1c1141f4b4..acffb0cbf06 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-sso/client.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-sso/client.rb @@ -605,7 +605,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-core' - context[:gem_version] = '3.191.0' + context[:gem_version] = '3.191.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-core/lib/aws-sdk-ssooidc.rb b/gems/aws-sdk-core/lib/aws-sdk-ssooidc.rb index e7210afb7d5..33c71aeea21 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-ssooidc.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-ssooidc.rb @@ -54,6 +54,6 @@ # @!group service module Aws::SSOOIDC - GEM_VERSION = '3.191.0' + GEM_VERSION = '3.191.1' end diff --git a/gems/aws-sdk-core/lib/aws-sdk-ssooidc/client.rb b/gems/aws-sdk-core/lib/aws-sdk-ssooidc/client.rb index ceac23b9e8b..960af30e6c7 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-ssooidc/client.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-ssooidc/client.rb @@ -910,7 +910,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-core' - context[:gem_version] = '3.191.0' + context[:gem_version] = '3.191.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-core/lib/aws-sdk-sts.rb b/gems/aws-sdk-core/lib/aws-sdk-sts.rb index 5d0ff9a12cd..b3362943cfd 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-sts.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-sts.rb @@ -54,6 +54,6 @@ # @!group service module Aws::STS - GEM_VERSION = '3.191.0' + GEM_VERSION = '3.191.1' end diff --git a/gems/aws-sdk-core/lib/aws-sdk-sts/client.rb b/gems/aws-sdk-core/lib/aws-sdk-sts/client.rb index 0c8409d9def..0d0192ba862 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-sts/client.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-sts/client.rb @@ -2352,7 +2352,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-core' - context[:gem_version] = '3.191.0' + context[:gem_version] = '3.191.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-datasync/CHANGELOG.md b/gems/aws-sdk-datasync/CHANGELOG.md index 163eb29177d..0d228fcc527 100644 --- a/gems/aws-sdk-datasync/CHANGELOG.md +++ b/gems/aws-sdk-datasync/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.73.0 (2024-02-07) +------------------ + +* Feature - AWS DataSync now supports manifests for specifying files or objects to transfer. + 1.72.0 (2024-01-26) ------------------ diff --git a/gems/aws-sdk-datasync/VERSION b/gems/aws-sdk-datasync/VERSION index 0834888f558..5e3a4256626 100644 --- a/gems/aws-sdk-datasync/VERSION +++ b/gems/aws-sdk-datasync/VERSION @@ -1 +1 @@ -1.72.0 +1.73.0 diff --git a/gems/aws-sdk-datasync/lib/aws-sdk-datasync.rb b/gems/aws-sdk-datasync/lib/aws-sdk-datasync.rb index 20038b7773e..d6af6f72369 100644 --- a/gems/aws-sdk-datasync/lib/aws-sdk-datasync.rb +++ b/gems/aws-sdk-datasync/lib/aws-sdk-datasync.rb @@ -52,6 +52,6 @@ # @!group service module Aws::DataSync - GEM_VERSION = '1.72.0' + GEM_VERSION = '1.73.0' end diff --git a/gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb b/gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb index 5c8df79d540..6e68f03acf3 100644 --- a/gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb +++ b/gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb @@ -615,8 +615,9 @@ def create_agent(params = {}, options = {}) req.send_request(options) end - # Creates an endpoint for a Microsoft Azure Blob Storage container that - # DataSync can use as a transfer source or destination. + # 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][1] and works with [access tiers][2] and [blob types][3]. You @@ -719,13 +720,16 @@ def create_location_azure_blob(params = {}, options = {}) req.send_request(options) end - # 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][1]. + # 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][1]. # # # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access # # @option params [String] :subdirectory # Specifies a mount path for your Amazon EFS file system. This is where @@ -805,7 +809,16 @@ def create_location_efs(params = {}, options = {}) req.send_request(options) end - # Creates an endpoint for an Amazon FSx for Lustre file system. + # 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][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access # # @option params [required, String] :fsx_filesystem_arn # The Amazon Resource Name (ARN) for the FSx for Lustre file system. @@ -856,11 +869,12 @@ def create_location_fsx_lustre(params = {}, options = {}) req.send_request(options) end - # Creates an endpoint for an Amazon FSx for NetApp ONTAP file system - # that DataSync can use for a data transfer. + # 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 - # an FSx for ONTAP file system][1]. + # FSx for ONTAP file systems][1]. # # # @@ -958,9 +972,12 @@ def create_location_fsx_ontap(params = {}, options = {}) req.send_request(options) end - # 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][1]. + # 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][1]. # # Request parameters related to `SMB` aren't supported with the # `CreateLocationFsxOpenZfs` operation. @@ -969,7 +986,7 @@ def create_location_fsx_ontap(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access # # @option params [required, String] :fsx_filesystem_arn # The Amazon Resource Name (ARN) of the FSx for OpenZFS file system. @@ -1038,11 +1055,12 @@ def create_location_fsx_open_zfs(params = {}, options = {}) req.send_request(options) end - # Creates an endpoint for an Amazon FSx for Windows File Server file - # system that DataSync can use for a data transfer. + # 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 - # an FSx for Windows File Server][1]. + # FSx for Windows File Server file systems][1]. # # # @@ -1078,8 +1096,9 @@ def create_location_fsx_open_zfs(params = {}, options = {}) # tag for your location. # # @option params [required, String] :user - # Specifies the user who has the permissions to access files, folders, - # and metadata in your file system. + # 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][1] for FSx for Windows @@ -1090,29 +1109,17 @@ def create_location_fsx_open_zfs(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions # # @option params [String] :domain - # 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][1] for FSx for - # Windows File Server locations. + # Specifies the name of the Microsoft Active Directory domain that the + # FSx for Windows File Server file system belongs to. # - # - # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions + # If you have multiple Active Directory domains in your environment, + # configuring this parameter makes sure that DataSync connects to the + # right file system. # # @option params [required, String] :password - # 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][1] for FSx for - # Windows File Server locations. - # - # - # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions + # 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. # # @return [Types::CreateLocationFsxWindowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1148,7 +1155,16 @@ def create_location_fsx_windows(params = {}, options = {}) req.send_request(options) end - # Creates an endpoint for a Hadoop Distributed File System (HDFS). + # 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][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs # # @option params [String] :subdirectory # A subdirectory in the HDFS cluster. This subdirectory is used to read @@ -1283,11 +1299,12 @@ def create_location_hdfs(params = {}, options = {}) req.send_request(options) end - # Creates an endpoint for a Network File System (NFS) file server that - # DataSync can use for a data transfer. + # 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. # - # For more information, see [Configuring transfers to or from an NFS - # file server][1]. + # Before you begin, make sure that you understand how DataSync [accesses + # NFS file servers][1]. # # If you're copying data to or from an Snowcone device, you can also # use `CreateLocationNfs` to create your transfer location. For more @@ -1297,7 +1314,7 @@ def create_location_hdfs(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/nfs-on-snowcone.html # # @option params [required, String] :subdirectory @@ -1372,13 +1389,16 @@ def create_location_nfs(params = {}, options = {}) req.send_request(options) end - # 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][1]. + # 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][1] + # for DataSync to work with object storage systems. # # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites # # @option params [required, String] :server_hostname # Specifies the domain name or IP address of the object storage server. @@ -1475,72 +1495,93 @@ def create_location_object_storage(params = {}, options = {}) req.send_request(options) end - # A *location* is an endpoint for an Amazon S3 bucket. DataSync can use - # the location as a source or destination for copying data. + # Creates a transfer *location* for an Amazon S3 bucket. DataSync can + # use this location as a source or destination for transferring data. # - # Before you create your location, make sure that you read the following - # sections: + # Before you begin, make sure that you read the following topics: # # * [Storage class considerations with Amazon S3 locations][1] # # * [Evaluating S3 request costs when using DataSync][2] # - # For more information, see [Creating an Amazon S3 location][3]. + # For more information, see [Configuring transfers with Amazon S3][3]. # # # # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests - # [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli + # [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html # # @option params [String] :subdirectory - # 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. + # 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: + # + # * `/photos` + # + # * `photos//2006/January` + # + # * `photos/./2006/February` + # + # * `photos/../2006/March` + # + # # # @option params [required, String] :s3_bucket_arn - # The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web - # Services Outpost, this must be an access point ARN. + # 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][1] in the *Amazon S3 User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html # # @option params [String] :s3_storage_class - # 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. + # 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 about S3 storage classes, see [Amazon S3 Storage - # Classes][1]. 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][2]. + # For more information, see [Storage class considerations with Amazon S3 + # transfers][1]. # # # - # [1]: http://aws.amazon.com/s3/storage-classes/ - # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes # # @option params [required, Types::S3Config] :s3_config - # The Amazon Resource Name (ARN) of the Identity and Access Management - # (IAM) role used to access an Amazon S3 bucket. + # Specifies the Amazon Resource Name (ARN) of the Identity and Access + # Management (IAM) role that DataSync uses to access your S3 bucket. # - # For detailed information about using such a role, see Creating a - # Location for Amazon S3 in the *DataSync User Guide*. + # For more information, see [Accessing S3 buckets][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access # # @option params [Array] :agent_arns - # 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][1]. + # (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][1]. # # # # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent # # @option params [Array] :tags - # 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. + # 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. # # @return [Types::CreateLocationS3Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1577,15 +1618,16 @@ def create_location_s3(params = {}, options = {}) req.send_request(options) end - # Creates an endpoint for a Server Message Block (SMB) file server that - # DataSync can use for a data transfer. + # 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 - # an SMB file server][1]. + # SMB file servers][1]. # # # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb # # @option params [required, String] :subdirectory # Specifies the name of the share exported by your SMB file server where @@ -1593,9 +1635,9 @@ def create_location_s3(params = {}, options = {}) # 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][1] for SMB locations. + # 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][1] for SMB locations. # # # @@ -1610,8 +1652,8 @@ def create_location_s3(params = {}, options = {}) # # # @option params [required, String] :user - # Specifies the user name that can mount your SMB file server and has - # permission to access the files and folders involved in your transfer. + # 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][1] for SMB locations. @@ -1621,17 +1663,12 @@ def create_location_s3(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions # # @option params [String] :domain - # 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][1] for SMB locations. - # + # Specifies the name of the Active Directory domain that your SMB file + # server belongs to. # - # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions + # If you have multiple Active Directory domains in your environment, + # configuring this parameter makes sure that DataSync connects to the + # right file server. # # @option params [required, String] :password # Specifies the password of the user who can mount your SMB file server @@ -1772,9 +1809,35 @@ def create_location_smb(params = {}, options = {}) # # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html # + # @option params [Types::ManifestConfig] :manifest_config + # 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][1]. + # + # When using this parameter, your caller identity (the role that you're + # using DataSync with) must have the `iam:PassRole` permission. The + # [AWSDataSyncFullAccess][2] policy includes this permission. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + # # @option params [Types::TaskReportConfig] :task_report_config # Specifies how you want to configure a task report, which provides - # detailed information about for your DataSync transfer. + # detailed information about your DataSync transfer. For more + # information, see [Monitoring your DataSync transfers with task + # reports][1]. + # + # When using this parameter, your caller identity (the role that you're + # using DataSync with) must have the `iam:PassRole` permission. The + # [AWSDataSyncFullAccess][2] policy includes this permission. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess # # @return [Types::CreateTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1825,6 +1888,18 @@ def create_location_smb(params = {}, options = {}) # value: "FilterValue", # }, # ], + # manifest_config: { + # action: "TRANSFER", # accepts TRANSFER + # format: "CSV", # accepts CSV + # source: { + # s3: { # required + # manifest_object_path: "S3Subdirectory", # required + # bucket_access_role_arn: "IamRoleArn", # required + # s3_bucket_arn: "S3BucketArn", # required + # manifest_object_version_id: "S3ObjectVersionId", + # }, + # }, + # }, # task_report_config: { # destination: { # s3: { @@ -1901,7 +1976,7 @@ def delete_agent(params = {}, options = {}) req.send_request(options) end - # Deletes the configuration of a location used by DataSync. + # Deletes a transfer location resource from DataSync. # # @option params [required, String] :location_arn # The Amazon Resource Name (ARN) of the location to delete. @@ -1923,7 +1998,7 @@ def delete_location(params = {}, options = {}) req.send_request(options) end - # Deletes an DataSync transfer task. + # Deletes a transfer task resource from DataSync. # # @option params [required, String] :task_arn # Specifies the Amazon Resource Name (ARN) of the task that you want to @@ -2077,8 +2152,8 @@ def describe_location_azure_blob(params = {}, options = {}) req.send_request(options) end - # Returns metadata about your DataSync location for an Amazon EFS file - # system. + # Provides details about how an DataSync transfer location for an Amazon + # EFS file system is configured. # # @option params [required, String] :location_arn # The Amazon Resource Name (ARN) of the Amazon EFS file system location @@ -2121,8 +2196,8 @@ def describe_location_efs(params = {}, options = {}) req.send_request(options) end - # Provides details about how an DataSync location for an Amazon FSx for - # Lustre file system is configured. + # Provides details about how an DataSync transfer location for an Amazon + # FSx for Lustre file system is configured. # # @option params [required, String] :location_arn # The Amazon Resource Name (ARN) of the FSx for Lustre location to @@ -2158,8 +2233,8 @@ def describe_location_fsx_lustre(params = {}, options = {}) req.send_request(options) end - # Provides details about how an DataSync location for an Amazon FSx for - # NetApp ONTAP file system is configured. + # 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`. @@ -2210,8 +2285,8 @@ def describe_location_fsx_ontap(params = {}, options = {}) req.send_request(options) end - # Provides details about how an DataSync location for an Amazon FSx for - # OpenZFS file system is configured. + # 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. @@ -2258,12 +2333,12 @@ def describe_location_fsx_open_zfs(params = {}, options = {}) req.send_request(options) end - # Returns metadata about an Amazon FSx for Windows File Server location, - # such as information about its path. + # Provides details about how an DataSync transfer location for an Amazon + # FSx for Windows File Server file system is configured. # # @option params [required, String] :location_arn - # The Amazon Resource Name (ARN) of the FSx for Windows File Server - # location to describe. + # Specifies the Amazon Resource Name (ARN) of the FSx for Windows File + # Server location. # # @return [Types::DescribeLocationFsxWindowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2299,12 +2374,11 @@ def describe_location_fsx_windows(params = {}, options = {}) req.send_request(options) end - # Returns metadata, such as the authentication information about the - # Hadoop Distributed File System (HDFS) location. + # Provides details about how an DataSync transfer location for a Hadoop + # Distributed File System (HDFS) is configured. # # @option params [required, String] :location_arn - # The Amazon Resource Name (ARN) of the HDFS cluster location to - # describe. + # Specifies the Amazon Resource Name (ARN) of the HDFS location. # # @return [Types::DescribeLocationHdfsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2394,12 +2468,12 @@ def describe_location_nfs(params = {}, options = {}) req.send_request(options) end - # Returns metadata about your DataSync location for an object storage - # system. + # Provides details about how an DataSync transfer location for an object + # storage system is configured. # # @option params [required, String] :location_arn - # The Amazon Resource Name (ARN) of the object storage system location - # that you want information about. + # Specifies the Amazon Resource Name (ARN) of the object storage system + # location. # # @return [Types::DescribeLocationObjectStorageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2439,12 +2513,11 @@ def describe_location_object_storage(params = {}, options = {}) req.send_request(options) end - # Returns metadata, such as bucket name, about an Amazon S3 bucket - # location. + # Provides details about how an DataSync transfer location for an S3 + # bucket is configured. # # @option params [required, String] :location_arn - # The Amazon Resource Name (ARN) of the Amazon S3 bucket location to - # describe. + # Specifies the Amazon Resource Name (ARN) of the Amazon S3 location. # # @return [Types::DescribeLocationS3Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2480,11 +2553,12 @@ def describe_location_s3(params = {}, options = {}) req.send_request(options) end - # Returns metadata, such as the path and user information about an SMB - # location. + # Provides details about how an DataSync transfer location for a Server + # Message Block (SMB) file server is configured. # # @option params [required, String] :location_arn - # The Amazon Resource Name (ARN) of the SMB location to describe. + # Specifies the Amazon Resource Name (ARN) of the SMB location that you + # want information about. # # @return [Types::DescribeLocationSmbResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2828,6 +2902,7 @@ def describe_storage_system_resources(params = {}, options = {}) # * {Types::DescribeTaskResponse#error_detail #error_detail} => String # * {Types::DescribeTaskResponse#creation_time #creation_time} => Time # * {Types::DescribeTaskResponse#includes #includes} => Array<Types::FilterRule> + # * {Types::DescribeTaskResponse#manifest_config #manifest_config} => Types::ManifestConfig # * {Types::DescribeTaskResponse#task_report_config #task_report_config} => Types::TaskReportConfig # # @example Request syntax with placeholder values @@ -2874,6 +2949,12 @@ def describe_storage_system_resources(params = {}, options = {}) # resp.includes #=> Array # resp.includes[0].filter_type #=> String, one of "SIMPLE_PATTERN" # resp.includes[0].value #=> String + # resp.manifest_config.action #=> String, one of "TRANSFER" + # resp.manifest_config.format #=> String, one of "CSV" + # resp.manifest_config.source.s3.manifest_object_path #=> String + # resp.manifest_config.source.s3.bucket_access_role_arn #=> String + # resp.manifest_config.source.s3.s3_bucket_arn #=> String + # resp.manifest_config.source.s3.manifest_object_version_id #=> String # resp.task_report_config.destination.s3.subdirectory #=> String # resp.task_report_config.destination.s3.s3_bucket_arn #=> String # resp.task_report_config.destination.s3.bucket_access_role_arn #=> String @@ -2909,14 +2990,15 @@ def describe_task(params = {}, options = {}) # * {Types::DescribeTaskExecutionResponse#options #options} => Types::Options # * {Types::DescribeTaskExecutionResponse#excludes #excludes} => Array<Types::FilterRule> # * {Types::DescribeTaskExecutionResponse#includes #includes} => Array<Types::FilterRule> + # * {Types::DescribeTaskExecutionResponse#manifest_config #manifest_config} => Types::ManifestConfig # * {Types::DescribeTaskExecutionResponse#start_time #start_time} => Time # * {Types::DescribeTaskExecutionResponse#estimated_files_to_transfer #estimated_files_to_transfer} => Integer # * {Types::DescribeTaskExecutionResponse#estimated_bytes_to_transfer #estimated_bytes_to_transfer} => Integer # * {Types::DescribeTaskExecutionResponse#files_transferred #files_transferred} => Integer # * {Types::DescribeTaskExecutionResponse#bytes_written #bytes_written} => Integer # * {Types::DescribeTaskExecutionResponse#bytes_transferred #bytes_transferred} => Integer - # * {Types::DescribeTaskExecutionResponse#result #result} => Types::TaskExecutionResultDetail # * {Types::DescribeTaskExecutionResponse#bytes_compressed #bytes_compressed} => Integer + # * {Types::DescribeTaskExecutionResponse#result #result} => Types::TaskExecutionResultDetail # * {Types::DescribeTaskExecutionResponse#task_report_config #task_report_config} => Types::TaskReportConfig # * {Types::DescribeTaskExecutionResponse#files_deleted #files_deleted} => Integer # * {Types::DescribeTaskExecutionResponse#files_skipped #files_skipped} => Integer @@ -2955,12 +3037,19 @@ def describe_task(params = {}, options = {}) # resp.includes #=> Array # resp.includes[0].filter_type #=> String, one of "SIMPLE_PATTERN" # resp.includes[0].value #=> String + # resp.manifest_config.action #=> String, one of "TRANSFER" + # resp.manifest_config.format #=> String, one of "CSV" + # resp.manifest_config.source.s3.manifest_object_path #=> String + # resp.manifest_config.source.s3.bucket_access_role_arn #=> String + # resp.manifest_config.source.s3.s3_bucket_arn #=> String + # resp.manifest_config.source.s3.manifest_object_version_id #=> String # resp.start_time #=> Time # resp.estimated_files_to_transfer #=> Integer # resp.estimated_bytes_to_transfer #=> Integer # resp.files_transferred #=> Integer # resp.bytes_written #=> Integer # resp.bytes_transferred #=> Integer + # resp.bytes_compressed #=> Integer # resp.result.prepare_duration #=> Integer # resp.result.prepare_status #=> String, one of "PENDING", "SUCCESS", "ERROR" # resp.result.total_duration #=> Integer @@ -2970,7 +3059,6 @@ def describe_task(params = {}, options = {}) # resp.result.verify_status #=> String, one of "PENDING", "SUCCESS", "ERROR" # resp.result.error_code #=> String # resp.result.error_detail #=> String - # resp.bytes_compressed #=> Integer # resp.task_report_config.destination.s3.subdirectory #=> String # resp.task_report_config.destination.s3.s3_bucket_arn #=> String # resp.task_report_config.destination.s3.bucket_access_role_arn #=> String @@ -3293,18 +3381,18 @@ def list_tags_for_resource(params = {}, options = {}) req.send_request(options) end - # Returns a list of executed tasks. + # Returns a list of executions for an DataSync transfer task. # # @option params [String] :task_arn - # The Amazon Resource Name (ARN) of the task whose tasks you want to - # list. + # Specifies the Amazon Resource Name (ARN) of the task that you want + # execution information about. # # @option params [Integer] :max_results - # The maximum number of executed tasks to list. + # Specifies how many results you want in the response. # # @option params [String] :next_token - # An opaque string that indicates the position at which to begin the - # next list of the executed tasks. + # Specifies an opaque string that indicates the position at which to + # begin the next list of results in the response. # # @return [Types::ListTaskExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -3522,6 +3610,42 @@ def start_discovery_job(params = {}, options = {}) # consists of the patterns to exclude. The patterns are delimited by # "\|" (that is, a pipe), for example, `"/folder1|/folder2"`. # + # @option params [Types::ManifestConfig] :manifest_config + # 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][1]. + # + # When using this parameter, your caller identity (the role that you're + # using DataSync with) must have the `iam:PassRole` permission. The + # [AWSDataSyncFullAccess][2] policy includes this permission. + # + # To remove a manifest configuration, specify this parameter with an + # empty value. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + # + # @option params [Types::TaskReportConfig] :task_report_config + # 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][1]. + # + # When using this parameter, your caller identity (the role that you're + # using DataSync with) must have the `iam:PassRole` permission. The + # [AWSDataSyncFullAccess][2] policy includes this permission. + # + # To remove a task report configuration, specify this parameter as + # empty. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + # # @option params [Array] :tags # Specifies the tags that you want to apply to the Amazon Resource Name # (ARN) representing the task execution. @@ -3529,10 +3653,6 @@ def start_discovery_job(params = {}, options = {}) # *Tags* are key-value pairs that help you manage, filter, and search # for your DataSync resources. # - # @option params [Types::TaskReportConfig] :task_report_config - # Specifies how you want to configure a task report, which provides - # detailed information about for your DataSync transfer. - # # @return [Types::StartTaskExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::StartTaskExecutionResponse#task_execution_arn #task_execution_arn} => String @@ -3570,12 +3690,18 @@ def start_discovery_job(params = {}, options = {}) # value: "FilterValue", # }, # ], - # tags: [ - # { - # key: "TagKey", # required - # value: "TagValue", + # manifest_config: { + # action: "TRANSFER", # accepts TRANSFER + # format: "CSV", # accepts CSV + # source: { + # s3: { # required + # manifest_object_path: "S3Subdirectory", # required + # bucket_access_role_arn: "IamRoleArn", # required + # s3_bucket_arn: "S3BucketArn", # required + # manifest_object_version_id: "S3ObjectVersionId", + # }, # }, - # ], + # }, # task_report_config: { # destination: { # s3: { @@ -3602,6 +3728,12 @@ def start_discovery_job(params = {}, options = {}) # }, # }, # }, + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", + # }, + # ], # }) # # @example Response structure @@ -4215,7 +4347,7 @@ def update_storage_system(params = {}, options = {}) req.send_request(options) end - # Updates the configuration of a DataSync transfer task. + # Updates the configuration of an DataSync transfer task. # # @option params [required, String] :task_arn # The Amazon Resource Name (ARN) of the resource name of the task to @@ -4267,9 +4399,40 @@ def update_storage_system(params = {}, options = {}) # # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html # + # @option params [Types::ManifestConfig] :manifest_config + # 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][1]. + # + # When using this parameter, your caller identity (the IAM role that + # you're using DataSync with) must have the `iam:PassRole` permission. + # The [AWSDataSyncFullAccess][2] policy includes this permission. + # + # To remove a manifest configuration, specify this parameter as empty. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + # # @option params [Types::TaskReportConfig] :task_report_config # Specifies how you want to configure a task report, which provides - # detailed information about for your DataSync transfer. + # detailed information about your DataSync transfer. For more + # information, see [Monitoring your DataSync transfers with task + # reports][1]. + # + # When using this parameter, your caller identity (the IAM role that + # you're using DataSync with) must have the `iam:PassRole` permission. + # The [AWSDataSyncFullAccess][2] policy includes this permission. + # + # To remove a task report configuration, specify this parameter as + # empty. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -4311,6 +4474,18 @@ def update_storage_system(params = {}, options = {}) # value: "FilterValue", # }, # ], + # manifest_config: { + # action: "TRANSFER", # accepts TRANSFER + # format: "CSV", # accepts CSV + # source: { + # s3: { # required + # manifest_object_path: "S3Subdirectory", # required + # bucket_access_role_arn: "IamRoleArn", # required + # s3_bucket_arn: "S3BucketArn", # required + # manifest_object_version_id: "S3ObjectVersionId", + # }, + # }, + # }, # task_report_config: { # destination: { # s3: { @@ -4416,7 +4591,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-datasync' - context[:gem_version] = '1.72.0' + context[:gem_version] = '1.73.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-datasync/lib/aws-sdk-datasync/client_api.rb b/gems/aws-sdk-datasync/lib/aws-sdk-datasync/client_api.rb index 0938e89e5fc..b6de622d597 100644 --- a/gems/aws-sdk-datasync/lib/aws-sdk-datasync/client_api.rb +++ b/gems/aws-sdk-datasync/lib/aws-sdk-datasync/client_api.rb @@ -194,6 +194,9 @@ module ClientApi LocationUri = Shapes::StringShape.new(name: 'LocationUri') LogGroupArn = Shapes::StringShape.new(name: 'LogGroupArn') LogLevel = Shapes::StringShape.new(name: 'LogLevel') + ManifestAction = Shapes::StringShape.new(name: 'ManifestAction') + ManifestConfig = Shapes::StructureShape.new(name: 'ManifestConfig') + ManifestFormat = Shapes::StringShape.new(name: 'ManifestFormat') MaxP95Performance = Shapes::StructureShape.new(name: 'MaxP95Performance') MaxResults = Shapes::IntegerShape.new(name: 'MaxResults') Metrics = Shapes::ListShape.new(name: 'Metrics') @@ -260,6 +263,8 @@ module ClientApi ResourceMetrics = Shapes::StructureShape.new(name: 'ResourceMetrics') S3BucketArn = Shapes::StringShape.new(name: 'S3BucketArn') S3Config = Shapes::StructureShape.new(name: 'S3Config') + S3ManifestConfig = Shapes::StructureShape.new(name: 'S3ManifestConfig') + S3ObjectVersionId = Shapes::StringShape.new(name: 'S3ObjectVersionId') S3StorageClass = Shapes::StringShape.new(name: 'S3StorageClass') S3Subdirectory = Shapes::StringShape.new(name: 'S3Subdirectory') ScheduleExpressionCron = Shapes::StringShape.new(name: 'ScheduleExpressionCron') @@ -272,6 +277,7 @@ module ClientApi SmbSubdirectory = Shapes::StringShape.new(name: 'SmbSubdirectory') SmbUser = Shapes::StringShape.new(name: 'SmbUser') SmbVersion = Shapes::StringShape.new(name: 'SmbVersion') + SourceManifestConfig = Shapes::StructureShape.new(name: 'SourceManifestConfig') SourceNetworkInterfaceArns = Shapes::ListShape.new(name: 'SourceNetworkInterfaceArns') StartDiscoveryJobRequest = Shapes::StructureShape.new(name: 'StartDiscoveryJobRequest') StartDiscoveryJobResponse = Shapes::StructureShape.new(name: 'StartDiscoveryJobResponse') @@ -528,6 +534,7 @@ module ClientApi CreateTaskRequest.add_member(:schedule, Shapes::ShapeRef.new(shape: TaskSchedule, location_name: "Schedule")) CreateTaskRequest.add_member(:tags, Shapes::ShapeRef.new(shape: InputTagList, location_name: "Tags")) CreateTaskRequest.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes")) + CreateTaskRequest.add_member(:manifest_config, Shapes::ShapeRef.new(shape: ManifestConfig, location_name: "ManifestConfig")) CreateTaskRequest.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig")) CreateTaskRequest.struct_class = Types::CreateTaskRequest @@ -754,14 +761,15 @@ module ClientApi DescribeTaskExecutionResponse.add_member(:options, Shapes::ShapeRef.new(shape: Options, location_name: "Options")) DescribeTaskExecutionResponse.add_member(:excludes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Excludes")) DescribeTaskExecutionResponse.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes")) + DescribeTaskExecutionResponse.add_member(:manifest_config, Shapes::ShapeRef.new(shape: ManifestConfig, location_name: "ManifestConfig")) DescribeTaskExecutionResponse.add_member(:start_time, Shapes::ShapeRef.new(shape: Time, location_name: "StartTime")) DescribeTaskExecutionResponse.add_member(:estimated_files_to_transfer, Shapes::ShapeRef.new(shape: long, location_name: "EstimatedFilesToTransfer")) DescribeTaskExecutionResponse.add_member(:estimated_bytes_to_transfer, Shapes::ShapeRef.new(shape: long, location_name: "EstimatedBytesToTransfer")) DescribeTaskExecutionResponse.add_member(:files_transferred, Shapes::ShapeRef.new(shape: long, location_name: "FilesTransferred")) DescribeTaskExecutionResponse.add_member(:bytes_written, Shapes::ShapeRef.new(shape: long, location_name: "BytesWritten")) DescribeTaskExecutionResponse.add_member(:bytes_transferred, Shapes::ShapeRef.new(shape: long, location_name: "BytesTransferred")) - DescribeTaskExecutionResponse.add_member(:result, Shapes::ShapeRef.new(shape: TaskExecutionResultDetail, location_name: "Result")) DescribeTaskExecutionResponse.add_member(:bytes_compressed, Shapes::ShapeRef.new(shape: long, location_name: "BytesCompressed")) + DescribeTaskExecutionResponse.add_member(:result, Shapes::ShapeRef.new(shape: TaskExecutionResultDetail, location_name: "Result")) DescribeTaskExecutionResponse.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig")) DescribeTaskExecutionResponse.add_member(:files_deleted, Shapes::ShapeRef.new(shape: long, location_name: "FilesDeleted")) DescribeTaskExecutionResponse.add_member(:files_skipped, Shapes::ShapeRef.new(shape: long, location_name: "FilesSkipped")) @@ -789,6 +797,7 @@ module ClientApi DescribeTaskResponse.add_member(:error_detail, Shapes::ShapeRef.new(shape: string, location_name: "ErrorDetail")) DescribeTaskResponse.add_member(:creation_time, Shapes::ShapeRef.new(shape: Time, location_name: "CreationTime")) DescribeTaskResponse.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes")) + DescribeTaskResponse.add_member(:manifest_config, Shapes::ShapeRef.new(shape: ManifestConfig, location_name: "ManifestConfig")) DescribeTaskResponse.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig")) DescribeTaskResponse.struct_class = Types::DescribeTaskResponse @@ -946,6 +955,11 @@ module ClientApi LocationListEntry.add_member(:location_uri, Shapes::ShapeRef.new(shape: LocationUri, location_name: "LocationUri")) LocationListEntry.struct_class = Types::LocationListEntry + ManifestConfig.add_member(:action, Shapes::ShapeRef.new(shape: ManifestAction, location_name: "Action")) + ManifestConfig.add_member(:format, Shapes::ShapeRef.new(shape: ManifestFormat, location_name: "Format")) + ManifestConfig.add_member(:source, Shapes::ShapeRef.new(shape: SourceManifestConfig, location_name: "Source")) + ManifestConfig.struct_class = Types::ManifestConfig + MaxP95Performance.add_member(:iops_read, Shapes::ShapeRef.new(shape: NonNegativeDouble, location_name: "IopsRead")) MaxP95Performance.add_member(:iops_write, Shapes::ShapeRef.new(shape: NonNegativeDouble, location_name: "IopsWrite")) MaxP95Performance.add_member(:iops_other, Shapes::ShapeRef.new(shape: NonNegativeDouble, location_name: "IopsOther")) @@ -1118,9 +1132,18 @@ module ClientApi S3Config.add_member(:bucket_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "BucketAccessRoleArn")) S3Config.struct_class = Types::S3Config + S3ManifestConfig.add_member(:manifest_object_path, Shapes::ShapeRef.new(shape: S3Subdirectory, required: true, location_name: "ManifestObjectPath")) + S3ManifestConfig.add_member(:bucket_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "BucketAccessRoleArn")) + S3ManifestConfig.add_member(:s3_bucket_arn, Shapes::ShapeRef.new(shape: S3BucketArn, required: true, location_name: "S3BucketArn")) + S3ManifestConfig.add_member(:manifest_object_version_id, Shapes::ShapeRef.new(shape: S3ObjectVersionId, location_name: "ManifestObjectVersionId")) + S3ManifestConfig.struct_class = Types::S3ManifestConfig + SmbMountOptions.add_member(:version, Shapes::ShapeRef.new(shape: SmbVersion, location_name: "Version")) SmbMountOptions.struct_class = Types::SmbMountOptions + SourceManifestConfig.add_member(:s3, Shapes::ShapeRef.new(shape: S3ManifestConfig, required: true, location_name: "S3")) + SourceManifestConfig.struct_class = Types::SourceManifestConfig + SourceNetworkInterfaceArns.member = Shapes::ShapeRef.new(shape: NetworkInterfaceArn) StartDiscoveryJobRequest.add_member(:storage_system_arn, Shapes::ShapeRef.new(shape: StorageSystemArn, required: true, location_name: "StorageSystemArn")) @@ -1136,8 +1159,9 @@ module ClientApi StartTaskExecutionRequest.add_member(:override_options, Shapes::ShapeRef.new(shape: Options, location_name: "OverrideOptions")) StartTaskExecutionRequest.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes")) StartTaskExecutionRequest.add_member(:excludes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Excludes")) - StartTaskExecutionRequest.add_member(:tags, Shapes::ShapeRef.new(shape: InputTagList, location_name: "Tags")) + StartTaskExecutionRequest.add_member(:manifest_config, Shapes::ShapeRef.new(shape: ManifestConfig, location_name: "ManifestConfig")) StartTaskExecutionRequest.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig")) + StartTaskExecutionRequest.add_member(:tags, Shapes::ShapeRef.new(shape: InputTagList, location_name: "Tags")) StartTaskExecutionRequest.struct_class = Types::StartTaskExecutionRequest StartTaskExecutionResponse.add_member(:task_execution_arn, Shapes::ShapeRef.new(shape: TaskExecutionArn, location_name: "TaskExecutionArn")) @@ -1313,6 +1337,7 @@ module ClientApi UpdateTaskRequest.add_member(:name, Shapes::ShapeRef.new(shape: TagValue, location_name: "Name")) UpdateTaskRequest.add_member(:cloud_watch_log_group_arn, Shapes::ShapeRef.new(shape: LogGroupArn, location_name: "CloudWatchLogGroupArn")) UpdateTaskRequest.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes")) + UpdateTaskRequest.add_member(:manifest_config, Shapes::ShapeRef.new(shape: ManifestConfig, location_name: "ManifestConfig")) UpdateTaskRequest.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig")) UpdateTaskRequest.struct_class = Types::UpdateTaskRequest diff --git a/gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb b/gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb index e9d32ee6dbe..7d64a50b51b 100644 --- a/gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb +++ b/gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb @@ -674,8 +674,9 @@ class CreateLocationFsxOpenZfsResponse < Struct.new( # @return [Array] # # @!attribute [rw] user - # Specifies the user who has the permissions to access files, folders, - # and metadata in your file system. + # 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][1] for FSx for Windows @@ -687,31 +688,18 @@ class CreateLocationFsxOpenZfsResponse < Struct.new( # @return [String] # # @!attribute [rw] domain - # Specifies the name of the Windows domain that the FSx for Windows - # File Server belongs to. + # Specifies the name of the Microsoft Active Directory domain that the + # FSx for Windows File Server file system 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][1] for FSx for - # Windows File Server locations. - # - # - # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions + # If you have multiple Active Directory domains in your environment, + # configuring this parameter makes sure that DataSync connects to the + # right file system. # @return [String] # # @!attribute [rw] password - # 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][1] for FSx for - # Windows File Server locations. - # - # - # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions + # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindowsRequest AWS API Documentation @@ -1048,49 +1036,73 @@ class CreateLocationObjectStorageResponse < Struct.new( # CreateLocationS3Request # # @!attribute [rw] subdirectory - # 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. + # 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: + # + # * `/photos` + # + # * `photos//2006/January` + # + # * `photos/./2006/February` + # + # * `photos/../2006/March` + # + # # @return [String] # # @!attribute [rw] s3_bucket_arn - # The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web - # Services Outpost, this must be an access point ARN. + # 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][1] in the + # *Amazon S3 User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html # @return [String] # # @!attribute [rw] s3_storage_class - # 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. + # 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 about S3 storage classes, see [Amazon S3 - # Storage Classes][1]. 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][2]. + # For more information, see [Storage class considerations with Amazon + # S3 transfers][1]. # # # - # [1]: http://aws.amazon.com/s3/storage-classes/ - # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes # @return [String] # # @!attribute [rw] s3_config - # The Amazon Resource Name (ARN) of the Identity and Access Management - # (IAM) role used to access an Amazon S3 bucket. + # 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][1]. # - # For detailed information about using such a role, see Creating a - # Location for Amazon S3 in the *DataSync User Guide*. + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access # @return [Types::S3Config] # # @!attribute [rw] agent_arns - # 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][1]. + # (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][1]. # # # @@ -1098,9 +1110,9 @@ class CreateLocationObjectStorageResponse < Struct.new( # @return [Array] # # @!attribute [rw] tags - # 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. + # 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. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationS3Request AWS API Documentation @@ -1119,8 +1131,7 @@ class CreateLocationS3Request < Struct.new( # CreateLocationS3Response # # @!attribute [rw] location_arn - # The Amazon Resource Name (ARN) of the source Amazon S3 bucket - # location that is created. + # The ARN of the S3 location that you created. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationS3Response AWS API Documentation @@ -1140,9 +1151,9 @@ class CreateLocationS3Response < Struct.new( # `/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][1] for SMB locations. + # 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][1] for SMB locations. # # # @@ -1159,9 +1170,8 @@ class CreateLocationS3Response < Struct.new( # @return [String] # # @!attribute [rw] user - # Specifies the user name that can mount your SMB file server and has - # permission to access the files and folders involved in your - # transfer. + # 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][1] for SMB locations. @@ -1172,19 +1182,12 @@ class CreateLocationS3Response < Struct.new( # @return [String] # # @!attribute [rw] domain - # Specifies the Windows domain name that your SMB file server belongs - # to. + # Specifies the name of the Active Directory domain 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][1] for SMB - # locations. - # - # - # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions + # If you have multiple Active Directory domains in your environment, + # configuring this parameter makes sure that DataSync connects to the + # right file server. # @return [String] # # @!attribute [rw] password @@ -1318,9 +1321,38 @@ class CreateLocationSmbResponse < Struct.new( # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html # @return [Array] # + # @!attribute [rw] manifest_config + # 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][1]. + # + # When using this parameter, your caller identity (the role that + # you're using DataSync with) must have the `iam:PassRole` + # permission. The [AWSDataSyncFullAccess][2] policy includes this + # permission. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + # @return [Types::ManifestConfig] + # # @!attribute [rw] task_report_config # Specifies how you want to configure a task report, which provides - # detailed information about for your DataSync transfer. + # detailed information about your DataSync transfer. For more + # information, see [Monitoring your DataSync transfers with task + # reports][1]. + # + # When using this parameter, your caller identity (the role that + # you're using DataSync with) must have the `iam:PassRole` + # permission. The [AWSDataSyncFullAccess][2] policy includes this + # permission. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess # @return [Types::TaskReportConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation @@ -1335,6 +1367,7 @@ class CreateTaskRequest < Struct.new( :schedule, :tags, :includes, + :manifest_config, :task_report_config) SENSITIVE = [] include Aws::Structure @@ -1876,8 +1909,8 @@ class DescribeLocationFsxOpenZfsResponse < Struct.new( end # @!attribute [rw] location_arn - # The Amazon Resource Name (ARN) of the FSx for Windows File Server - # location to describe. + # Specifies the Amazon Resource Name (ARN) of the FSx for Windows File + # Server location. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxWindowsRequest AWS API Documentation @@ -1889,18 +1922,17 @@ class DescribeLocationFsxWindowsRequest < Struct.new( end # @!attribute [rw] location_arn - # The Amazon Resource Name (ARN) of the FSx for Windows File Server - # location that was described. + # The ARN of the FSx for Windows File Server location. # @return [String] # # @!attribute [rw] location_uri - # The URL of the FSx for Windows File Server location that was - # described. + # The uniform resource identifier (URI) of the FSx for Windows File + # Server location. # @return [String] # # @!attribute [rw] security_group_arns - # The Amazon Resource Names (ARNs) of the security groups that are - # configured for the FSx for Windows File Server file system. + # The ARNs of the security groups that are configured for the FSx for + # Windows File Server file system. # @return [Array] # # @!attribute [rw] creation_time @@ -1908,13 +1940,13 @@ class DescribeLocationFsxWindowsRequest < Struct.new( # @return [Time] # # @!attribute [rw] user - # The user who has the permissions to access files and folders in the - # FSx for Windows File Server file system. + # The user with the permissions to mount and access the FSx for + # Windows File Server file system. # @return [String] # # @!attribute [rw] domain - # The name of the Windows domain that the FSx for Windows File Server - # belongs to. + # The name of the Microsoft Active Directory domain that the FSx for + # Windows File Server file system belongs to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxWindowsResponse AWS API Documentation @@ -1931,8 +1963,7 @@ class DescribeLocationFsxWindowsResponse < Struct.new( end # @!attribute [rw] location_arn - # The Amazon Resource Name (ARN) of the HDFS cluster location to - # describe. + # Specifies the Amazon Resource Name (ARN) of the HDFS location. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationHdfsRequest AWS API Documentation @@ -1944,15 +1975,15 @@ class DescribeLocationHdfsRequest < Struct.new( end # @!attribute [rw] location_arn - # The ARN of the HDFS cluster location. + # The ARN of the HDFS location. # @return [String] # # @!attribute [rw] location_uri - # The URI of the HDFS cluster location. + # The URI of the HDFS location. # @return [String] # # @!attribute [rw] name_nodes - # The NameNode that manage the HDFS namespace. + # The NameNode that manages the HDFS namespace. # @return [Array] # # @!attribute [rw] block_size @@ -1969,9 +2000,9 @@ class DescribeLocationHdfsRequest < Struct.new( # @return [String] # # @!attribute [rw] qop_configuration - # 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. + # The Quality of Protection (QOP) configuration, which specifies the + # Remote Procedure Call (RPC) and data transfer protection settings + # configured on the HDFS cluster. # @return [Types::QopConfiguration] # # @!attribute [rw] authentication_type @@ -1980,9 +2011,9 @@ class DescribeLocationHdfsRequest < Struct.new( # @return [String] # # @!attribute [rw] simple_user - # The user name used to identify the client on the host operating - # system. This parameter is used if the `AuthenticationType` is - # defined as `SIMPLE`. + # The user name to identify the client on the host operating system. + # This parameter is used if the `AuthenticationType` is defined as + # `SIMPLE`. # @return [String] # # @!attribute [rw] kerberos_principal @@ -1992,7 +2023,8 @@ class DescribeLocationHdfsRequest < Struct.new( # @return [String] # # @!attribute [rw] agent_arns - # The ARNs of the agents that are used to connect to the HDFS cluster. + # The ARNs of the DataSync agents that can connect with your HDFS + # cluster. # @return [Array] # # @!attribute [rw] creation_time @@ -2040,7 +2072,7 @@ class DescribeLocationNfsRequest < Struct.new( # @return [String] # # @!attribute [rw] location_uri - # The URL of the NFS location. + # The URI of the NFS location. # @return [String] # # @!attribute [rw] on_prem_config @@ -2071,8 +2103,8 @@ class DescribeLocationNfsResponse < Struct.new( # DescribeLocationObjectStorageRequest # # @!attribute [rw] location_arn - # The Amazon Resource Name (ARN) of the object storage system location - # that you want information about. + # Specifies the Amazon Resource Name (ARN) of the object storage + # system location. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationObjectStorageRequest AWS API Documentation @@ -2090,7 +2122,7 @@ class DescribeLocationObjectStorageRequest < Struct.new( # @return [String] # # @!attribute [rw] location_uri - # The URL of the object storage system location. + # The URI of the object storage system location. # @return [String] # # @!attribute [rw] access_key @@ -2108,8 +2140,8 @@ class DescribeLocationObjectStorageRequest < Struct.new( # @return [String] # # @!attribute [rw] agent_arns - # The ARNs of the DataSync agents that can securely connect with your - # location. + # The ARNs of the DataSync agents that can connect with your object + # storage system. # @return [Array] # # @!attribute [rw] creation_time @@ -2139,8 +2171,7 @@ class DescribeLocationObjectStorageResponse < Struct.new( # DescribeLocationS3Request # # @!attribute [rw] location_arn - # The Amazon Resource Name (ARN) of the Amazon S3 bucket location to - # describe. + # Specifies the Amazon Resource Name (ARN) of the Amazon S3 location. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3Request AWS API Documentation @@ -2154,8 +2185,7 @@ class DescribeLocationS3Request < Struct.new( # DescribeLocationS3Response # # @!attribute [rw] location_arn - # The Amazon Resource Name (ARN) of the Amazon S3 bucket or access - # point. + # The ARN of the Amazon S3 location. # @return [String] # # @!attribute [rw] location_uri @@ -2163,32 +2193,34 @@ class DescribeLocationS3Request < Struct.new( # @return [String] # # @!attribute [rw] s3_storage_class - # 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][1]. 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][2]. + # 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][1]. # # - # [1]: http://aws.amazon.com/s3/storage-classes/ - # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes # @return [String] # # @!attribute [rw] s3_config - # The Amazon Resource Name (ARN) of the Identity and Access Management - # (IAM) role used to access an Amazon S3 bucket. + # 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][1]. + # # - # For detailed information about using such a role, see Creating a - # Location for Amazon S3 in the *DataSync User Guide*. + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access # @return [Types::S3Config] # # @!attribute [rw] agent_arns - # 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 + # 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][1]. # # @@ -2197,7 +2229,7 @@ class DescribeLocationS3Request < Struct.new( # @return [Array] # # @!attribute [rw] creation_time - # The time that the Amazon S3 bucket location was created. + # The time that the Amazon S3 location was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3Response AWS API Documentation @@ -2216,7 +2248,8 @@ class DescribeLocationS3Response < Struct.new( # DescribeLocationSmbRequest # # @!attribute [rw] location_arn - # The Amazon Resource Name (ARN) of the SMB location to describe. + # Specifies the Amazon Resource Name (ARN) of the SMB location that + # you want information about. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationSmbRequest AWS API Documentation @@ -2230,31 +2263,30 @@ class DescribeLocationSmbRequest < Struct.new( # DescribeLocationSmbResponse # # @!attribute [rw] location_arn - # The Amazon Resource Name (ARN) of the SMB location that was - # described. + # The ARN of the SMB location. # @return [String] # # @!attribute [rw] location_uri - # The URL of the source SMB location that was described. + # The URI of the SMB location. # @return [String] # # @!attribute [rw] agent_arns - # The Amazon Resource Name (ARN) of the source SMB file system - # location that is created. + # The ARNs of the DataSync agents that can connect with your SMB file + # server. # @return [Array] # # @!attribute [rw] user - # The user who can mount the share, has the permissions to access - # files and folders in the SMB share. + # The user that can mount and access the files, folders, and file + # metadata in your SMB file server. # @return [String] # # @!attribute [rw] domain - # The name of the Windows domain that the SMB server belongs to. + # The name of the Microsoft Active Directory domain that the SMB file + # server belongs to. # @return [String] # # @!attribute [rw] mount_options - # The mount options that are available for DataSync to use to access - # an SMB location. + # The protocol that DataSync use to access your SMB file. # @return [Types::SmbMountOptions] # # @!attribute [rw] creation_time @@ -2571,6 +2603,16 @@ class DescribeTaskExecutionRequest < Struct.new( # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html # @return [Array] # + # @!attribute [rw] manifest_config + # 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][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # @return [Types::ManifestConfig] + # # @!attribute [rw] start_time # The time when the task execution started. # @return [Time] @@ -2612,19 +2654,24 @@ class DescribeTaskExecutionRequest < Struct.new( # number of bytes sent over the network, see `BytesCompressed`. # @return [Integer] # - # @!attribute [rw] result - # The result of the task execution. - # @return [Types::TaskExecutionResultDetail] - # # @!attribute [rw] bytes_compressed # 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. # @return [Integer] # + # @!attribute [rw] result + # The result of the task execution. + # @return [Types::TaskExecutionResultDetail] + # # @!attribute [rw] task_report_config # The configuration of your task report, which provides detailed - # information about for your DataSync transfer. + # information about for your DataSync transfer. For more information, + # see [Creating a task report][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html # @return [Types::TaskReportConfig] # # @!attribute [rw] files_deleted @@ -2686,14 +2733,15 @@ class DescribeTaskExecutionResponse < Struct.new( :options, :excludes, :includes, + :manifest_config, :start_time, :estimated_files_to_transfer, :estimated_bytes_to_transfer, :files_transferred, :bytes_written, :bytes_transferred, - :result, :bytes_compressed, + :result, :task_report_config, :files_deleted, :files_skipped, @@ -2831,9 +2879,20 @@ class DescribeTaskRequest < Struct.new( # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html # @return [Array] # + # @!attribute [rw] manifest_config + # 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][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # @return [Types::ManifestConfig] + # # @!attribute [rw] task_report_config - # The configuration of your task report. For more information, see - # [Creating a task report][1]. + # The configuration of your task report, which provides detailed + # information about for your DataSync transfer. For more information, + # see [Creating a task report][1]. # # # @@ -2859,6 +2918,7 @@ class DescribeTaskResponse < Struct.new( :error_detail, :creation_time, :includes, + :manifest_config, :task_report_config) SENSITIVE = [] include Aws::Structure @@ -3022,6 +3082,9 @@ class FsxProtocolNfs < Struct.new( # @!attribute [rw] domain # 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. # @return [String] # # @!attribute [rw] mount_options @@ -3035,37 +3098,15 @@ class FsxProtocolNfs < Struct.new( # @return [String] # # @!attribute [rw] user - # 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: - # - # * If you're using Directory Service for Microsoft Active Directory, - # the user must be a member of the Amazon Web Services Delegated FSx - # Administrators group. - # - # * If you're using a self-managed Active Directory, the user must be - # a member of either the Domain Admins group or a custom group that - # you specified for file system administration when you created your - # file system. - # - # Make sure that the user has the permissions it needs to copy the - # data you want: - # - # * `SE_TCB_NAME`: Required to set object ownership and file metadata. - # With this privilege, you also can copy NTFS discretionary access - # lists (DACLs). + # Specifies a user that can mount and access the files, folders, and + # metadata in your SVM. # - # * `SE_SECURITY_NAME`: May be needed to copy NTFS system access - # control lists (SACLs). This operation specifically requires the - # Windows privilege, which is granted to members of the Domain - # Admins group. If you configure your task to copy SACLs, make sure - # that the user has the required privileges. For information about - # copying SACLs, see [Ownership and permissions-related options][1]. + # For information about choosing a user with the right level of access + # for your transfer, see [Using the SMB protocol][1]. # # # - # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/FsxProtocolSmb AWS API Documentation @@ -3449,17 +3490,17 @@ class ListTagsForResourceResponse < Struct.new( # ListTaskExecutions # # @!attribute [rw] task_arn - # The Amazon Resource Name (ARN) of the task whose tasks you want to - # list. + # Specifies the Amazon Resource Name (ARN) of the task that you want + # execution information about. # @return [String] # # @!attribute [rw] max_results - # The maximum number of executed tasks to list. + # Specifies how many results you want in the response. # @return [Integer] # # @!attribute [rw] next_token - # An opaque string that indicates the position at which to begin the - # next list of the executed tasks. + # Specifies an opaque string that indicates the position at which to + # begin the next list of results in the response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutionsRequest AWS API Documentation @@ -3475,12 +3516,12 @@ class ListTaskExecutionsRequest < Struct.new( # ListTaskExecutionsResponse # # @!attribute [rw] task_executions - # A list of executed tasks. + # A list of the task's executions. # @return [Array] # # @!attribute [rw] next_token - # An opaque string that indicates the position at which to begin - # returning the next list of executed tasks. + # The opaque string that indicates the position to begin the next list + # of results in the response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutionsResponse AWS API Documentation @@ -3628,6 +3669,58 @@ class LocationListEntry < Struct.new( include Aws::Structure end + # 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][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # + # @!attribute [rw] action + # Specifies what DataSync uses the manifest for. + # @return [String] + # + # @!attribute [rw] format + # Specifies the file format of your manifest. For more information, + # see [Creating a manifest][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create + # @return [String] + # + # @!attribute [rw] source + # 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][1]. + # + # + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access + # @return [Types::SourceManifestConfig] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ManifestConfig AWS API Documentation + # + class ManifestConfig < Struct.new( + :action, + :format, + :source) + SENSITIVE = [] + include Aws::Structure + end + # The performance data that DataSync Discovery collects about an # on-premises storage system resource. # @@ -4039,30 +4132,28 @@ class OnPremConfig < Struct.new( # 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. # - # `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][1]. # - # 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][1]. + # * `POINT_IN_TIME_CONSISTENT` (default) - At the end of the transfer, + # DataSync scans the entire source and destination to verify that + # both locations are fully synchronized. # - # `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][1]. # - # 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][1]. - # - # `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. + # * `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. # # # @@ -4070,17 +4161,21 @@ class OnPremConfig < Struct.new( # @return [String] # # @!attribute [rw] overwrite_mode - # 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. + # Specifies whether DataSync should modify or preserve data at the + # destination location. + # + # * `ALWAYS` (default) - DataSync modifies 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][1]. # - # 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][1]. + # * `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 files or + # objects in the destination. # # # @@ -4089,22 +4184,19 @@ class OnPremConfig < Struct.new( # # @!attribute [rw] atime # 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). + # 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. # # # - # Default value: `BEST_EFFORT` + # * `BEST_EFFORT` (default) - DataSync attempts to preserve the + # original `Atime` attribute on all source files (that is, the + # version before the `PREPARING` phase of the task execution). This + # option is recommended. # - # `BEST_EFFORT`: Attempt to preserve the per-file `Atime` value - # (recommended). - # - # `NONE`: Ignore `Atime`. + # * `NONE` - Ignores `Atime`. # # If `Atime` is set to `BEST_EFFORT`, `Mtime` must be set to # `PRESERVE`. @@ -4120,11 +4212,10 @@ class OnPremConfig < Struct.new( # execution. This option is required when you need to run the a task # more than once. # - # Default Value: `PRESERVE` - # - # `PRESERVE`: Preserve original `Mtime` (recommended) + # * `PRESERVE` (default) - Preserves original `Mtime`, which is + # recommended. # - # `NONE`: Ignore `Mtime`. + # * `NONE` - Ignores `Mtime`. # # If `Mtime` is set to `PRESERVE`, `Atime` must be set to # `BEST_EFFORT`. @@ -4137,15 +4228,12 @@ class OnPremConfig < Struct.new( # @!attribute [rw] uid # Specifies the POSIX user ID (UID) of the file's owner. # - # For more information, see [Metadata copied by DataSync][1]. + # * `INT_VALUE` (default) - Preserves the integer value of UID and + # group ID (GID), which is recommended. # - # Default value: `INT_VALUE`. This preserves the integer value of the - # ID. + # * `NONE` - Ignores UID and GID. # - # `INT_VALUE`: Preserve the integer value of UID and group ID (GID) - # (recommended). - # - # `NONE`: Ignore UID and GID. + # For more information, see [Metadata copied by DataSync][1]. # # # @@ -4155,15 +4243,12 @@ class OnPremConfig < Struct.new( # @!attribute [rw] gid # Specifies the POSIX group ID (GID) of the file's owners. # - # For more information, see [Metadata copied by DataSync][1]. - # - # Default value: `INT_VALUE`. This preserves the integer value of the - # ID. + # * `INT_VALUE` (default) - Preserves the integer value of user ID + # (UID) and GID, which is recommended. # - # `INT_VALUE`: Preserve the integer value of user ID (UID) and GID - # (recommended). + # * `NONE` - Ignores UID and GID. # - # `NONE`: Ignore UID and GID. + # For more information, see [Metadata copied by DataSync][1]. # # # @@ -4178,12 +4263,11 @@ class OnPremConfig < Struct.new( # For detailed information, see [Considerations when working with # Amazon S3 storage classes in DataSync][1]. # - # Default value: `PRESERVE` - # - # `PRESERVE`: Ignore such destination files (recommended). + # * `PRESERVE` (default) - Ignores such destination files, which is + # recommended. # - # `REMOVE`: Delete destination files that aren’t present in the - # source. + # * `REMOVE` - Deletes 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 @@ -4207,12 +4291,10 @@ class OnPremConfig < Struct.new( # # # - # Default value: `NONE` + # * `NONE` (default) - Ignores special devices (recommended). # - # `NONE`: Ignore special devices (recommended). - # - # `PRESERVE`: Preserve character and block device metadata. This - # option currently isn't supported for Amazon EFS. + # * `PRESERVE` - Preserves character and block device metadata. This + # option currently isn't supported for Amazon EFS. # @return [String] # # @!attribute [rw] posix_permissions @@ -4221,11 +4303,10 @@ class OnPremConfig < Struct.new( # # For more information, see [Metadata copied by DataSync][1]. # - # Default value: `PRESERVE` - # - # `PRESERVE`: Preserve POSIX-style permissions (recommended). + # * `PRESERVE` (default) - Preserves POSIX-style permissions, which is + # recommended. # - # `NONE`: Ignore permissions. + # * `NONE` - Ignores POSIX-style permissions. # # DataSync can preserve extant permissions of a source location. # @@ -4257,10 +4338,13 @@ class OnPremConfig < Struct.new( # CloudWatch Logs log group. To specify the log group, see # [CloudWatchLogGroupArn][1]. # - # 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. + # * `BASIC` - Publishes logs with only basic information (such as + # transfer errors). + # + # * `TRANSFER` - Publishes logs for all files or objects that your + # DataSync task transfers and performs data-integrity checks on. + # + # * `OFF` - No logs are published. # # # @@ -4273,12 +4357,12 @@ class OnPremConfig < Struct.new( # 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. + # * `CHANGED` (default) - 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). + # * `ALL` - DataSync copies everything in the source to the + # destination without comparing differences between the locations. # @return [String] # # @!attribute [rw] security_descriptor_copy_flags @@ -4290,52 +4374,53 @@ class OnPremConfig < Struct.new( # Server locations. For more information, see [how DataSync handles # metadata][1]. # - # Default value: `OWNER_DACL` - # - # `OWNER_DACL`: For each copied object, DataSync copies the following - # metadata: + # * `OWNER_DACL` (default) - For each copied object, DataSync copies + # the following metadata: # - # * The object owner. + # * The object owner. # - # * NTFS discretionary access control lists (DACLs), which determine - # whether to grant access to an object. + # * 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. + # 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: + # * `OWNER_DACL_SACL` - For each copied object, DataSync copies the + # following metadata: # - # * The object owner. + # * The object owner. # - # * NTFS discretionary access control lists (DACLs), which determine - # whether to grant access to an object. + # * 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. + # * 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 that ensures sufficient - # permissions to files, folders, and metadata, see - # [user](create-smb-location.html#SMBuser). + # 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][2], [FSx for Windows File + # Server][3], or [FSx for ONTAP][4] (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 configuration. + # * `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. # # # # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions + # [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions + # [4]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb # @return [String] # # @!attribute [rw] object_tags - # 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` + # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Options AWS API Documentation @@ -4397,16 +4482,17 @@ class P95Metrics < Struct.new( # @!attribute [rw] version # 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][1] those agents before then to avoid - # data transfer or storage discovery disruptions. If you need more - # help, contact [Amazon Web Services Support][2]. + # 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][1] those agents or [delete][2] them if they + # aren't in use. If you need more help, contact [Amazon Web Services + # Support][3]. # # # # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html - # [2]: https://aws.amazon.com/contact-us/ + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/deleting-agent.html + # [3]: https://aws.amazon.com/contact-us/ # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Platform AWS API Documentation @@ -4582,7 +4668,7 @@ class ReportDestination < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/task-reports.html + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportDestinationS3 AWS API Documentation @@ -4769,14 +4855,18 @@ class ResourceMetrics < Struct.new( include Aws::Structure end - # The Amazon Resource Name (ARN) of the Identity and Access Management - # (IAM) role used to access an Amazon S3 bucket. + # 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][1]. # - # For detailed information about using such a role, see Creating a - # Location for Amazon S3 in the *DataSync User Guide*. + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access # # @!attribute [rw] bucket_access_role_arn - # The ARN of the IAM role for accessing the S3 bucket. + # Specifies the ARN of the IAM role that DataSync uses to access your + # S3 bucket. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3Config AWS API Documentation @@ -4787,6 +4877,51 @@ class S3Config < Struct.new( include Aws::Structure end + # 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][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # + # @!attribute [rw] manifest_object_path + # Specifies the Amazon S3 object key of your manifest. This can + # include a prefix (for example, `prefix/my-manifest.csv`). + # @return [String] + # + # @!attribute [rw] bucket_access_role_arn + # 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][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access + # @return [String] + # + # @!attribute [rw] s3_bucket_arn + # Specifies the Amazon Resource Name (ARN) of the S3 bucket where + # you're hosting your manifest. + # @return [String] + # + # @!attribute [rw] manifest_object_version_id + # 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. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3ManifestConfig AWS API Documentation + # + class S3ManifestConfig < Struct.new( + :manifest_object_path, + :bucket_access_role_arn, + :s3_bucket_arn, + :manifest_object_version_id) + SENSITIVE = [] + include Aws::Structure + end + # Specifies the version of the Server Message Block (SMB) protocol that # DataSync uses to access an SMB file server. # @@ -4837,6 +4972,26 @@ class SmbMountOptions < Struct.new( include Aws::Structure end + # 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][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # + # @!attribute [rw] s3 + # Specifies the S3 bucket where you're hosting your manifest. + # @return [Types::S3ManifestConfig] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/SourceManifestConfig AWS API Documentation + # + class SourceManifestConfig < Struct.new( + :s3) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] storage_system_arn # Specifies the Amazon Resource Name (ARN) of the on-premises storage # system that you want to run the discovery job on. @@ -4923,6 +5078,46 @@ class StartDiscoveryJobResponse < Struct.new( # "\|" (that is, a pipe), for example, `"/folder1|/folder2"`. # @return [Array] # + # @!attribute [rw] manifest_config + # 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][1]. + # + # When using this parameter, your caller identity (the role that + # you're using DataSync with) must have the `iam:PassRole` + # permission. The [AWSDataSyncFullAccess][2] policy includes this + # permission. + # + # To remove a manifest configuration, specify this parameter with an + # empty value. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + # @return [Types::ManifestConfig] + # + # @!attribute [rw] task_report_config + # 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][1]. + # + # When using this parameter, your caller identity (the role that + # you're using DataSync with) must have the `iam:PassRole` + # permission. The [AWSDataSyncFullAccess][2] policy includes this + # permission. + # + # To remove a task report configuration, specify this parameter as + # empty. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + # @return [Types::TaskReportConfig] + # # @!attribute [rw] tags # Specifies the tags that you want to apply to the Amazon Resource # Name (ARN) representing the task execution. @@ -4931,11 +5126,6 @@ class StartDiscoveryJobResponse < Struct.new( # for your DataSync resources. # @return [Array] # - # @!attribute [rw] task_report_config - # Specifies how you want to configure a task report, which provides - # detailed information about for your DataSync transfer. - # @return [Types::TaskReportConfig] - # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionRequest AWS API Documentation # class StartTaskExecutionRequest < Struct.new( @@ -4943,8 +5133,9 @@ class StartTaskExecutionRequest < Struct.new( :override_options, :includes, :excludes, - :tags, - :task_report_config) + :manifest_config, + :task_report_config, + :tags) SENSITIVE = [] include Aws::Structure end @@ -5046,21 +5237,24 @@ class TagResourceRequest < Struct.new( # class TagResourceResponse < Aws::EmptyStructure; end - # 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][1] - # operation is called. + # Represents a single entry in a list of DataSync task executions + # that's returned with the [ListTaskExecutions][1] operation. # # # # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html # # @!attribute [rw] task_execution_arn - # The Amazon Resource Name (ARN) of the task that was executed. + # The Amazon Resource Name (ARN) of a task execution. # @return [String] # # @!attribute [rw] status - # The status of a task execution. + # The status of a task execution. For more information, see [Task + # execution statuses][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-execution-statuses # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionListEntry AWS API Documentation @@ -5903,9 +6097,43 @@ class UpdateTaskExecutionResponse < Aws::EmptyStructure; end # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html # @return [Array] # + # @!attribute [rw] manifest_config + # 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][1]. + # + # When using this parameter, your caller identity (the IAM role that + # you're using DataSync with) must have the `iam:PassRole` + # permission. The [AWSDataSyncFullAccess][2] policy includes this + # permission. + # + # To remove a manifest configuration, specify this parameter as empty. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + # @return [Types::ManifestConfig] + # # @!attribute [rw] task_report_config # Specifies how you want to configure a task report, which provides - # detailed information about for your DataSync transfer. + # detailed information about your DataSync transfer. For more + # information, see [Monitoring your DataSync transfers with task + # reports][1]. + # + # When using this parameter, your caller identity (the IAM role that + # you're using DataSync with) must have the `iam:PassRole` + # permission. The [AWSDataSyncFullAccess][2] policy includes this + # permission. + # + # To remove a task report configuration, specify this parameter as + # empty. + # + # + # + # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html + # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess # @return [Types::TaskReportConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskRequest AWS API Documentation @@ -5918,6 +6146,7 @@ class UpdateTaskRequest < Struct.new( :name, :cloud_watch_log_group_arn, :includes, + :manifest_config, :task_report_config) SENSITIVE = [] include Aws::Structure diff --git a/gems/aws-sdk-datasync/sig/client.rbs b/gems/aws-sdk-datasync/sig/client.rbs index 11a3e46333c..d0de8122bd7 100644 --- a/gems/aws-sdk-datasync/sig/client.rbs +++ b/gems/aws-sdk-datasync/sig/client.rbs @@ -459,6 +459,18 @@ module Aws value: ::String? }, ], + ?manifest_config: { + action: ("TRANSFER")?, + format: ("CSV")?, + source: { + s3: { + manifest_object_path: ::String, + bucket_access_role_arn: ::String, + s3_bucket_arn: ::String, + manifest_object_version_id: ::String? + } + }? + }, ?task_report_config: { destination: { s3: { @@ -790,6 +802,7 @@ module Aws def error_detail: () -> ::String def creation_time: () -> ::Time def includes: () -> ::Array[Types::FilterRule] + def manifest_config: () -> Types::ManifestConfig def task_report_config: () -> Types::TaskReportConfig end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataSync/Client.html#describe_task-instance_method @@ -805,14 +818,15 @@ module Aws def options: () -> Types::Options def excludes: () -> ::Array[Types::FilterRule] def includes: () -> ::Array[Types::FilterRule] + def manifest_config: () -> Types::ManifestConfig def start_time: () -> ::Time def estimated_files_to_transfer: () -> ::Integer def estimated_bytes_to_transfer: () -> ::Integer def files_transferred: () -> ::Integer def bytes_written: () -> ::Integer def bytes_transferred: () -> ::Integer - def result: () -> Types::TaskExecutionResultDetail def bytes_compressed: () -> ::Integer + def result: () -> Types::TaskExecutionResultDetail def task_report_config: () -> Types::TaskReportConfig def files_deleted: () -> ::Integer def files_skipped: () -> ::Integer @@ -1001,12 +1015,18 @@ module Aws value: ::String? }, ], - ?tags: Array[ - { - key: ::String, - value: ::String? - }, - ], + ?manifest_config: { + action: ("TRANSFER")?, + format: ("CSV")?, + source: { + s3: { + manifest_object_path: ::String, + bucket_access_role_arn: ::String, + s3_bucket_arn: ::String, + manifest_object_version_id: ::String? + } + }? + }, ?task_report_config: { destination: { s3: { @@ -1032,7 +1052,13 @@ module Aws report_level: ("ERRORS_ONLY" | "SUCCESSES_AND_ERRORS")? }? }? - } + }, + ?tags: Array[ + { + key: ::String, + value: ::String? + }, + ] ) -> _StartTaskExecutionResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartTaskExecutionResponseSuccess @@ -1245,6 +1271,18 @@ module Aws value: ::String? }, ], + ?manifest_config: { + action: ("TRANSFER")?, + format: ("CSV")?, + source: { + s3: { + manifest_object_path: ::String, + bucket_access_role_arn: ::String, + s3_bucket_arn: ::String, + manifest_object_version_id: ::String? + } + }? + }, ?task_report_config: { destination: { s3: { diff --git a/gems/aws-sdk-datasync/sig/types.rbs b/gems/aws-sdk-datasync/sig/types.rbs index d2a5002cf21..bba40bded66 100644 --- a/gems/aws-sdk-datasync/sig/types.rbs +++ b/gems/aws-sdk-datasync/sig/types.rbs @@ -256,6 +256,7 @@ module Aws::DataSync attr_accessor schedule: Types::TaskSchedule attr_accessor tags: ::Array[Types::TagListEntry] attr_accessor includes: ::Array[Types::FilterRule] + attr_accessor manifest_config: Types::ManifestConfig attr_accessor task_report_config: Types::TaskReportConfig SENSITIVE: [] end @@ -563,14 +564,15 @@ module Aws::DataSync attr_accessor options: Types::Options attr_accessor excludes: ::Array[Types::FilterRule] attr_accessor includes: ::Array[Types::FilterRule] + attr_accessor manifest_config: Types::ManifestConfig attr_accessor start_time: ::Time attr_accessor estimated_files_to_transfer: ::Integer attr_accessor estimated_bytes_to_transfer: ::Integer attr_accessor files_transferred: ::Integer attr_accessor bytes_written: ::Integer attr_accessor bytes_transferred: ::Integer - attr_accessor result: Types::TaskExecutionResultDetail attr_accessor bytes_compressed: ::Integer + attr_accessor result: Types::TaskExecutionResultDetail attr_accessor task_report_config: Types::TaskReportConfig attr_accessor files_deleted: ::Integer attr_accessor files_skipped: ::Integer @@ -602,6 +604,7 @@ module Aws::DataSync attr_accessor error_detail: ::String attr_accessor creation_time: ::Time attr_accessor includes: ::Array[Types::FilterRule] + attr_accessor manifest_config: Types::ManifestConfig attr_accessor task_report_config: Types::TaskReportConfig SENSITIVE: [] end @@ -795,6 +798,13 @@ module Aws::DataSync SENSITIVE: [] end + class ManifestConfig + attr_accessor action: ("TRANSFER") + attr_accessor format: ("CSV") + attr_accessor source: Types::SourceManifestConfig + SENSITIVE: [] + end + class MaxP95Performance attr_accessor iops_read: ::Float attr_accessor iops_write: ::Float @@ -986,11 +996,24 @@ module Aws::DataSync SENSITIVE: [] end + class S3ManifestConfig + attr_accessor manifest_object_path: ::String + attr_accessor bucket_access_role_arn: ::String + attr_accessor s3_bucket_arn: ::String + attr_accessor manifest_object_version_id: ::String + SENSITIVE: [] + end + class SmbMountOptions attr_accessor version: ("AUTOMATIC" | "SMB2" | "SMB3" | "SMB1" | "SMB2_0") SENSITIVE: [] end + class SourceManifestConfig + attr_accessor s3: Types::S3ManifestConfig + SENSITIVE: [] + end + class StartDiscoveryJobRequest attr_accessor storage_system_arn: ::String attr_accessor collection_duration_minutes: ::Integer @@ -1009,8 +1032,9 @@ module Aws::DataSync attr_accessor override_options: Types::Options attr_accessor includes: ::Array[Types::FilterRule] attr_accessor excludes: ::Array[Types::FilterRule] - attr_accessor tags: ::Array[Types::TagListEntry] + attr_accessor manifest_config: Types::ManifestConfig attr_accessor task_report_config: Types::TaskReportConfig + attr_accessor tags: ::Array[Types::TagListEntry] SENSITIVE: [] end @@ -1234,6 +1258,7 @@ module Aws::DataSync attr_accessor name: ::String attr_accessor cloud_watch_log_group_arn: ::String attr_accessor includes: ::Array[Types::FilterRule] + attr_accessor manifest_config: Types::ManifestConfig attr_accessor task_report_config: Types::TaskReportConfig SENSITIVE: [] end diff --git a/gems/aws-sdk-lexmodelsv2/CHANGELOG.md b/gems/aws-sdk-lexmodelsv2/CHANGELOG.md index b91961c0ab8..859f21273fc 100644 --- a/gems/aws-sdk-lexmodelsv2/CHANGELOG.md +++ b/gems/aws-sdk-lexmodelsv2/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.48.0 (2024-02-07) +------------------ + +* Feature - This release introduces a new bot replication feature as part of Lex Global Resiliency offering. This feature leverages a new set of APIs that allow customers to create bot replicas and replicate changes to bots across regions. + 1.47.0 (2024-01-26) ------------------ diff --git a/gems/aws-sdk-lexmodelsv2/VERSION b/gems/aws-sdk-lexmodelsv2/VERSION index 21998d3c2d9..9db5ea12f52 100644 --- a/gems/aws-sdk-lexmodelsv2/VERSION +++ b/gems/aws-sdk-lexmodelsv2/VERSION @@ -1 +1 @@ -1.47.0 +1.48.0 diff --git a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2.rb b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2.rb index c3203d5b049..1196a0e4bae 100644 --- a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2.rb +++ b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2.rb @@ -53,6 +53,6 @@ # @!group service module Aws::LexModelsV2 - GEM_VERSION = '1.47.0' + GEM_VERSION = '1.48.0' end diff --git a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb index f405500a17d..128a09e41cb 100644 --- a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb +++ b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client.rb @@ -1061,6 +1061,49 @@ def create_bot_locale(params = {}, options = {}) req.send_request(options) end + # Action to create a replication of the source bot in the secondary + # region. + # + # @option params [required, String] :bot_id + # The request for the unique bot ID of the source bot to be replicated + # in the secondary region. + # + # @option params [required, String] :replica_region + # The request for the secondary region that will be used in the + # replication of the source bot. + # + # @return [Types::CreateBotReplicaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::CreateBotReplicaResponse#bot_id #bot_id} => String + # * {Types::CreateBotReplicaResponse#replica_region #replica_region} => String + # * {Types::CreateBotReplicaResponse#source_region #source_region} => String + # * {Types::CreateBotReplicaResponse#creation_date_time #creation_date_time} => Time + # * {Types::CreateBotReplicaResponse#bot_replica_status #bot_replica_status} => String + # + # @example Request syntax with placeholder values + # + # resp = client.create_bot_replica({ + # bot_id: "Id", # required + # replica_region: "ReplicaRegion", # required + # }) + # + # @example Response structure + # + # resp.bot_id #=> String + # resp.replica_region #=> String + # resp.source_region #=> String + # resp.creation_date_time #=> Time + # resp.bot_replica_status #=> String, one of "Enabling", "Enabled", "Deleting", "Failed" + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotReplica AWS API Documentation + # + # @overload create_bot_replica(params = {}) + # @param [Hash] params ({}) + def create_bot_replica(params = {}, options = {}) + req = build_request(:create_bot_replica, params) + req.send_request(options) + end + # Creates an immutable version of the bot. When you create the first # version of a bot, Amazon Lex sets the version number to 1. Subsequent # bot versions increase in an increment of 1. The version number will @@ -2715,6 +2758,43 @@ def delete_bot_locale(params = {}, options = {}) req.send_request(options) end + # The action to delete the replicated bot in the secondary region. + # + # @option params [required, String] :bot_id + # The unique ID of the replicated bot to be deleted from the secondary + # region + # + # @option params [required, String] :replica_region + # The secondary region of the replicated bot that will be deleted. + # + # @return [Types::DeleteBotReplicaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::DeleteBotReplicaResponse#bot_id #bot_id} => String + # * {Types::DeleteBotReplicaResponse#replica_region #replica_region} => String + # * {Types::DeleteBotReplicaResponse#bot_replica_status #bot_replica_status} => String + # + # @example Request syntax with placeholder values + # + # resp = client.delete_bot_replica({ + # bot_id: "Id", # required + # replica_region: "ReplicaRegion", # required + # }) + # + # @example Response structure + # + # resp.bot_id #=> String + # resp.replica_region #=> String + # resp.bot_replica_status #=> String, one of "Enabling", "Enabled", "Deleting", "Failed" + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotReplica AWS API Documentation + # + # @overload delete_bot_replica(params = {}) + # @param [Hash] params ({}) + def delete_bot_replica(params = {}, options = {}) + req = build_request(:delete_bot_replica, params) + req.send_request(options) + end + # Deletes a specific version of a bot. To delete all versions of a bot, # use the [DeleteBot][1] operation. # @@ -3491,6 +3571,50 @@ def describe_bot_recommendation(params = {}, options = {}) req.send_request(options) end + # Monitors the bot replication status through the UI console. + # + # @option params [required, String] :bot_id + # The request for the unique bot ID of the replicated bot being + # monitored. + # + # @option params [required, String] :replica_region + # The request for the region of the replicated bot being monitored. + # + # @return [Types::DescribeBotReplicaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::DescribeBotReplicaResponse#bot_id #bot_id} => String + # * {Types::DescribeBotReplicaResponse#replica_region #replica_region} => String + # * {Types::DescribeBotReplicaResponse#source_region #source_region} => String + # * {Types::DescribeBotReplicaResponse#creation_date_time #creation_date_time} => Time + # * {Types::DescribeBotReplicaResponse#bot_replica_status #bot_replica_status} => String + # * {Types::DescribeBotReplicaResponse#failure_reasons #failure_reasons} => Array<String> + # + # @example Request syntax with placeholder values + # + # resp = client.describe_bot_replica({ + # bot_id: "Id", # required + # replica_region: "ReplicaRegion", # required + # }) + # + # @example Response structure + # + # resp.bot_id #=> String + # resp.replica_region #=> String + # resp.source_region #=> String + # resp.creation_date_time #=> Time + # resp.bot_replica_status #=> String, one of "Enabling", "Enabled", "Deleting", "Failed" + # resp.failure_reasons #=> Array + # resp.failure_reasons[0] #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotReplica AWS API Documentation + # + # @overload describe_bot_replica(params = {}) + # @param [Hash] params ({}) + def describe_bot_replica(params = {}, options = {}) + req = build_request(:describe_bot_replica, params) + req.send_request(options) + end + # Returns information about a request to generate a bot through natural # language description, made through the `StartBotResource` API. Use the # `generatedBotLocaleUrl` to retrieve the Amazon S3 object containing @@ -5200,6 +5324,68 @@ def list_aggregated_utterances(params = {}, options = {}) req.send_request(options) end + # The action to list the replicated bots created from the source bot + # alias. + # + # @option params [required, String] :bot_id + # The request for the unique bot ID of the replicated bot created from + # the source bot alias. + # + # @option params [required, String] :replica_region + # The request for the secondary region of the replicated bot created + # from the source bot alias. + # + # @option params [Integer] :max_results + # The request for maximum results to list the replicated bots created + # from the source bot alias. + # + # @option params [String] :next_token + # The request for the next token for the replicated bot created from the + # source bot alias. + # + # @return [Types::ListBotAliasReplicasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListBotAliasReplicasResponse#bot_id #bot_id} => String + # * {Types::ListBotAliasReplicasResponse#source_region #source_region} => String + # * {Types::ListBotAliasReplicasResponse#replica_region #replica_region} => String + # * {Types::ListBotAliasReplicasResponse#bot_alias_replica_summaries #bot_alias_replica_summaries} => Array<Types::BotAliasReplicaSummary> + # * {Types::ListBotAliasReplicasResponse#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_bot_alias_replicas({ + # bot_id: "Id", # required + # replica_region: "ReplicaRegion", # required + # max_results: 1, + # next_token: "NextToken", + # }) + # + # @example Response structure + # + # resp.bot_id #=> String + # resp.source_region #=> String + # resp.replica_region #=> String + # resp.bot_alias_replica_summaries #=> Array + # resp.bot_alias_replica_summaries[0].bot_alias_id #=> String + # resp.bot_alias_replica_summaries[0].bot_alias_replication_status #=> String, one of "Creating", "Updating", "Available", "Deleting", "Failed" + # resp.bot_alias_replica_summaries[0].bot_version #=> String + # resp.bot_alias_replica_summaries[0].creation_date_time #=> Time + # resp.bot_alias_replica_summaries[0].last_updated_date_time #=> Time + # resp.bot_alias_replica_summaries[0].failure_reasons #=> Array + # resp.bot_alias_replica_summaries[0].failure_reasons[0] #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotAliasReplicas AWS API Documentation + # + # @overload list_bot_alias_replicas(params = {}) + # @param [Hash] params ({}) + def list_bot_alias_replicas(params = {}, options = {}) + req = build_request(:list_bot_alias_replicas, params) + req.send_request(options) + end + # Gets a list of aliases for the specified bot. # # @option params [required, String] :bot_id @@ -5398,6 +5584,43 @@ def list_bot_recommendations(params = {}, options = {}) req.send_request(options) end + # The action to list the replicated bots. + # + # @option params [required, String] :bot_id + # The request for the unique bot IDs in the list of replicated bots. + # + # @return [Types::ListBotReplicasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListBotReplicasResponse#bot_id #bot_id} => String + # * {Types::ListBotReplicasResponse#source_region #source_region} => String + # * {Types::ListBotReplicasResponse#bot_replica_summaries #bot_replica_summaries} => Array<Types::BotReplicaSummary> + # + # @example Request syntax with placeholder values + # + # resp = client.list_bot_replicas({ + # bot_id: "Id", # required + # }) + # + # @example Response structure + # + # resp.bot_id #=> String + # resp.source_region #=> String + # resp.bot_replica_summaries #=> Array + # resp.bot_replica_summaries[0].replica_region #=> String + # resp.bot_replica_summaries[0].creation_date_time #=> Time + # resp.bot_replica_summaries[0].bot_replica_status #=> String, one of "Enabling", "Enabled", "Deleting", "Failed" + # resp.bot_replica_summaries[0].failure_reasons #=> Array + # resp.bot_replica_summaries[0].failure_reasons[0] #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotReplicas AWS API Documentation + # + # @overload list_bot_replicas(params = {}) + # @param [Hash] params ({}) + def list_bot_replicas(params = {}, options = {}) + req = build_request(:list_bot_replicas, params) + req.send_request(options) + end + # Lists the generation requests made for a bot locale. # # @option params [required, String] :bot_id @@ -5468,6 +5691,69 @@ def list_bot_resource_generations(params = {}, options = {}) req.send_request(options) end + # Contains information about all the versions replication statuses + # applicable for Global Resiliency. + # + # @option params [required, String] :bot_id + # The request for the unique ID in the list of replicated bots. + # + # @option params [required, String] :replica_region + # The request for the region used in the list of replicated bots. + # + # @option params [Integer] :max_results + # The maximum results given in the list of replicated bots. + # + # @option params [String] :next_token + # The next token given in the list of replicated bots. + # + # @option params [Types::BotVersionReplicaSortBy] :sort_by + # The requested sort category for the list of replicated bots. + # + # @return [Types::ListBotVersionReplicasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListBotVersionReplicasResponse#bot_id #bot_id} => String + # * {Types::ListBotVersionReplicasResponse#source_region #source_region} => String + # * {Types::ListBotVersionReplicasResponse#replica_region #replica_region} => String + # * {Types::ListBotVersionReplicasResponse#bot_version_replica_summaries #bot_version_replica_summaries} => Array<Types::BotVersionReplicaSummary> + # * {Types::ListBotVersionReplicasResponse#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_bot_version_replicas({ + # bot_id: "Id", # required + # replica_region: "ReplicaRegion", # required + # max_results: 1, + # next_token: "NextToken", + # sort_by: { + # attribute: "BotVersion", # required, accepts BotVersion + # order: "Ascending", # required, accepts Ascending, Descending + # }, + # }) + # + # @example Response structure + # + # resp.bot_id #=> String + # resp.source_region #=> String + # resp.replica_region #=> String + # resp.bot_version_replica_summaries #=> Array + # resp.bot_version_replica_summaries[0].bot_version #=> String + # resp.bot_version_replica_summaries[0].bot_version_replication_status #=> String, one of "Creating", "Available", "Deleting", "Failed" + # resp.bot_version_replica_summaries[0].creation_date_time #=> Time + # resp.bot_version_replica_summaries[0].failure_reasons #=> Array + # resp.bot_version_replica_summaries[0].failure_reasons[0] #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotVersionReplicas AWS API Documentation + # + # @overload list_bot_version_replicas(params = {}) + # @param [Hash] params ({}) + def list_bot_version_replicas(params = {}, options = {}) + req = build_request(:list_bot_version_replicas, params) + req.send_request(options) + end + # Gets information about all of the versions of a bot. # # The `ListBotVersions` operation returns a summary of each version of a @@ -10055,7 +10341,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-lexmodelsv2' - context[:gem_version] = '1.47.0' + context[:gem_version] = '1.48.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client_api.rb b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client_api.rb index 2a10fb9dcc8..f03579daedb 100644 --- a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client_api.rb +++ b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/client_api.rb @@ -153,6 +153,9 @@ module ClientApi BotAliasLocaleSettings = Shapes::StructureShape.new(name: 'BotAliasLocaleSettings') BotAliasLocaleSettingsMap = Shapes::MapShape.new(name: 'BotAliasLocaleSettingsMap') BotAliasName = Shapes::StringShape.new(name: 'BotAliasName') + BotAliasReplicaSummary = Shapes::StructureShape.new(name: 'BotAliasReplicaSummary') + BotAliasReplicaSummaryList = Shapes::ListShape.new(name: 'BotAliasReplicaSummaryList') + BotAliasReplicationStatus = Shapes::StringShape.new(name: 'BotAliasReplicationStatus') BotAliasStatus = Shapes::StringShape.new(name: 'BotAliasStatus') BotAliasSummary = Shapes::StructureShape.new(name: 'BotAliasSummary') BotAliasSummaryList = Shapes::ListShape.new(name: 'BotAliasSummaryList') @@ -184,6 +187,9 @@ module ClientApi BotRecommendationStatus = Shapes::StringShape.new(name: 'BotRecommendationStatus') BotRecommendationSummary = Shapes::StructureShape.new(name: 'BotRecommendationSummary') BotRecommendationSummaryList = Shapes::ListShape.new(name: 'BotRecommendationSummaryList') + BotReplicaStatus = Shapes::StringShape.new(name: 'BotReplicaStatus') + BotReplicaSummary = Shapes::StructureShape.new(name: 'BotReplicaSummary') + BotReplicaSummaryList = Shapes::ListShape.new(name: 'BotReplicaSummaryList') BotSortAttribute = Shapes::StringShape.new(name: 'BotSortAttribute') BotSortBy = Shapes::StructureShape.new(name: 'BotSortBy') BotStatus = Shapes::StringShape.new(name: 'BotStatus') @@ -193,6 +199,11 @@ module ClientApi BotVersion = Shapes::StringShape.new(name: 'BotVersion') BotVersionLocaleDetails = Shapes::StructureShape.new(name: 'BotVersionLocaleDetails') BotVersionLocaleSpecification = Shapes::MapShape.new(name: 'BotVersionLocaleSpecification') + BotVersionReplicaSortAttribute = Shapes::StringShape.new(name: 'BotVersionReplicaSortAttribute') + BotVersionReplicaSortBy = Shapes::StructureShape.new(name: 'BotVersionReplicaSortBy') + BotVersionReplicaSummary = Shapes::StructureShape.new(name: 'BotVersionReplicaSummary') + BotVersionReplicaSummaryList = Shapes::ListShape.new(name: 'BotVersionReplicaSummaryList') + BotVersionReplicationStatus = Shapes::StringShape.new(name: 'BotVersionReplicationStatus') BotVersionSortAttribute = Shapes::StringShape.new(name: 'BotVersionSortAttribute') BotVersionSortBy = Shapes::StructureShape.new(name: 'BotVersionSortBy') BotVersionSummary = Shapes::StructureShape.new(name: 'BotVersionSummary') @@ -254,6 +265,8 @@ module ClientApi CreateBotAliasResponse = Shapes::StructureShape.new(name: 'CreateBotAliasResponse') CreateBotLocaleRequest = Shapes::StructureShape.new(name: 'CreateBotLocaleRequest') CreateBotLocaleResponse = Shapes::StructureShape.new(name: 'CreateBotLocaleResponse') + CreateBotReplicaRequest = Shapes::StructureShape.new(name: 'CreateBotReplicaRequest') + CreateBotReplicaResponse = Shapes::StructureShape.new(name: 'CreateBotReplicaResponse') CreateBotRequest = Shapes::StructureShape.new(name: 'CreateBotRequest') CreateBotResponse = Shapes::StructureShape.new(name: 'CreateBotResponse') CreateBotVersionRequest = Shapes::StructureShape.new(name: 'CreateBotVersionRequest') @@ -292,6 +305,8 @@ module ClientApi DeleteBotAliasResponse = Shapes::StructureShape.new(name: 'DeleteBotAliasResponse') DeleteBotLocaleRequest = Shapes::StructureShape.new(name: 'DeleteBotLocaleRequest') DeleteBotLocaleResponse = Shapes::StructureShape.new(name: 'DeleteBotLocaleResponse') + DeleteBotReplicaRequest = Shapes::StructureShape.new(name: 'DeleteBotReplicaRequest') + DeleteBotReplicaResponse = Shapes::StructureShape.new(name: 'DeleteBotReplicaResponse') DeleteBotRequest = Shapes::StructureShape.new(name: 'DeleteBotRequest') DeleteBotResponse = Shapes::StructureShape.new(name: 'DeleteBotResponse') DeleteBotVersionRequest = Shapes::StructureShape.new(name: 'DeleteBotVersionRequest') @@ -319,6 +334,8 @@ module ClientApi DescribeBotLocaleResponse = Shapes::StructureShape.new(name: 'DescribeBotLocaleResponse') DescribeBotRecommendationRequest = Shapes::StructureShape.new(name: 'DescribeBotRecommendationRequest') DescribeBotRecommendationResponse = Shapes::StructureShape.new(name: 'DescribeBotRecommendationResponse') + DescribeBotReplicaRequest = Shapes::StructureShape.new(name: 'DescribeBotReplicaRequest') + DescribeBotReplicaResponse = Shapes::StructureShape.new(name: 'DescribeBotReplicaResponse') DescribeBotRequest = Shapes::StructureShape.new(name: 'DescribeBotRequest') DescribeBotResourceGenerationRequest = Shapes::StructureShape.new(name: 'DescribeBotResourceGenerationRequest') DescribeBotResourceGenerationResponse = Shapes::StructureShape.new(name: 'DescribeBotResourceGenerationResponse') @@ -455,14 +472,20 @@ module ClientApi LexTranscriptFilter = Shapes::StructureShape.new(name: 'LexTranscriptFilter') ListAggregatedUtterancesRequest = Shapes::StructureShape.new(name: 'ListAggregatedUtterancesRequest') ListAggregatedUtterancesResponse = Shapes::StructureShape.new(name: 'ListAggregatedUtterancesResponse') + ListBotAliasReplicasRequest = Shapes::StructureShape.new(name: 'ListBotAliasReplicasRequest') + ListBotAliasReplicasResponse = Shapes::StructureShape.new(name: 'ListBotAliasReplicasResponse') ListBotAliasesRequest = Shapes::StructureShape.new(name: 'ListBotAliasesRequest') ListBotAliasesResponse = Shapes::StructureShape.new(name: 'ListBotAliasesResponse') ListBotLocalesRequest = Shapes::StructureShape.new(name: 'ListBotLocalesRequest') ListBotLocalesResponse = Shapes::StructureShape.new(name: 'ListBotLocalesResponse') ListBotRecommendationsRequest = Shapes::StructureShape.new(name: 'ListBotRecommendationsRequest') ListBotRecommendationsResponse = Shapes::StructureShape.new(name: 'ListBotRecommendationsResponse') + ListBotReplicasRequest = Shapes::StructureShape.new(name: 'ListBotReplicasRequest') + ListBotReplicasResponse = Shapes::StructureShape.new(name: 'ListBotReplicasResponse') ListBotResourceGenerationsRequest = Shapes::StructureShape.new(name: 'ListBotResourceGenerationsRequest') ListBotResourceGenerationsResponse = Shapes::StructureShape.new(name: 'ListBotResourceGenerationsResponse') + ListBotVersionReplicasRequest = Shapes::StructureShape.new(name: 'ListBotVersionReplicasRequest') + ListBotVersionReplicasResponse = Shapes::StructureShape.new(name: 'ListBotVersionReplicasResponse') ListBotVersionsRequest = Shapes::StructureShape.new(name: 'ListBotVersionsRequest') ListBotVersionsResponse = Shapes::StructureShape.new(name: 'ListBotVersionsResponse') ListBotsRequest = Shapes::StructureShape.new(name: 'ListBotsRequest') @@ -567,6 +590,7 @@ module ClientApi RecordNumber = Shapes::IntegerShape.new(name: 'RecordNumber') RegexPattern = Shapes::StringShape.new(name: 'RegexPattern') RelativeAggregationDuration = Shapes::StructureShape.new(name: 'RelativeAggregationDuration') + ReplicaRegion = Shapes::StringShape.new(name: 'ReplicaRegion') ResourceCount = Shapes::IntegerShape.new(name: 'ResourceCount') ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException') ResponseSpecification = Shapes::StructureShape.new(name: 'ResponseSpecification') @@ -1116,6 +1140,16 @@ module ClientApi BotAliasLocaleSettingsMap.key = Shapes::ShapeRef.new(shape: LocaleId) BotAliasLocaleSettingsMap.value = Shapes::ShapeRef.new(shape: BotAliasLocaleSettings) + BotAliasReplicaSummary.add_member(:bot_alias_id, Shapes::ShapeRef.new(shape: BotAliasId, location_name: "botAliasId")) + BotAliasReplicaSummary.add_member(:bot_alias_replication_status, Shapes::ShapeRef.new(shape: BotAliasReplicationStatus, location_name: "botAliasReplicationStatus")) + BotAliasReplicaSummary.add_member(:bot_version, Shapes::ShapeRef.new(shape: BotVersion, location_name: "botVersion")) + BotAliasReplicaSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDateTime")) + BotAliasReplicaSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdatedDateTime")) + BotAliasReplicaSummary.add_member(:failure_reasons, Shapes::ShapeRef.new(shape: FailureReasons, location_name: "failureReasons")) + BotAliasReplicaSummary.struct_class = Types::BotAliasReplicaSummary + + BotAliasReplicaSummaryList.member = Shapes::ShapeRef.new(shape: BotAliasReplicaSummary) + BotAliasSummary.add_member(:bot_alias_id, Shapes::ShapeRef.new(shape: BotAliasId, location_name: "botAliasId")) BotAliasSummary.add_member(:bot_alias_name, Shapes::ShapeRef.new(shape: Name, location_name: "botAliasName")) BotAliasSummary.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) @@ -1216,6 +1250,14 @@ module ClientApi BotRecommendationSummaryList.member = Shapes::ShapeRef.new(shape: BotRecommendationSummary) + BotReplicaSummary.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "replicaRegion")) + BotReplicaSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDateTime")) + BotReplicaSummary.add_member(:bot_replica_status, Shapes::ShapeRef.new(shape: BotReplicaStatus, location_name: "botReplicaStatus")) + BotReplicaSummary.add_member(:failure_reasons, Shapes::ShapeRef.new(shape: FailureReasons, location_name: "failureReasons")) + BotReplicaSummary.struct_class = Types::BotReplicaSummary + + BotReplicaSummaryList.member = Shapes::ShapeRef.new(shape: BotReplicaSummary) + BotSortBy.add_member(:attribute, Shapes::ShapeRef.new(shape: BotSortAttribute, required: true, location_name: "attribute")) BotSortBy.add_member(:order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "order")) BotSortBy.struct_class = Types::BotSortBy @@ -1237,6 +1279,18 @@ module ClientApi BotVersionLocaleSpecification.key = Shapes::ShapeRef.new(shape: LocaleId) BotVersionLocaleSpecification.value = Shapes::ShapeRef.new(shape: BotVersionLocaleDetails) + BotVersionReplicaSortBy.add_member(:attribute, Shapes::ShapeRef.new(shape: BotVersionReplicaSortAttribute, required: true, location_name: "attribute")) + BotVersionReplicaSortBy.add_member(:order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "order")) + BotVersionReplicaSortBy.struct_class = Types::BotVersionReplicaSortBy + + BotVersionReplicaSummary.add_member(:bot_version, Shapes::ShapeRef.new(shape: BotVersion, location_name: "botVersion")) + BotVersionReplicaSummary.add_member(:bot_version_replication_status, Shapes::ShapeRef.new(shape: BotVersionReplicationStatus, location_name: "botVersionReplicationStatus")) + BotVersionReplicaSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDateTime")) + BotVersionReplicaSummary.add_member(:failure_reasons, Shapes::ShapeRef.new(shape: FailureReasons, location_name: "failureReasons")) + BotVersionReplicaSummary.struct_class = Types::BotVersionReplicaSummary + + BotVersionReplicaSummaryList.member = Shapes::ShapeRef.new(shape: BotVersionReplicaSummary) + BotVersionSortBy.add_member(:attribute, Shapes::ShapeRef.new(shape: BotVersionSortAttribute, required: true, location_name: "attribute")) BotVersionSortBy.add_member(:order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "order")) BotVersionSortBy.struct_class = Types::BotVersionSortBy @@ -1418,6 +1472,17 @@ module ClientApi CreateBotLocaleResponse.add_member(:generative_ai_settings, Shapes::ShapeRef.new(shape: GenerativeAISettings, location_name: "generativeAISettings")) CreateBotLocaleResponse.struct_class = Types::CreateBotLocaleResponse + CreateBotReplicaRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) + CreateBotReplicaRequest.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, required: true, location_name: "replicaRegion")) + CreateBotReplicaRequest.struct_class = Types::CreateBotReplicaRequest + + CreateBotReplicaResponse.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, location_name: "botId")) + CreateBotReplicaResponse.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "replicaRegion")) + CreateBotReplicaResponse.add_member(:source_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "sourceRegion")) + CreateBotReplicaResponse.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDateTime")) + CreateBotReplicaResponse.add_member(:bot_replica_status, Shapes::ShapeRef.new(shape: BotReplicaStatus, location_name: "botReplicaStatus")) + CreateBotReplicaResponse.struct_class = Types::CreateBotReplicaResponse + CreateBotRequest.add_member(:bot_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "botName")) CreateBotRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) CreateBotRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn")) @@ -1659,6 +1724,15 @@ module ClientApi DeleteBotLocaleResponse.add_member(:bot_locale_status, Shapes::ShapeRef.new(shape: BotLocaleStatus, location_name: "botLocaleStatus")) DeleteBotLocaleResponse.struct_class = Types::DeleteBotLocaleResponse + DeleteBotReplicaRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) + DeleteBotReplicaRequest.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, required: true, location: "uri", location_name: "replicaRegion")) + DeleteBotReplicaRequest.struct_class = Types::DeleteBotReplicaRequest + + DeleteBotReplicaResponse.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, location_name: "botId")) + DeleteBotReplicaResponse.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "replicaRegion")) + DeleteBotReplicaResponse.add_member(:bot_replica_status, Shapes::ShapeRef.new(shape: BotReplicaStatus, location_name: "botReplicaStatus")) + DeleteBotReplicaResponse.struct_class = Types::DeleteBotReplicaResponse + DeleteBotRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) DeleteBotRequest.add_member(:skip_resource_in_use_check, Shapes::ShapeRef.new(shape: SkipResourceInUseCheck, location: "querystring", location_name: "skipResourceInUseCheck")) DeleteBotRequest.struct_class = Types::DeleteBotRequest @@ -1813,6 +1887,18 @@ module ClientApi DescribeBotRecommendationResponse.add_member(:bot_recommendation_results, Shapes::ShapeRef.new(shape: BotRecommendationResults, location_name: "botRecommendationResults")) DescribeBotRecommendationResponse.struct_class = Types::DescribeBotRecommendationResponse + DescribeBotReplicaRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) + DescribeBotReplicaRequest.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, required: true, location: "uri", location_name: "replicaRegion")) + DescribeBotReplicaRequest.struct_class = Types::DescribeBotReplicaRequest + + DescribeBotReplicaResponse.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, location_name: "botId")) + DescribeBotReplicaResponse.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "replicaRegion")) + DescribeBotReplicaResponse.add_member(:source_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "sourceRegion")) + DescribeBotReplicaResponse.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDateTime")) + DescribeBotReplicaResponse.add_member(:bot_replica_status, Shapes::ShapeRef.new(shape: BotReplicaStatus, location_name: "botReplicaStatus")) + DescribeBotReplicaResponse.add_member(:failure_reasons, Shapes::ShapeRef.new(shape: FailureReasons, location_name: "failureReasons")) + DescribeBotReplicaResponse.struct_class = Types::DescribeBotReplicaResponse + DescribeBotRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) DescribeBotRequest.struct_class = Types::DescribeBotRequest @@ -2359,6 +2445,19 @@ module ClientApi ListAggregatedUtterancesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) ListAggregatedUtterancesResponse.struct_class = Types::ListAggregatedUtterancesResponse + ListBotAliasReplicasRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) + ListBotAliasReplicasRequest.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, required: true, location: "uri", location_name: "replicaRegion")) + ListBotAliasReplicasRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults")) + ListBotAliasReplicasRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) + ListBotAliasReplicasRequest.struct_class = Types::ListBotAliasReplicasRequest + + ListBotAliasReplicasResponse.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, location_name: "botId")) + ListBotAliasReplicasResponse.add_member(:source_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "sourceRegion")) + ListBotAliasReplicasResponse.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "replicaRegion")) + ListBotAliasReplicasResponse.add_member(:bot_alias_replica_summaries, Shapes::ShapeRef.new(shape: BotAliasReplicaSummaryList, location_name: "botAliasReplicaSummaries")) + ListBotAliasReplicasResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) + ListBotAliasReplicasResponse.struct_class = Types::ListBotAliasReplicasResponse + ListBotAliasesRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) ListBotAliasesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults")) ListBotAliasesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) @@ -2397,6 +2496,14 @@ module ClientApi ListBotRecommendationsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) ListBotRecommendationsResponse.struct_class = Types::ListBotRecommendationsResponse + ListBotReplicasRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) + ListBotReplicasRequest.struct_class = Types::ListBotReplicasRequest + + ListBotReplicasResponse.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, location_name: "botId")) + ListBotReplicasResponse.add_member(:source_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "sourceRegion")) + ListBotReplicasResponse.add_member(:bot_replica_summaries, Shapes::ShapeRef.new(shape: BotReplicaSummaryList, location_name: "botReplicaSummaries")) + ListBotReplicasResponse.struct_class = Types::ListBotReplicasResponse + ListBotResourceGenerationsRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) ListBotResourceGenerationsRequest.add_member(:bot_version, Shapes::ShapeRef.new(shape: BotVersion, required: true, location: "uri", location_name: "botVersion")) ListBotResourceGenerationsRequest.add_member(:locale_id, Shapes::ShapeRef.new(shape: LocaleId, required: true, location: "uri", location_name: "localeId")) @@ -2412,6 +2519,20 @@ module ClientApi ListBotResourceGenerationsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) ListBotResourceGenerationsResponse.struct_class = Types::ListBotResourceGenerationsResponse + ListBotVersionReplicasRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) + ListBotVersionReplicasRequest.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, required: true, location: "uri", location_name: "replicaRegion")) + ListBotVersionReplicasRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults")) + ListBotVersionReplicasRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) + ListBotVersionReplicasRequest.add_member(:sort_by, Shapes::ShapeRef.new(shape: BotVersionReplicaSortBy, location_name: "sortBy")) + ListBotVersionReplicasRequest.struct_class = Types::ListBotVersionReplicasRequest + + ListBotVersionReplicasResponse.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, location_name: "botId")) + ListBotVersionReplicasResponse.add_member(:source_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "sourceRegion")) + ListBotVersionReplicasResponse.add_member(:replica_region, Shapes::ShapeRef.new(shape: ReplicaRegion, location_name: "replicaRegion")) + ListBotVersionReplicasResponse.add_member(:bot_version_replica_summaries, Shapes::ShapeRef.new(shape: BotVersionReplicaSummaryList, location_name: "botVersionReplicaSummaries")) + ListBotVersionReplicasResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) + ListBotVersionReplicasResponse.struct_class = Types::ListBotVersionReplicasResponse + ListBotVersionsRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId")) ListBotVersionsRequest.add_member(:sort_by, Shapes::ShapeRef.new(shape: BotVersionSortBy, location_name: "sortBy")) ListBotVersionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults")) @@ -3788,6 +3909,20 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:create_bot_replica, Seahorse::Model::Operation.new.tap do |o| + o.name = "CreateBotReplica" + o.http_method = "PUT" + o.http_request_uri = "/bots/{botId}/replicas/" + o.input = Shapes::ShapeRef.new(shape: CreateBotReplicaRequest) + o.output = Shapes::ShapeRef.new(shape: CreateBotReplicaResponse) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: PreconditionFailedException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + end) + api.add_operation(:create_bot_version, Seahorse::Model::Operation.new.tap do |o| o.name = "CreateBotVersion" o.http_method = "PUT" @@ -3956,6 +4091,20 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:delete_bot_replica, Seahorse::Model::Operation.new.tap do |o| + o.name = "DeleteBotReplica" + o.http_method = "DELETE" + o.http_request_uri = "/bots/{botId}/replicas/{replicaRegion}/" + o.input = Shapes::ShapeRef.new(shape: DeleteBotReplicaRequest) + o.output = Shapes::ShapeRef.new(shape: DeleteBotReplicaResponse) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: PreconditionFailedException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + end) + api.add_operation(:delete_bot_version, Seahorse::Model::Operation.new.tap do |o| o.name = "DeleteBotVersion" o.http_method = "DELETE" @@ -4152,6 +4301,19 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:describe_bot_replica, Seahorse::Model::Operation.new.tap do |o| + o.name = "DescribeBotReplica" + o.http_method = "GET" + o.http_request_uri = "/bots/{botId}/replicas/{replicaRegion}/" + o.input = Shapes::ShapeRef.new(shape: DescribeBotReplicaRequest) + o.output = Shapes::ShapeRef.new(shape: DescribeBotReplicaResponse) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + end) + api.add_operation(:describe_bot_resource_generation, Seahorse::Model::Operation.new.tap do |o| o.name = "DescribeBotResourceGeneration" o.http_method = "GET" @@ -4363,6 +4525,24 @@ module ClientApi ) end) + api.add_operation(:list_bot_alias_replicas, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListBotAliasReplicas" + o.http_method = "POST" + o.http_request_uri = "/bots/{botId}/replicas/{replicaRegion}/botaliases/" + o.input = Shapes::ShapeRef.new(shape: ListBotAliasReplicasRequest) + o.output = Shapes::ShapeRef.new(shape: ListBotAliasReplicasResponse) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:list_bot_aliases, Seahorse::Model::Operation.new.tap do |o| o.name = "ListBotAliases" o.http_method = "POST" @@ -4417,6 +4597,18 @@ module ClientApi ) end) + api.add_operation(:list_bot_replicas, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListBotReplicas" + o.http_method = "POST" + o.http_request_uri = "/bots/{botId}/replicas/" + o.input = Shapes::ShapeRef.new(shape: ListBotReplicasRequest) + o.output = Shapes::ShapeRef.new(shape: ListBotReplicasResponse) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + end) + api.add_operation(:list_bot_resource_generations, Seahorse::Model::Operation.new.tap do |o| o.name = "ListBotResourceGenerations" o.http_method = "POST" @@ -4435,6 +4627,24 @@ module ClientApi ) end) + api.add_operation(:list_bot_version_replicas, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListBotVersionReplicas" + o.http_method = "POST" + o.http_request_uri = "/bots/{botId}/replicas/{replicaRegion}/botversions/" + o.input = Shapes::ShapeRef.new(shape: ListBotVersionReplicasRequest) + o.output = Shapes::ShapeRef.new(shape: ListBotVersionReplicasResponse) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:list_bot_versions, Seahorse::Model::Operation.new.tap do |o| o.name = "ListBotVersions" o.http_method = "POST" diff --git a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/endpoints.rb b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/endpoints.rb index dfc6df003a4..25b9b305974 100644 --- a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/endpoints.rb +++ b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/endpoints.rb @@ -110,6 +110,20 @@ def self.build(context) end end + class CreateBotReplica + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::LexModelsV2::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class CreateBotVersion def self.build(context) unless context.config.regional_endpoint @@ -278,6 +292,20 @@ def self.build(context) end end + class DeleteBotReplica + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::LexModelsV2::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class DeleteBotVersion def self.build(context) unless context.config.regional_endpoint @@ -488,6 +516,20 @@ def self.build(context) end end + class DescribeBotReplica + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::LexModelsV2::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class DescribeBotResourceGeneration def self.build(context) unless context.config.regional_endpoint @@ -712,6 +754,20 @@ def self.build(context) end end + class ListBotAliasReplicas + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::LexModelsV2::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class ListBotAliases def self.build(context) unless context.config.regional_endpoint @@ -754,6 +810,20 @@ def self.build(context) end end + class ListBotReplicas + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::LexModelsV2::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class ListBotResourceGenerations def self.build(context) unless context.config.regional_endpoint @@ -768,6 +838,20 @@ def self.build(context) end end + class ListBotVersionReplicas + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::LexModelsV2::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class ListBotVersions def self.build(context) unless context.config.regional_endpoint diff --git a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/plugins/endpoints.rb b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/plugins/endpoints.rb index 5acda9eaee9..aa7b22e6126 100644 --- a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/plugins/endpoints.rb +++ b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/plugins/endpoints.rb @@ -72,6 +72,8 @@ def parameters_for_operation(context) Aws::LexModelsV2::Endpoints::CreateBotAlias.build(context) when :create_bot_locale Aws::LexModelsV2::Endpoints::CreateBotLocale.build(context) + when :create_bot_replica + Aws::LexModelsV2::Endpoints::CreateBotReplica.build(context) when :create_bot_version Aws::LexModelsV2::Endpoints::CreateBotVersion.build(context) when :create_export @@ -96,6 +98,8 @@ def parameters_for_operation(context) Aws::LexModelsV2::Endpoints::DeleteBotAlias.build(context) when :delete_bot_locale Aws::LexModelsV2::Endpoints::DeleteBotLocale.build(context) + when :delete_bot_replica + Aws::LexModelsV2::Endpoints::DeleteBotReplica.build(context) when :delete_bot_version Aws::LexModelsV2::Endpoints::DeleteBotVersion.build(context) when :delete_custom_vocabulary @@ -126,6 +130,8 @@ def parameters_for_operation(context) Aws::LexModelsV2::Endpoints::DescribeBotLocale.build(context) when :describe_bot_recommendation Aws::LexModelsV2::Endpoints::DescribeBotRecommendation.build(context) + when :describe_bot_replica + Aws::LexModelsV2::Endpoints::DescribeBotReplica.build(context) when :describe_bot_resource_generation Aws::LexModelsV2::Endpoints::DescribeBotResourceGeneration.build(context) when :describe_bot_version @@ -158,14 +164,20 @@ def parameters_for_operation(context) Aws::LexModelsV2::Endpoints::GetTestExecutionArtifactsUrl.build(context) when :list_aggregated_utterances Aws::LexModelsV2::Endpoints::ListAggregatedUtterances.build(context) + when :list_bot_alias_replicas + Aws::LexModelsV2::Endpoints::ListBotAliasReplicas.build(context) when :list_bot_aliases Aws::LexModelsV2::Endpoints::ListBotAliases.build(context) when :list_bot_locales Aws::LexModelsV2::Endpoints::ListBotLocales.build(context) when :list_bot_recommendations Aws::LexModelsV2::Endpoints::ListBotRecommendations.build(context) + when :list_bot_replicas + Aws::LexModelsV2::Endpoints::ListBotReplicas.build(context) when :list_bot_resource_generations Aws::LexModelsV2::Endpoints::ListBotResourceGenerations.build(context) + when :list_bot_version_replicas + Aws::LexModelsV2::Endpoints::ListBotVersionReplicas.build(context) when :list_bot_versions Aws::LexModelsV2::Endpoints::ListBotVersions.build(context) when :list_bots diff --git a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb index 900518e629d..e0ea44d9d4a 100644 --- a/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb +++ b/gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb @@ -1897,6 +1897,46 @@ class BotAliasLocaleSettings < Struct.new( include Aws::Structure end + # Contains information about all the aliases replication statuses + # applicable for global resiliency. + # + # @!attribute [rw] bot_alias_id + # The bot alias ID for all the alias bot replications. + # @return [String] + # + # @!attribute [rw] bot_alias_replication_status + # The replication statuses for all the alias bot replications. + # @return [String] + # + # @!attribute [rw] bot_version + # The bot version for all the alias bot replications. + # @return [String] + # + # @!attribute [rw] creation_date_time + # The creation time and date for all the alias bot replications. + # @return [Time] + # + # @!attribute [rw] last_updated_date_time + # The last time and date updated for all the alias bot replications. + # @return [Time] + # + # @!attribute [rw] failure_reasons + # The reasons for failure for the aliases bot replications. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotAliasReplicaSummary AWS API Documentation + # + class BotAliasReplicaSummary < Struct.new( + :bot_alias_id, + :bot_alias_replication_status, + :bot_version, + :creation_date_time, + :last_updated_date_time, + :failure_reasons) + SENSITIVE = [] + include Aws::Structure + end + # Summary information about bot aliases returned from the # [ListBotAliases][1] operation. # @@ -2396,6 +2436,36 @@ class BotRecommendationSummary < Struct.new( include Aws::Structure end + # Contains summary information about all the replication statuses + # applicable for global resiliency. + # + # @!attribute [rw] replica_region + # The replica region used in the replication statuses summary. + # @return [String] + # + # @!attribute [rw] creation_date_time + # The creation time and date for the replicated bots. + # @return [Time] + # + # @!attribute [rw] bot_replica_status + # The operation status for the replicated bot applicable. + # @return [String] + # + # @!attribute [rw] failure_reasons + # The reasons for the failure for the replicated bot. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotReplicaSummary AWS API Documentation + # + class BotReplicaSummary < Struct.new( + :replica_region, + :creation_date_time, + :bot_replica_status, + :failure_reasons) + SENSITIVE = [] + include Aws::Structure + end + # Specifies attributes for sorting a list of bots. # # @!attribute [rw] attribute @@ -2485,6 +2555,57 @@ class BotVersionLocaleDetails < Struct.new( include Aws::Structure end + # The sort category for the version replicated bots. + # + # @!attribute [rw] attribute + # The attribute of the sort category for the version replicated bots. + # @return [String] + # + # @!attribute [rw] order + # The order of the sort category for the version replicated bots. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotVersionReplicaSortBy AWS API Documentation + # + class BotVersionReplicaSortBy < Struct.new( + :attribute, + :order) + SENSITIVE = [] + include Aws::Structure + end + + # Contains summary information for all the version replication statuses + # applicable for Global resiliency. + # + # @!attribute [rw] bot_version + # The bot version for the summary information for all the version + # replication statuses. + # @return [String] + # + # @!attribute [rw] bot_version_replication_status + # The version replication status for all the replicated bots. + # @return [String] + # + # @!attribute [rw] creation_date_time + # The creation date and time of the replication status for all the + # replicated bots. + # @return [Time] + # + # @!attribute [rw] failure_reasons + # The reasons for replication failure for all the replicated bots. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotVersionReplicaSummary AWS API Documentation + # + class BotVersionReplicaSummary < Struct.new( + :bot_version, + :bot_version_replication_status, + :creation_date_time, + :failure_reasons) + SENSITIVE = [] + include Aws::Structure + end + # Specifies attributes for sorting a list of bot versions. # # @!attribute [rw] attribute @@ -3379,6 +3500,58 @@ class CreateBotLocaleResponse < Struct.new( include Aws::Structure end + # @!attribute [rw] bot_id + # The request for the unique bot ID of the source bot to be replicated + # in the secondary region. + # @return [String] + # + # @!attribute [rw] replica_region + # The request for the secondary region that will be used in the + # replication of the source bot. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotReplicaRequest AWS API Documentation + # + class CreateBotReplicaRequest < Struct.new( + :bot_id, + :replica_region) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] bot_id + # The unique bot ID of the replicated bot generated. + # @return [String] + # + # @!attribute [rw] replica_region + # The region of the replicated bot generated. + # @return [String] + # + # @!attribute [rw] source_region + # The source region for the source bot used for the replicated bot + # generated. + # @return [String] + # + # @!attribute [rw] creation_date_time + # The creation date and time of the replicated bot generated. + # @return [Time] + # + # @!attribute [rw] bot_replica_status + # The operational status of the replicated bot generated. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotReplicaResponse AWS API Documentation + # + class CreateBotReplicaResponse < Struct.new( + :bot_id, + :replica_region, + :source_region, + :creation_date_time, + :bot_replica_status) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] bot_name # The name of the bot. The bot name must be unique in the account that # creates the bot. @@ -4768,6 +4941,46 @@ class DeleteBotLocaleResponse < Struct.new( include Aws::Structure end + # @!attribute [rw] bot_id + # The unique ID of the replicated bot to be deleted from the secondary + # region + # @return [String] + # + # @!attribute [rw] replica_region + # The secondary region of the replicated bot that will be deleted. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotReplicaRequest AWS API Documentation + # + class DeleteBotReplicaRequest < Struct.new( + :bot_id, + :replica_region) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] bot_id + # The unique bot ID of the replicated bot generated. + # @return [String] + # + # @!attribute [rw] replica_region + # The region of the replicated bot generated. + # @return [String] + # + # @!attribute [rw] bot_replica_status + # The operational status of the replicated bot generated. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotReplicaResponse AWS API Documentation + # + class DeleteBotReplicaResponse < Struct.new( + :bot_id, + :replica_region, + :bot_replica_status) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] bot_id # The identifier of the bot to delete. # @return [String] @@ -5563,6 +5776,61 @@ class DescribeBotRecommendationResponse < Struct.new( include Aws::Structure end + # @!attribute [rw] bot_id + # The request for the unique bot ID of the replicated bot being + # monitored. + # @return [String] + # + # @!attribute [rw] replica_region + # The request for the region of the replicated bot being monitored. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotReplicaRequest AWS API Documentation + # + class DescribeBotReplicaRequest < Struct.new( + :bot_id, + :replica_region) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] bot_id + # The unique bot ID of the replicated bot being monitored. + # @return [String] + # + # @!attribute [rw] replica_region + # The region of the replicated bot being monitored. + # @return [String] + # + # @!attribute [rw] source_region + # The source region of the replicated bot being monitored. + # @return [String] + # + # @!attribute [rw] creation_date_time + # The creation date and time of the replicated bot being monitored. + # @return [Time] + # + # @!attribute [rw] bot_replica_status + # The operational status of the replicated bot being monitored. + # @return [String] + # + # @!attribute [rw] failure_reasons + # The failure reasons the bot being monitored failed to replicate. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotReplicaResponse AWS API Documentation + # + class DescribeBotReplicaResponse < Struct.new( + :bot_id, + :replica_region, + :source_region, + :creation_date_time, + :bot_replica_status, + :failure_reasons) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] bot_id # The unique identifier of the bot to describe. # @return [String] @@ -8313,6 +8581,74 @@ class ListAggregatedUtterancesResponse < Struct.new( include Aws::Structure end + # @!attribute [rw] bot_id + # The request for the unique bot ID of the replicated bot created from + # the source bot alias. + # @return [String] + # + # @!attribute [rw] replica_region + # The request for the secondary region of the replicated bot created + # from the source bot alias. + # @return [String] + # + # @!attribute [rw] max_results + # The request for maximum results to list the replicated bots created + # from the source bot alias. + # @return [Integer] + # + # @!attribute [rw] next_token + # The request for the next token for the replicated bot created from + # the source bot alias. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotAliasReplicasRequest AWS API Documentation + # + class ListBotAliasReplicasRequest < Struct.new( + :bot_id, + :replica_region, + :max_results, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] bot_id + # The unique bot ID of the replicated bot created from the source bot + # alias. + # @return [String] + # + # @!attribute [rw] source_region + # The source region of the replicated bot created from the source bot + # alias. + # @return [String] + # + # @!attribute [rw] replica_region + # The secondary region of the replicated bot created from the source + # bot alias. + # @return [String] + # + # @!attribute [rw] bot_alias_replica_summaries + # The summary information of the replicated bot created from the + # source bot alias. + # @return [Array] + # + # @!attribute [rw] next_token + # The next token for the replicated bots created from the source bot + # alias. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotAliasReplicasResponse AWS API Documentation + # + class ListBotAliasReplicasResponse < Struct.new( + :bot_id, + :source_region, + :replica_region, + :bot_alias_replica_summaries, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] bot_id # The identifier of the bot to list aliases for. # @return [String] @@ -8529,6 +8865,40 @@ class ListBotRecommendationsResponse < Struct.new( include Aws::Structure end + # @!attribute [rw] bot_id + # The request for the unique bot IDs in the list of replicated bots. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotReplicasRequest AWS API Documentation + # + class ListBotReplicasRequest < Struct.new( + :bot_id) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] bot_id + # the unique bot IDs in the list of replicated bots. + # @return [String] + # + # @!attribute [rw] source_region + # The source region of the source bots in the list of replicated bots. + # @return [String] + # + # @!attribute [rw] bot_replica_summaries + # The summary details for the replicated bots. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotReplicasResponse AWS API Documentation + # + class ListBotReplicasResponse < Struct.new( + :bot_id, + :source_region, + :bot_replica_summaries) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] bot_id # The unique identifier of the bot whose generation requests you want # to view. @@ -8608,6 +8978,73 @@ class ListBotResourceGenerationsResponse < Struct.new( include Aws::Structure end + # @!attribute [rw] bot_id + # The request for the unique ID in the list of replicated bots. + # @return [String] + # + # @!attribute [rw] replica_region + # The request for the region used in the list of replicated bots. + # @return [String] + # + # @!attribute [rw] max_results + # The maximum results given in the list of replicated bots. + # @return [Integer] + # + # @!attribute [rw] next_token + # The next token given in the list of replicated bots. + # @return [String] + # + # @!attribute [rw] sort_by + # The requested sort category for the list of replicated bots. + # @return [Types::BotVersionReplicaSortBy] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotVersionReplicasRequest AWS API Documentation + # + class ListBotVersionReplicasRequest < Struct.new( + :bot_id, + :replica_region, + :max_results, + :next_token, + :sort_by) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] bot_id + # The unique ID of the bots in the list of replicated bots. + # @return [String] + # + # @!attribute [rw] source_region + # The source region used for the bots in the list of replicated bots. + # @return [String] + # + # @!attribute [rw] replica_region + # The region used for the replicated bots in the list of replicated + # bots. + # @return [String] + # + # @!attribute [rw] bot_version_replica_summaries + # The information summary used for the replicated bots in the list of + # replicated bots. + # @return [Array] + # + # @!attribute [rw] next_token + # The next token used for the replicated bots in the list of + # replicated bots. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotVersionReplicasResponse AWS API Documentation + # + class ListBotVersionReplicasResponse < Struct.new( + :bot_id, + :source_region, + :replica_region, + :bot_version_replica_summaries, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] bot_id # The identifier of the bot to list versions for. # @return [String] diff --git a/gems/aws-sdk-lexmodelsv2/sig/client.rbs b/gems/aws-sdk-lexmodelsv2/sig/client.rbs index 920471603a8..dcba9cbc1f2 100644 --- a/gems/aws-sdk-lexmodelsv2/sig/client.rbs +++ b/gems/aws-sdk-lexmodelsv2/sig/client.rbs @@ -309,6 +309,21 @@ module Aws ) -> _CreateBotLocaleResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBotLocaleResponseSuccess + interface _CreateBotReplicaResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::CreateBotReplicaResponse] + def bot_id: () -> ::String + def replica_region: () -> ::String + def source_region: () -> ::String + def creation_date_time: () -> ::Time + def bot_replica_status: () -> ("Enabling" | "Enabled" | "Deleting" | "Failed") + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/LexModelsV2/Client.html#create_bot_replica-instance_method + def create_bot_replica: ( + bot_id: ::String, + replica_region: ::String + ) -> _CreateBotReplicaResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBotReplicaResponseSuccess + interface _CreateBotVersionResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::CreateBotVersionResponse] def bot_id: () -> ::String @@ -5786,6 +5801,19 @@ module Aws ) -> _DeleteBotLocaleResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteBotLocaleResponseSuccess + interface _DeleteBotReplicaResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::DeleteBotReplicaResponse] + def bot_id: () -> ::String + def replica_region: () -> ::String + def bot_replica_status: () -> ("Enabling" | "Enabled" | "Deleting" | "Failed") + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/LexModelsV2/Client.html#delete_bot_replica-instance_method + def delete_bot_replica: ( + bot_id: ::String, + replica_region: ::String + ) -> _DeleteBotReplicaResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteBotReplicaResponseSuccess + interface _DeleteBotVersionResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::DeleteBotVersionResponse] def bot_id: () -> ::String @@ -6003,6 +6031,22 @@ module Aws ) -> _DescribeBotRecommendationResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeBotRecommendationResponseSuccess + interface _DescribeBotReplicaResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::DescribeBotReplicaResponse] + def bot_id: () -> ::String + def replica_region: () -> ::String + def source_region: () -> ::String + def creation_date_time: () -> ::Time + def bot_replica_status: () -> ("Enabling" | "Enabled" | "Deleting" | "Failed") + def failure_reasons: () -> ::Array[::String] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/LexModelsV2/Client.html#describe_bot_replica-instance_method + def describe_bot_replica: ( + bot_id: ::String, + replica_region: ::String + ) -> _DescribeBotReplicaResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeBotReplicaResponseSuccess + interface _DescribeBotResourceGenerationResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::DescribeBotResourceGenerationResponse] def bot_id: () -> ::String @@ -6341,6 +6385,23 @@ module Aws ) -> _ListAggregatedUtterancesResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAggregatedUtterancesResponseSuccess + interface _ListBotAliasReplicasResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::ListBotAliasReplicasResponse] + def bot_id: () -> ::String + def source_region: () -> ::String + def replica_region: () -> ::String + def bot_alias_replica_summaries: () -> ::Array[Types::BotAliasReplicaSummary] + def next_token: () -> ::String + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/LexModelsV2/Client.html#list_bot_alias_replicas-instance_method + def list_bot_alias_replicas: ( + bot_id: ::String, + replica_region: ::String, + ?max_results: ::Integer, + ?next_token: ::String + ) -> _ListBotAliasReplicasResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBotAliasReplicasResponseSuccess + interface _ListBotAliasesResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListBotAliasesResponse] def bot_alias_summaries: () -> ::Array[Types::BotAliasSummary] @@ -6400,6 +6461,18 @@ module Aws ) -> _ListBotRecommendationsResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBotRecommendationsResponseSuccess + interface _ListBotReplicasResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::ListBotReplicasResponse] + def bot_id: () -> ::String + def source_region: () -> ::String + def bot_replica_summaries: () -> ::Array[Types::BotReplicaSummary] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/LexModelsV2/Client.html#list_bot_replicas-instance_method + def list_bot_replicas: ( + bot_id: ::String + ) -> _ListBotReplicasResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBotReplicasResponseSuccess + interface _ListBotResourceGenerationsResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListBotResourceGenerationsResponse] def bot_id: () -> ::String @@ -6422,6 +6495,27 @@ module Aws ) -> _ListBotResourceGenerationsResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBotResourceGenerationsResponseSuccess + interface _ListBotVersionReplicasResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::ListBotVersionReplicasResponse] + def bot_id: () -> ::String + def source_region: () -> ::String + def replica_region: () -> ::String + def bot_version_replica_summaries: () -> ::Array[Types::BotVersionReplicaSummary] + def next_token: () -> ::String + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/LexModelsV2/Client.html#list_bot_version_replicas-instance_method + def list_bot_version_replicas: ( + bot_id: ::String, + replica_region: ::String, + ?max_results: ::Integer, + ?next_token: ::String, + ?sort_by: { + attribute: ("BotVersion"), + order: ("Ascending" | "Descending") + } + ) -> _ListBotVersionReplicasResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBotVersionReplicasResponseSuccess + interface _ListBotVersionsResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListBotVersionsResponse] def bot_id: () -> ::String diff --git a/gems/aws-sdk-lexmodelsv2/sig/types.rbs b/gems/aws-sdk-lexmodelsv2/sig/types.rbs index 2c610acc6a8..d9bc3dc000c 100644 --- a/gems/aws-sdk-lexmodelsv2/sig/types.rbs +++ b/gems/aws-sdk-lexmodelsv2/sig/types.rbs @@ -362,6 +362,16 @@ module Aws::LexModelsV2 SENSITIVE: [] end + class BotAliasReplicaSummary + attr_accessor bot_alias_id: ::String + attr_accessor bot_alias_replication_status: ("Creating" | "Updating" | "Available" | "Deleting" | "Failed") + attr_accessor bot_version: ::String + attr_accessor creation_date_time: ::Time + attr_accessor last_updated_date_time: ::Time + attr_accessor failure_reasons: ::Array[::String] + SENSITIVE: [] + end + class BotAliasSummary attr_accessor bot_alias_id: ::String attr_accessor bot_alias_name: ::String @@ -478,6 +488,14 @@ module Aws::LexModelsV2 SENSITIVE: [] end + class BotReplicaSummary + attr_accessor replica_region: ::String + attr_accessor creation_date_time: ::Time + attr_accessor bot_replica_status: ("Enabling" | "Enabled" | "Deleting" | "Failed") + attr_accessor failure_reasons: ::Array[::String] + SENSITIVE: [] + end + class BotSortBy attr_accessor attribute: ("BotName") attr_accessor order: ("Ascending" | "Descending") @@ -500,6 +518,20 @@ module Aws::LexModelsV2 SENSITIVE: [] end + class BotVersionReplicaSortBy + attr_accessor attribute: ("BotVersion") + attr_accessor order: ("Ascending" | "Descending") + SENSITIVE: [] + end + + class BotVersionReplicaSummary + attr_accessor bot_version: ::String + attr_accessor bot_version_replication_status: ("Creating" | "Available" | "Deleting" | "Failed") + attr_accessor creation_date_time: ::Time + attr_accessor failure_reasons: ::Array[::String] + SENSITIVE: [] + end + class BotVersionSortBy attr_accessor attribute: ("BotVersion") attr_accessor order: ("Ascending" | "Descending") @@ -719,6 +751,21 @@ module Aws::LexModelsV2 SENSITIVE: [] end + class CreateBotReplicaRequest + attr_accessor bot_id: ::String + attr_accessor replica_region: ::String + SENSITIVE: [] + end + + class CreateBotReplicaResponse + attr_accessor bot_id: ::String + attr_accessor replica_region: ::String + attr_accessor source_region: ::String + attr_accessor creation_date_time: ::Time + attr_accessor bot_replica_status: ("Enabling" | "Enabled" | "Deleting" | "Failed") + SENSITIVE: [] + end + class CreateBotRequest attr_accessor bot_name: ::String attr_accessor description: ::String @@ -1021,6 +1068,19 @@ module Aws::LexModelsV2 SENSITIVE: [] end + class DeleteBotReplicaRequest + attr_accessor bot_id: ::String + attr_accessor replica_region: ::String + SENSITIVE: [] + end + + class DeleteBotReplicaResponse + attr_accessor bot_id: ::String + attr_accessor replica_region: ::String + attr_accessor bot_replica_status: ("Enabling" | "Enabled" | "Deleting" | "Failed") + SENSITIVE: [] + end + class DeleteBotRequest attr_accessor bot_id: ::String attr_accessor skip_resource_in_use_check: bool @@ -1224,6 +1284,22 @@ module Aws::LexModelsV2 SENSITIVE: [] end + class DescribeBotReplicaRequest + attr_accessor bot_id: ::String + attr_accessor replica_region: ::String + SENSITIVE: [] + end + + class DescribeBotReplicaResponse + attr_accessor bot_id: ::String + attr_accessor replica_region: ::String + attr_accessor source_region: ::String + attr_accessor creation_date_time: ::Time + attr_accessor bot_replica_status: ("Enabling" | "Enabled" | "Deleting" | "Failed") + attr_accessor failure_reasons: ::Array[::String] + SENSITIVE: [] + end + class DescribeBotRequest attr_accessor bot_id: ::String SENSITIVE: [] @@ -1906,6 +1982,23 @@ module Aws::LexModelsV2 SENSITIVE: [] end + class ListBotAliasReplicasRequest + attr_accessor bot_id: ::String + attr_accessor replica_region: ::String + attr_accessor max_results: ::Integer + attr_accessor next_token: ::String + SENSITIVE: [] + end + + class ListBotAliasReplicasResponse + attr_accessor bot_id: ::String + attr_accessor source_region: ::String + attr_accessor replica_region: ::String + attr_accessor bot_alias_replica_summaries: ::Array[Types::BotAliasReplicaSummary] + attr_accessor next_token: ::String + SENSITIVE: [] + end + class ListBotAliasesRequest attr_accessor bot_id: ::String attr_accessor max_results: ::Integer @@ -1956,6 +2049,18 @@ module Aws::LexModelsV2 SENSITIVE: [] end + class ListBotReplicasRequest + attr_accessor bot_id: ::String + SENSITIVE: [] + end + + class ListBotReplicasResponse + attr_accessor bot_id: ::String + attr_accessor source_region: ::String + attr_accessor bot_replica_summaries: ::Array[Types::BotReplicaSummary] + SENSITIVE: [] + end + class ListBotResourceGenerationsRequest attr_accessor bot_id: ::String attr_accessor bot_version: ::String @@ -1975,6 +2080,24 @@ module Aws::LexModelsV2 SENSITIVE: [] end + class ListBotVersionReplicasRequest + attr_accessor bot_id: ::String + attr_accessor replica_region: ::String + attr_accessor max_results: ::Integer + attr_accessor next_token: ::String + attr_accessor sort_by: Types::BotVersionReplicaSortBy + SENSITIVE: [] + end + + class ListBotVersionReplicasResponse + attr_accessor bot_id: ::String + attr_accessor source_region: ::String + attr_accessor replica_region: ::String + attr_accessor bot_version_replica_summaries: ::Array[Types::BotVersionReplicaSummary] + attr_accessor next_token: ::String + SENSITIVE: [] + end + class ListBotVersionsRequest attr_accessor bot_id: ::String attr_accessor sort_by: Types::BotVersionSortBy diff --git a/gems/aws-sdk-redshift/CHANGELOG.md b/gems/aws-sdk-redshift/CHANGELOG.md index 3556a9d19f1..4de2b37fced 100644 --- a/gems/aws-sdk-redshift/CHANGELOG.md +++ b/gems/aws-sdk-redshift/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.109.0 (2024-02-07) +------------------ + +* Feature - LisRecommendations API to fetch Amazon Redshift Advisor recommendations. + 1.108.0 (2024-01-26) ------------------ diff --git a/gems/aws-sdk-redshift/VERSION b/gems/aws-sdk-redshift/VERSION index 83033d17f98..938d55c5464 100644 --- a/gems/aws-sdk-redshift/VERSION +++ b/gems/aws-sdk-redshift/VERSION @@ -1 +1 @@ -1.108.0 +1.109.0 diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift.rb index b8c6e4647e5..e62278ef1bc 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift.rb @@ -53,6 +53,6 @@ # @!group service module Aws::Redshift - GEM_VERSION = '1.108.0' + GEM_VERSION = '1.109.0' end diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb index 85de4cc34a8..001cee686f0 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb @@ -8319,6 +8319,86 @@ def get_resource_policy(params = {}, options = {}) req.send_request(options) end + # List the Amazon Redshift Advisor recommendations for one or multiple + # Amazon Redshift clusters in an Amazon Web Services account. + # + # @option params [String] :cluster_identifier + # 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. + # + # @option params [String] :namespace_arn + # 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. + # + # @option params [Integer] :max_records + # 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. + # + # @option params [String] :marker + # 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. + # + # @return [Types::ListRecommendationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListRecommendationsResult#recommendations #recommendations} => Array<Types::Recommendation> + # * {Types::ListRecommendationsResult#marker #marker} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_recommendations({ + # cluster_identifier: "String", + # namespace_arn: "String", + # max_records: 1, + # marker: "String", + # }) + # + # @example Response structure + # + # resp.recommendations #=> Array + # resp.recommendations[0].id #=> String + # resp.recommendations[0].cluster_identifier #=> String + # resp.recommendations[0].namespace_arn #=> String + # resp.recommendations[0].created_at #=> Time + # resp.recommendations[0].recommendation_type #=> String + # resp.recommendations[0].title #=> String + # resp.recommendations[0].description #=> String + # resp.recommendations[0].observation #=> String + # resp.recommendations[0].impact_ranking #=> String, one of "HIGH", "MEDIUM", "LOW" + # resp.recommendations[0].recommendation_text #=> String + # resp.recommendations[0].recommended_actions #=> Array + # resp.recommendations[0].recommended_actions[0].text #=> String + # resp.recommendations[0].recommended_actions[0].database #=> String + # resp.recommendations[0].recommended_actions[0].command #=> String + # resp.recommendations[0].recommended_actions[0].type #=> String, one of "SQL", "CLI" + # resp.recommendations[0].reference_links #=> Array + # resp.recommendations[0].reference_links[0].text #=> String + # resp.recommendations[0].reference_links[0].link #=> String + # resp.marker #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ListRecommendations AWS API Documentation + # + # @overload list_recommendations(params = {}) + # @param [Hash] params ({}) + def list_recommendations(params = {}, options = {}) + req = build_request(:list_recommendations, params) + req.send_request(options) + end + # This operation is retired. Calling this operation does not change AQUA # configuration. Amazon Redshift automatically determines whether to use # AQUA (Advanced Query Accelerator). @@ -12285,7 +12365,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-redshift' - context[:gem_version] = '1.108.0' + context[:gem_version] = '1.109.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client_api.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client_api.rb index e5c437d8387..a1ceb85f6cd 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client_api.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client_api.rb @@ -312,6 +312,7 @@ module ClientApi IamRoleArnList = Shapes::ListShape.new(name: 'IamRoleArnList') IdcDisplayNameString = Shapes::StringShape.new(name: 'IdcDisplayNameString') IdentityNamespaceString = Shapes::StringShape.new(name: 'IdentityNamespaceString') + ImpactRankingType = Shapes::StringShape.new(name: 'ImpactRankingType') ImportTablesCompleted = Shapes::ListShape.new(name: 'ImportTablesCompleted') ImportTablesInProgress = Shapes::ListShape.new(name: 'ImportTablesInProgress') ImportTablesNotStarted = Shapes::ListShape.new(name: 'ImportTablesNotStarted') @@ -363,6 +364,8 @@ module ClientApi LakeFormationScopeUnion = Shapes::UnionShape.new(name: 'LakeFormationScopeUnion') LakeFormationServiceIntegrations = Shapes::ListShape.new(name: 'LakeFormationServiceIntegrations') LimitExceededFault = Shapes::StructureShape.new(name: 'LimitExceededFault') + ListRecommendationsMessage = Shapes::StructureShape.new(name: 'ListRecommendationsMessage') + ListRecommendationsResult = Shapes::StructureShape.new(name: 'ListRecommendationsResult') LogDestinationType = Shapes::StringShape.new(name: 'LogDestinationType') LogTypeList = Shapes::ListShape.new(name: 'LogTypeList') LoggingStatus = Shapes::StructureShape.new(name: 'LoggingStatus') @@ -439,6 +442,11 @@ module ClientApi PutResourcePolicyResult = Shapes::StructureShape.new(name: 'PutResourcePolicyResult') RebootClusterMessage = Shapes::StructureShape.new(name: 'RebootClusterMessage') RebootClusterResult = Shapes::StructureShape.new(name: 'RebootClusterResult') + Recommendation = Shapes::StructureShape.new(name: 'Recommendation') + RecommendationList = Shapes::ListShape.new(name: 'RecommendationList') + RecommendedAction = Shapes::StructureShape.new(name: 'RecommendedAction') + RecommendedActionList = Shapes::ListShape.new(name: 'RecommendedActionList') + RecommendedActionType = Shapes::StringShape.new(name: 'RecommendedActionType') RecurringCharge = Shapes::StructureShape.new(name: 'RecurringCharge') RecurringChargeList = Shapes::ListShape.new(name: 'RecurringChargeList') RedshiftIdcApplication = Shapes::StructureShape.new(name: 'RedshiftIdcApplication') @@ -447,6 +455,8 @@ module ClientApi RedshiftIdcApplicationName = Shapes::StringShape.new(name: 'RedshiftIdcApplicationName') RedshiftIdcApplicationNotExistsFault = Shapes::StructureShape.new(name: 'RedshiftIdcApplicationNotExistsFault') RedshiftIdcApplicationQuotaExceededFault = Shapes::StructureShape.new(name: 'RedshiftIdcApplicationQuotaExceededFault') + ReferenceLink = Shapes::StructureShape.new(name: 'ReferenceLink') + ReferenceLinkList = Shapes::ListShape.new(name: 'ReferenceLinkList') RejectDataShareMessage = Shapes::StructureShape.new(name: 'RejectDataShareMessage') ReservedNode = Shapes::StructureShape.new(name: 'ReservedNode') ReservedNodeAlreadyExistsFault = Shapes::StructureShape.new(name: 'ReservedNodeAlreadyExistsFault') @@ -1960,6 +1970,16 @@ module ClientApi LimitExceededFault.struct_class = Types::LimitExceededFault + ListRecommendationsMessage.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "ClusterIdentifier")) + ListRecommendationsMessage.add_member(:namespace_arn, Shapes::ShapeRef.new(shape: String, location_name: "NamespaceArn")) + ListRecommendationsMessage.add_member(:max_records, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxRecords")) + ListRecommendationsMessage.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker")) + ListRecommendationsMessage.struct_class = Types::ListRecommendationsMessage + + ListRecommendationsResult.add_member(:recommendations, Shapes::ShapeRef.new(shape: RecommendationList, location_name: "Recommendations")) + ListRecommendationsResult.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker")) + ListRecommendationsResult.struct_class = Types::ListRecommendationsResult + LogTypeList.member = Shapes::ShapeRef.new(shape: String) LoggingStatus.add_member(:logging_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "LoggingEnabled")) @@ -2265,6 +2285,30 @@ module ClientApi RebootClusterResult.add_member(:cluster, Shapes::ShapeRef.new(shape: Cluster, location_name: "Cluster")) RebootClusterResult.struct_class = Types::RebootClusterResult + Recommendation.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "Id")) + Recommendation.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "ClusterIdentifier")) + Recommendation.add_member(:namespace_arn, Shapes::ShapeRef.new(shape: String, location_name: "NamespaceArn")) + Recommendation.add_member(:created_at, Shapes::ShapeRef.new(shape: TStamp, location_name: "CreatedAt")) + Recommendation.add_member(:recommendation_type, Shapes::ShapeRef.new(shape: String, location_name: "RecommendationType")) + Recommendation.add_member(:title, Shapes::ShapeRef.new(shape: String, location_name: "Title")) + Recommendation.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "Description")) + Recommendation.add_member(:observation, Shapes::ShapeRef.new(shape: String, location_name: "Observation")) + Recommendation.add_member(:impact_ranking, Shapes::ShapeRef.new(shape: ImpactRankingType, location_name: "ImpactRanking")) + Recommendation.add_member(:recommendation_text, Shapes::ShapeRef.new(shape: String, location_name: "RecommendationText")) + Recommendation.add_member(:recommended_actions, Shapes::ShapeRef.new(shape: RecommendedActionList, location_name: "RecommendedActions")) + Recommendation.add_member(:reference_links, Shapes::ShapeRef.new(shape: ReferenceLinkList, location_name: "ReferenceLinks")) + Recommendation.struct_class = Types::Recommendation + + RecommendationList.member = Shapes::ShapeRef.new(shape: Recommendation, location_name: "Recommendation") + + RecommendedAction.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text")) + RecommendedAction.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database")) + RecommendedAction.add_member(:command, Shapes::ShapeRef.new(shape: String, location_name: "Command")) + RecommendedAction.add_member(:type, Shapes::ShapeRef.new(shape: RecommendedActionType, location_name: "Type")) + RecommendedAction.struct_class = Types::RecommendedAction + + RecommendedActionList.member = Shapes::ShapeRef.new(shape: RecommendedAction, location_name: "RecommendedAction") + RecurringCharge.add_member(:recurring_charge_amount, Shapes::ShapeRef.new(shape: Double, location_name: "RecurringChargeAmount")) RecurringCharge.add_member(:recurring_charge_frequency, Shapes::ShapeRef.new(shape: String, location_name: "RecurringChargeFrequency")) RecurringCharge.struct_class = Types::RecurringCharge @@ -2291,6 +2335,12 @@ module ClientApi RedshiftIdcApplicationQuotaExceededFault.struct_class = Types::RedshiftIdcApplicationQuotaExceededFault + ReferenceLink.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text")) + ReferenceLink.add_member(:link, Shapes::ShapeRef.new(shape: String, location_name: "Link")) + ReferenceLink.struct_class = Types::ReferenceLink + + ReferenceLinkList.member = Shapes::ShapeRef.new(shape: ReferenceLink, location_name: "ReferenceLink") + RejectDataShareMessage.add_member(:data_share_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DataShareArn")) RejectDataShareMessage.struct_class = Types::RejectDataShareMessage @@ -4194,6 +4244,22 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationFault) end) + api.add_operation(:list_recommendations, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListRecommendations" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: ListRecommendationsMessage) + o.output = Shapes::ShapeRef.new(shape: ListRecommendationsResult) + o.errors << Shapes::ShapeRef.new(shape: ClusterNotFoundFault) + o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationFault) + o[:pager] = Aws::Pager.new( + limit_key: "max_records", + tokens: { + "marker" => "marker" + } + ) + end) + api.add_operation(:modify_aqua_configuration, Seahorse::Model::Operation.new.tap do |o| o.name = "ModifyAquaConfiguration" o.http_method = "POST" diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/endpoints.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/endpoints.rb index 60c11c9191e..5cf789cb9c8 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/endpoints.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/endpoints.rb @@ -1398,6 +1398,20 @@ def self.build(context) end end + class ListRecommendations + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::Redshift::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class ModifyAquaConfiguration def self.build(context) unless context.config.regional_endpoint diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/plugins/endpoints.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/plugins/endpoints.rb index ff0d23e1782..6fd1b71d7f7 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/plugins/endpoints.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/plugins/endpoints.rb @@ -256,6 +256,8 @@ def parameters_for_operation(context) Aws::Redshift::Endpoints::GetReservedNodeExchangeOfferings.build(context) when :get_resource_policy Aws::Redshift::Endpoints::GetResourcePolicy.build(context) + when :list_recommendations + Aws::Redshift::Endpoints::ListRecommendations.build(context) when :modify_aqua_configuration Aws::Redshift::Endpoints::ModifyAquaConfiguration.build(context) when :modify_authentication_profile diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb index 1972109c401..88fcc8855a4 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb @@ -7513,6 +7513,73 @@ class Unknown < LakeFormationScopeUnion; end # class LimitExceededFault < Aws::EmptyStructure; end + # @!attribute [rw] cluster_identifier + # 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. + # @return [String] + # + # @!attribute [rw] namespace_arn + # 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. + # @return [String] + # + # @!attribute [rw] max_records + # 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. + # @return [Integer] + # + # @!attribute [rw] marker + # 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. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ListRecommendationsMessage AWS API Documentation + # + class ListRecommendationsMessage < Struct.new( + :cluster_identifier, + :namespace_arn, + :max_records, + :marker) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] recommendations + # The Advisor recommendations for action on the Amazon Redshift + # cluster. + # @return [Array] + # + # @!attribute [rw] marker + # 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. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ListRecommendationsResult AWS API Documentation + # + class ListRecommendationsResult < Struct.new( + :recommendations, + :marker) + SENSITIVE = [] + include Aws::Structure + end + # Describes the status of logging for a cluster. # # @!attribute [rw] logging_enabled @@ -9204,6 +9271,111 @@ class RebootClusterResult < Struct.new( include Aws::Structure end + # An Amazon Redshift Advisor recommended action on the Amazon Redshift + # cluster. + # + # @!attribute [rw] id + # A unique identifier of the Advisor recommendation. + # @return [String] + # + # @!attribute [rw] cluster_identifier + # The unique identifier of the cluster for which the recommendation is + # returned. + # @return [String] + # + # @!attribute [rw] namespace_arn + # The Amazon Redshift cluster namespace ARN for which the + # recommendations is returned. + # @return [String] + # + # @!attribute [rw] created_at + # The date and time (UTC) that the recommendation was created. + # @return [Time] + # + # @!attribute [rw] recommendation_type + # The type of Advisor recommendation. + # @return [String] + # + # @!attribute [rw] title + # The title of the recommendation. + # @return [String] + # + # @!attribute [rw] description + # The description of the recommendation. + # @return [String] + # + # @!attribute [rw] observation + # The description of what was observed about your cluster. + # @return [String] + # + # @!attribute [rw] impact_ranking + # The scale of the impact that the Advisor recommendation has to the + # performance and cost of the cluster. + # @return [String] + # + # @!attribute [rw] recommendation_text + # The description of the recommendation. + # @return [String] + # + # @!attribute [rw] recommended_actions + # List of Amazon Redshift recommended actions. + # @return [Array] + # + # @!attribute [rw] reference_links + # List of helpful links for more information about the Advisor + # recommendation. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/Recommendation AWS API Documentation + # + class Recommendation < Struct.new( + :id, + :cluster_identifier, + :namespace_arn, + :created_at, + :recommendation_type, + :title, + :description, + :observation, + :impact_ranking, + :recommendation_text, + :recommended_actions, + :reference_links) + SENSITIVE = [] + include Aws::Structure + end + + # The recommended action from the Amazon Redshift Advisor + # recommendation. + # + # @!attribute [rw] text + # The specific instruction about the command. + # @return [String] + # + # @!attribute [rw] database + # The database name to perform the action on. Only applicable if the + # type of command is SQL. + # @return [String] + # + # @!attribute [rw] command + # The command to run. + # @return [String] + # + # @!attribute [rw] type + # The type of command. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RecommendedAction AWS API Documentation + # + class RecommendedAction < Struct.new( + :text, + :database, + :command, + :type) + SENSITIVE = [] + include Aws::Structure + end + # Describes a recurring charge. # # @!attribute [rw] recurring_charge_amount @@ -9312,6 +9484,26 @@ class RedshiftIdcApplicationNotExistsFault < Aws::EmptyStructure; end # class RedshiftIdcApplicationQuotaExceededFault < Aws::EmptyStructure; end + # A link to an Amazon Redshift Advisor reference for more information + # about a recommendation. + # + # @!attribute [rw] text + # The hyperlink text that describes the link to more information. + # @return [String] + # + # @!attribute [rw] link + # The URL address to find more information. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReferenceLink AWS API Documentation + # + class ReferenceLink < Struct.new( + :text, + :link) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] data_share_arn # The Amazon Resource Name (ARN) of the datashare to reject. # @return [String] diff --git a/gems/aws-sdk-redshift/sig/client.rbs b/gems/aws-sdk-redshift/sig/client.rbs index ba5afcdf1d3..b2b87e8560f 100644 --- a/gems/aws-sdk-redshift/sig/client.rbs +++ b/gems/aws-sdk-redshift/sig/client.rbs @@ -1563,6 +1563,20 @@ module Aws ) -> _GetResourcePolicyResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetResourcePolicyResponseSuccess + interface _ListRecommendationsResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::ListRecommendationsResult] + def recommendations: () -> ::Array[Types::Recommendation] + def marker: () -> ::String + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Redshift/Client.html#list_recommendations-instance_method + def list_recommendations: ( + ?cluster_identifier: ::String, + ?namespace_arn: ::String, + ?max_records: ::Integer, + ?marker: ::String + ) -> _ListRecommendationsResponseSuccess + | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRecommendationsResponseSuccess + interface _ModifyAquaConfigurationResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ModifyAquaOutputMessage] def aqua_configuration: () -> Types::AquaConfiguration diff --git a/gems/aws-sdk-redshift/sig/types.rbs b/gems/aws-sdk-redshift/sig/types.rbs index db8c42dbf6c..ce6ca39b3f5 100644 --- a/gems/aws-sdk-redshift/sig/types.rbs +++ b/gems/aws-sdk-redshift/sig/types.rbs @@ -1755,6 +1755,20 @@ module Aws::Redshift class LimitExceededFault < Aws::EmptyStructure end + class ListRecommendationsMessage + attr_accessor cluster_identifier: ::String + attr_accessor namespace_arn: ::String + attr_accessor max_records: ::Integer + attr_accessor marker: ::String + SENSITIVE: [] + end + + class ListRecommendationsResult + attr_accessor recommendations: ::Array[Types::Recommendation] + attr_accessor marker: ::String + SENSITIVE: [] + end + class LoggingStatus attr_accessor logging_enabled: bool attr_accessor bucket_name: ::String @@ -2147,6 +2161,30 @@ module Aws::Redshift SENSITIVE: [] end + class Recommendation + attr_accessor id: ::String + attr_accessor cluster_identifier: ::String + attr_accessor namespace_arn: ::String + attr_accessor created_at: ::Time + attr_accessor recommendation_type: ::String + attr_accessor title: ::String + attr_accessor description: ::String + attr_accessor observation: ::String + attr_accessor impact_ranking: ("HIGH" | "MEDIUM" | "LOW") + attr_accessor recommendation_text: ::String + attr_accessor recommended_actions: ::Array[Types::RecommendedAction] + attr_accessor reference_links: ::Array[Types::ReferenceLink] + SENSITIVE: [] + end + + class RecommendedAction + attr_accessor text: ::String + attr_accessor database: ::String + attr_accessor command: ::String + attr_accessor type: ("SQL" | "CLI") + SENSITIVE: [] + end + class RecurringCharge attr_accessor recurring_charge_amount: ::Float attr_accessor recurring_charge_frequency: ::String @@ -2176,6 +2214,12 @@ module Aws::Redshift class RedshiftIdcApplicationQuotaExceededFault < Aws::EmptyStructure end + class ReferenceLink + attr_accessor text: ::String + attr_accessor link: ::String + SENSITIVE: [] + end + class RejectDataShareMessage attr_accessor data_share_arn: ::String SENSITIVE: []