Activates an DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.
You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.
You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.
Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
", "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 access for a transfer. For more information, see Creating a location for FSx for ONTAP.
", "CreateLocationFsxOpenZfs": "Creates an endpoint for an Amazon FSx for OpenZFS file system.
", "CreateLocationFsxWindows": "Creates an endpoint for an Amazon FSx for Windows File Server file system.
", "CreateLocationHdfs": "Creates an endpoint for a Hadoop Distributed File System (HDFS).
", "CreateLocationNfs": "Defines a file system on a Network File System (NFS) server that can be read from or written to.
", - "CreateLocationObjectStorage": "Creates an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see Creating a location for object storage.
", + "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": "Creates an endpoint for an Amazon S3 bucket.
For more information, see Create an Amazon S3 location in the DataSync User Guide.
", "CreateLocationSmb": "Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
", "CreateTask": "Creates a task.
A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.
When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.
You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions.
When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
", "DescribeLocationEfs": "Returns metadata about your DataSync location for an Amazon EFS file system.
", "DescribeLocationFsxLustre": "Returns metadata about an Amazon FSx for Lustre location, such as information about its path.
", + "DescribeLocationFsxOntap": "Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
", "DescribeLocationFsxOpenZfs": "Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.
", "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.
", "DescribeLocationNfs": "Returns metadata, such as the path information, about an NFS location.
", - "DescribeLocationObjectStorage": "Returns metadata about a self-managed object storage server location. For more information about self-managed object storage locations, see Creating a location for object storage.
", + "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.
", "DescribeTask": "Returns metadata about a task.
", @@ -68,11 +70,11 @@ "base": null, "refs": { "CreateLocationHdfsRequest$AgentArns": "The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
", - "CreateLocationObjectStorageRequest$AgentArns": "The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
", + "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.
", "CreateLocationSmbRequest$AgentArns": "The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
", "DescribeLocationHdfsResponse$AgentArns": "The ARNs of the agents that are used to connect to the HDFS cluster.
", - "DescribeLocationObjectStorageResponse$AgentArns": "The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
", + "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.
", "OnPremConfig$AgentArns": "ARNs of the agents to use for an NFS location.
", @@ -103,7 +105,7 @@ "Atime": { "base": null, "refs": { - "Options$Atime": "A file metadata value that shows the last time a file was accessed (that is, when the 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). However, Atime's behavior is not 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.
A file metadata value that shows the last time a file was accessed (that is, when the 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). However, Atime's behavior is not 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.
The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.
", + "CreateLocationFsxOntapRequest$SecurityGroupArns": "Specifies the security groups that DataSync can use to access your FSx for ONTAP file system. You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you're using):
Network File System (NFS): TCP port 2049
Server Message Block (SMB): TCP port 445
Your file system's security groups must also allow inbound traffic on the same port.
", "CreateLocationFsxOpenZfsRequest$SecurityGroupArns": "The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
", "CreateLocationFsxWindowsRequest$SecurityGroupArns": "The ARNs of the security groups that are used to configure the FSx for Windows File Server file system.
", "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.
", "Ec2Config$SecurityGroupArns": "Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.
" @@ -446,8 +470,8 @@ "EfsInTransitEncryption": { "base": null, "refs": { - "CreateLocationEfsRequest$InTransitEncryption": "Specifies whether you want DataSync to use TLS encryption when transferring data to or from your Amazon EFS file system.
If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.
Whether DataSync uses TLS encryption when transferring data to or from your Amazon EFS file system.
" + "CreateLocationEfsRequest$InTransitEncryption": "Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.
If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.
Describes whether DataSync uses Transport Layer Security (TLS) encryption when copying data to or from the Amazon EFS file system.
" } }, "EfsSubdirectory": { @@ -519,7 +543,8 @@ "refs": { "CreateLocationFsxLustreRequest$FsxFilesystemArn": "The Amazon Resource Name (ARN) for the FSx for Lustre file system.
", "CreateLocationFsxOpenZfsRequest$FsxFilesystemArn": "The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
", - "CreateLocationFsxWindowsRequest$FsxFilesystemArn": "The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
" + "CreateLocationFsxWindowsRequest$FsxFilesystemArn": "The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
", + "DescribeLocationFsxOntapResponse$FsxFilesystemArn": "The ARN of the FSx for ONTAP file system.
" } }, "FsxLustreSubdirectory": { @@ -528,6 +553,12 @@ "CreateLocationFsxLustreRequest$Subdirectory": "A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.
" } }, + "FsxOntapSubdirectory": { + "base": null, + "refs": { + "CreateLocationFsxOntapRequest$Subdirectory": "Specifies the junction path (also known as a mount point) in the SVM volume where you're copying data to or from (for example, /vol1).
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
Represents the protocol that DataSync uses to access your Amazon FSx for OpenZFS file system.
", + "base": "Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
", "refs": { + "CreateLocationFsxOntapRequest$Protocol": null, "CreateLocationFsxOpenZfsRequest$Protocol": "The type of protocol that DataSync uses to access your file system.
", + "DescribeLocationFsxOntapResponse$Protocol": null, "DescribeLocationFsxOpenZfsResponse$Protocol": "The type of protocol that DataSync uses to access your file system.
" } }, "FsxProtocolNfs": { - "base": "Represents the Network File System (NFS) protocol that DataSync uses to access your Amazon FSx for OpenZFS file system.
", + "base": "Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your Amazon FSx for OpenZFS or Amazon FSx for NetApp ONTAP file system.
", "refs": { - "FsxProtocol$NFS": "Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system.
" + "FsxProtocol$NFS": "Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).
" + } + }, + "FsxProtocolSmb": { + "base": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see Accessing FSx for ONTAP file systems.
", + "refs": { + "FsxProtocol$SMB": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
" } }, "FsxWindowsSubdirectory": { @@ -556,7 +595,7 @@ "Gid": { "base": null, "refs": { - "Options$Gid": "The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, 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": "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.
The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.
Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
", "CreateLocationFsxLustreRequest$Tags": "The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
", + "CreateLocationFsxOntapRequest$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.
", "CreateLocationFsxOpenZfsRequest$Tags": "The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
", "CreateLocationFsxWindowsRequest$Tags": "The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
", "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": "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.
", - "CreateLocationObjectStorageRequest$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.
", + "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.
", "CreateLocationSmbRequest$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.
", "CreateTaskRequest$Tags": "The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.
", @@ -756,11 +796,12 @@ "refs": { "CreateLocationEfsResponse$LocationArn": "The Amazon Resource Name (ARN) of the Amazon EFS file system location that you create.
", "CreateLocationFsxLustreResponse$LocationArn": "The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's created.
", + "CreateLocationFsxOntapResponse$LocationArn": "Specifies the ARN of the FSx for ONTAP file system location that you create.
", "CreateLocationFsxOpenZfsResponse$LocationArn": "The ARN of the FSx for OpenZFS file system location that you created.
", "CreateLocationFsxWindowsResponse$LocationArn": "The Amazon Resource Name (ARN) of the FSx for Windows File Server file system location you created.
", "CreateLocationHdfsResponse$LocationArn": "The ARN of the source HDFS cluster location that's created.
", "CreateLocationNfsResponse$LocationArn": "The Amazon Resource Name (ARN) of the source NFS file system location that is created.
", - "CreateLocationObjectStorageResponse$LocationArn": "The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
", + "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.
", "CreateLocationSmbResponse$LocationArn": "The Amazon Resource Name (ARN) of the source SMB file system location that is created.
", "CreateTaskRequest$SourceLocationArn": "The Amazon Resource Name (ARN) of the source location for the task.
", @@ -770,6 +811,8 @@ "DescribeLocationEfsResponse$LocationArn": "The ARN of the Amazon EFS file system location.
", "DescribeLocationFsxLustreRequest$LocationArn": "The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.
", "DescribeLocationFsxLustreResponse$LocationArn": "The Amazon Resource Name (ARN) of the FSx for Lustre location that was described.
", + "DescribeLocationFsxOntapRequest$LocationArn": "Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.
", + "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.
", @@ -778,8 +821,8 @@ "DescribeLocationHdfsResponse$LocationArn": "The ARN of the HDFS cluster location.
", "DescribeLocationNfsRequest$LocationArn": "The Amazon Resource Name (ARN) of the NFS location to describe.
", "DescribeLocationNfsResponse$LocationArn": "The Amazon Resource Name (ARN) of the NFS location that was described.
", - "DescribeLocationObjectStorageRequest$LocationArn": "The Amazon Resource Name (ARN) of the self-managed object storage server location that was described.
", - "DescribeLocationObjectStorageResponse$LocationArn": "The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.
", + "DescribeLocationObjectStorageRequest$LocationArn": "The Amazon Resource Name (ARN) of the object storage system location that you want information about.
", + "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.
", @@ -828,11 +871,12 @@ "refs": { "DescribeLocationEfsResponse$LocationUri": "The URL of the Amazon EFS file system location.
", "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
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 source NFS location that was described.
", - "DescribeLocationObjectStorageResponse$LocationUri": "The URL of the source self-managed object storage server location that was described.
", + "DescribeLocationObjectStorageResponse$LocationUri": "The URL 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.
", "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.
" @@ -865,7 +909,7 @@ "Mtime": { "base": null, "refs": { - "Options$Mtime": "A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
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.
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
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.
Represents the mount options that are available for DataSync to access an NFS location.
", + "base": "Specifies how DataSync can access a location using the NFS protocol.
", "refs": { "CreateLocationNfsRequest$MountOptions": "The NFS mount options that DataSync can use to mount your NFS share.
", "DescribeLocationNfsResponse$MountOptions": "The NFS mount options that DataSync used to mount your NFS share.
", @@ -909,43 +953,43 @@ "NfsVersion": { "base": null, "refs": { - "NfsMountOptions$Version": "The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the NFS server.
You can specify the following NFS versions:
NFSv3 - stateless protocol version that allows for asynchronous writes on the server.
NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.
Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.
You can specify the following options:
AUTOMATIC (default): DataSync chooses NFS version 4.1.
NFS3: Stateless protocol version that allows for asynchronous writes on the server.
NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.
Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
", + "DescribeLocationObjectStorageResponse$AccessKey": "The access key (for example, a user name) required to authenticate with the object storage server.
", "UpdateLocationObjectStorageRequest$AccessKey": "Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.
The bucket on the self-managed object storage server that is used to read data from.
" + "CreateLocationObjectStorageRequest$BucketName": "Specifies the name of the object storage bucket involved in the transfer.
" } }, "ObjectStorageSecretKey": { "base": null, "refs": { - "CreateLocationObjectStorageRequest$SecretKey": "Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
", "UpdateLocationObjectStorageRequest$SecretKey": "Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.
The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
", - "DescribeLocationObjectStorageResponse$ServerPort": "The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).
", + "CreateLocationObjectStorageRequest$ServerPort": "Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
", + "DescribeLocationObjectStorageResponse$ServerPort": "The port that your object storage server accepts inbound network traffic on (for example, port 443).
", "UpdateLocationObjectStorageRequest$ServerPort": "The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
" } }, "ObjectStorageServerProtocol": { "base": null, "refs": { - "CreateLocationObjectStorageRequest$ServerProtocol": "The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
", - "DescribeLocationObjectStorageResponse$ServerProtocol": "The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
", + "CreateLocationObjectStorageRequest$ServerProtocol": "Specifies the protocol that your object storage server uses to communicate.
", + "DescribeLocationObjectStorageResponse$ServerProtocol": "The protocol that your object storage server uses to communicate.
", "UpdateLocationObjectStorageRequest$ServerProtocol": "The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, 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.
A value that determines 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.
A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your 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 in the DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
" + "Options$PreserveDeletedFiles": "A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your 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 in the DataSync User Guide.
Default value: PRESERVE
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
DataSync can't sync the actual contents of such devices, because they are 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 isn't currently supported for Amazon EFS.
" + "Options$PreserveDevices": "A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
DataSync can't sync the actual contents of such devices, because they are 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 isn't currently supported for Amazon EFS.
The subdirectory in the self-managed object storage server that is used to read data from.
", + "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.
", "UpdateLocationObjectStorageRequest$Subdirectory": "The subdirectory in the self-managed object storage server that is used to read data from.
" } @@ -1085,7 +1129,7 @@ "base": null, "refs": { "CreateLocationNfsRequest$ServerHostname": "The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this hostname to mount the NFS server in a network.
If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.
This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this hostname to mount the object storage server in a network.
", + "CreateLocationObjectStorageRequest$ServerHostname": "Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.
", "CreateLocationSmbRequest$ServerHostname": "The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.
This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
The name of the Windows domain that the SMB server belongs to.
", "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.
", "UpdateLocationSmbRequest$Domain": "The name of the Windows domain that the SMB server belongs to.
" } }, "SmbMountOptions": { - "base": "Represents the mount options that are available for DataSync to access an SMB location.
", + "base": "Specifies how DataSync can access a location using the SMB protocol.
", "refs": { "CreateLocationSmbRequest$MountOptions": "The mount options used by DataSync to access the SMB server.
", "DescribeLocationSmbResponse$MountOptions": "The mount options that are available for DataSync to use to access an SMB location.
", + "FsxProtocolSmb$MountOptions": null, "UpdateLocationSmbRequest$MountOptions": null } }, @@ -1112,13 +1158,14 @@ "refs": { "CreateLocationFsxWindowsRequest$Password": "The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.
", "CreateLocationSmbRequest$Password": "The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.
", + "FsxProtocolSmb$Password": "Specifies the password of a user who has permission to access your SVM.
", "UpdateLocationSmbRequest$Password": "The password of the user who can mount the share has the permissions to access files and folders in the SMB share.
" } }, "SmbSecurityDescriptorCopyFlags": { "base": null, "refs": { - "Options$SecurityDescriptorCopyFlags": "A value that determines 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 Amazon FSx for Windows File Server locations. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
Default value: OWNER_DACL.
OWNER_DACL: For each copied object, DataSync copies the following metadata:
Object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
Object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
NTFS system access control lists (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.
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": "A value that determines 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 Amazon FSx for Windows File Server locations. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
Default value: OWNER_DACL
OWNER_DACL: For each copied object, DataSync copies the following metadata:
Object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
Object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
NTFS system access control lists (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.
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.
The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
", - "CreateLocationSmbRequest$User": "The user who can mount the share, has the permissions to access files and folders in the SMB share.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
", + "CreateLocationSmbRequest$User": "The user who can mount the share, has the permissions to access files and folders in the SMB share.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see the User setting 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 who has permission to access your SVM.
", "UpdateLocationSmbRequest$User": "The user who can mount the share has the permissions to access files and folders in the SMB share.
" } }, "SmbVersion": { "base": null, "refs": { - "SmbMountOptions$Version": "The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the SMB server.
Specifies the SMB version that you want DataSync to use when mounting your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC and chooses a version based on negotiation with the SMB server.
Specifies the ARN of the storage virtual machine (SVM) on your file system where you're copying data to or from.
", + "DescribeLocationFsxOntapResponse$StorageVirtualMachineArn": "The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.
" + } + }, "TagKey": { "base": null, "refs": { @@ -1320,11 +1375,12 @@ "DescribeAgentResponse$CreationTime": "The time that the agent was activated (that is, created in your account).
", "DescribeLocationEfsResponse$CreationTime": "The time that the location was created.
", "DescribeLocationFsxLustreResponse$CreationTime": "The time that the FSx for Lustre location was created.
", + "DescribeLocationFsxOntapResponse$CreationTime": "The time that the location was created.
", "DescribeLocationFsxOpenZfsResponse$CreationTime": "The time that the FSx for OpenZFS location was created.
", "DescribeLocationFsxWindowsResponse$CreationTime": "The time that the FSx for Windows File Server location was created.
", "DescribeLocationHdfsResponse$CreationTime": "The time that the HDFS location was created.
", "DescribeLocationNfsResponse$CreationTime": "The time that the NFS location was created.
", - "DescribeLocationObjectStorageResponse$CreationTime": "The time that the self-managed object storage server agent was created.
", + "DescribeLocationObjectStorageResponse$CreationTime": "The time that the location was created.
", "DescribeLocationS3Response$CreationTime": "The time that the Amazon S3 bucket location was created.
", "DescribeLocationSmbResponse$CreationTime": "The time that the SMB location was created.
", "DescribeTaskExecutionResponse$StartTime": "The time that the task execution was started.
", @@ -1334,13 +1390,13 @@ "TransferMode": { "base": null, "refs": { - "Options$TransferMode": "A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.
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 to existing content on the destination.
" + "Options$TransferMode": "A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.
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 to existing content on the destination.
The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, 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": "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.
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
Default value: POINT_IN_TIME_CONSISTENT.
ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes.
NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
" + "Options$VerifyMode": "A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
Default value: POINT_IN_TIME_CONSISTENT
ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes.
NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
", "CreateReservedInstancesListing": "Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
", "CreateRestoreImageTask": "Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
", - "CreateRoute": "Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
", + "CreateRoute": "Creates a route in a route table within a VPC.
You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
", "CreateRouteTable": "Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
", "CreateSecurityGroup": "Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
For more information about VPC security group limits, see Amazon VPC Limits.
", "CreateSnapshot": "Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
", @@ -105,7 +105,7 @@ "CreateTransitGatewayConnect": "Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
", "CreateTransitGatewayConnectPeer": "Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide.
", "CreateTransitGatewayMulticastDomain": "Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
", - "CreateTransitGatewayPeeringAttachment": "Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
", + "CreateTransitGatewayPeeringAttachment": "Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
", "CreateTransitGatewayPrefixListReference": "Creates a reference (route) to a prefix list in a specified transit gateway route table.
", "CreateTransitGatewayRoute": "Creates a static route for the specified transit gateway route table.
", "CreateTransitGatewayRouteTable": "Creates a route table for the specified transit gateway.
", @@ -479,13 +479,13 @@ "RejectTransitGatewayVpcAttachment": "Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.
Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
", "RejectVpcPeeringConnection": "Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.
Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
", + "ReleaseAddress": "Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
", "ReleaseHosts": "When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.
Released hosts still appear in a DescribeHosts response.
", "ReleaseIpamPoolAllocation": "Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.
", "ReplaceIamInstanceProfileAssociation": "Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
", "ReplaceNetworkAclAssociation": "Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
This is an idempotent operation.
", "ReplaceNetworkAclEntry": "Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
", - "ReplaceRoute": "Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
", + "ReplaceRoute": "Replaces an existing route within a route table in a VPC.
You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
", "ReplaceRouteTableAssociation": "Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.
", "ReplaceTransitGatewayRoute": "Replaces the specified route in the specified transit gateway route table.
", "ReportInstanceStatus": "Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
", @@ -985,7 +985,7 @@ "PathComponent$SourceVpc": "The source VPC.
", "PathComponent$Subnet": "The subnet.
", "PathComponent$Vpc": "The component VPC.
", - "PathComponent$TransitGateway": null + "PathComponent$TransitGateway": "The transit gateway.
" } }, "AnalysisComponentList": { @@ -1688,7 +1688,7 @@ "CancelSpotFleetRequestsRequest$TerminateInstances": "Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
", "CancelSpotInstanceRequestsRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
", - "CapacityReservation$EphemeralStorage": "Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
", + "CapacityReservation$EphemeralStorage": "Deprecated.
", "ClassicLinkDnsSupport$ClassicLinkDnsSupported": "Indicates whether ClassicLink DNS support is enabled for the VPC.
", "ClientConnectOptions$Enabled": "Indicates whether client connect options are enabled. The default is false (not enabled).
Indicates whether client connect options are enabled.
", @@ -1706,7 +1706,7 @@ "CopySnapshotRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
", - "CreateCapacityReservationRequest$EphemeralStorage": "Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
", + "CreateCapacityReservationRequest$EphemeralStorage": "Deprecated.
", "CreateCapacityReservationRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
", @@ -4159,7 +4159,7 @@ "CreditSpecificationRequest": { "base": "The credit option for CPU usage of a T2, T3, or T3a instance.
", "refs": { - "RequestLaunchTemplateData$CreditSpecification": "The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.
", + "RequestLaunchTemplateData$CreditSpecification": "The credit option for CPU usage of the instance. Valid only for T instances.
", "RunInstancesRequest$CreditSpecification": "The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a instances)
For T3 instances with host tenancy, only standard is supported.
One or more filters.
owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list.
prefix-list-name - The name of the prefix list.
One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
One or more filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.egress - A Boolean that indicates the type of rule. Specify true for egress rules, or false for ingress rules.
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
There are no supported filters.
", "DescribeNetworkInsightsAccessScopesRequest$Filters": "There are no supported filters.
", "DescribeNetworkInsightsAnalysesRequest$Filters": "The filters. The following are the possible values:
PathFound - A Boolean value that indicates whether a feasible path is found.
Status - The status of the analysis (running | succeeded | failed).
The filters. The following are the possible values:
Destination - The ID of the resource.
DestinationPort - The destination port.
Name - The path name.
Protocol - The protocol.
Source - The ID of the resource.
One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The Amazon Web Services account ID.
network-interface-permission.aws-service - The Amazon Web Service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
spread-level - The spread level for the placement group (host | rack).
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
One or more filters.
prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.
One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
region-name - The name of the Region (for example, us-east-1).
The tag specification for the launch template.
", + "base": "The tags specification for the launch template.
", "refs": { "LaunchTemplateTagSpecificationList$member": null } @@ -11776,11 +11776,11 @@ "LaunchTemplateTagSpecificationList": { "base": null, "refs": { - "ResponseLaunchTemplateData$TagSpecifications": "The tags.
" + "ResponseLaunchTemplateData$TagSpecifications": "The tags that are applied to the resources that are created during instance launch.
" } }, "LaunchTemplateTagSpecificationRequest": { - "base": "The tags specification for the launch template.
", + "base": "The tags specification for the resources that are created during instance launch.
", "refs": { "LaunchTemplateTagSpecificationRequestList$member": null } @@ -11788,7 +11788,7 @@ "LaunchTemplateTagSpecificationRequestList": { "base": null, "refs": { - "RequestLaunchTemplateData$TagSpecifications": "The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
" + "RequestLaunchTemplateData$TagSpecifications": "The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces
To tag a resource after it has been created, see CreateTags.
To tag the launch template itself, you must use the TagSpecification parameter.
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SDD) storage, specify sdd.
Default: hdd and sdd
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SDD) storage, specify sdd.
Default: hdd and sdd
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SSD) storage, specify ssd.
Default: hdd and ssd
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SSD) storage, specify ssd.
Default: hdd and ssd
The type of resource.
", - "LaunchTemplateTagSpecificationRequest$ResourceType": "The type of resource to tag. Currently, the resource types that support tagging on creation are instance, volume, elastic-gpu, network-interface, and spot-instances-request. To tag a resource after it has been created, see CreateTags.
The type of resource to tag.
", + "LaunchTemplateTagSpecificationRequest$ResourceType": "The type of resource to tag.
The Valid Values are all the resource types that can be tagged. However, when creating a launch template, you can specify tags for the following resource types only: instance | volume | elastic-gpu | network-interface | spot-instances-request
To tag a resource after it has been created, see CreateTags.
", "SpotFleetTagSpecification$ResourceType": "The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData .
The resource type.
", "TagSpecification$ResourceType": "The type of resource to tag on creation.
" @@ -16242,6 +16242,13 @@ "DescribeSpotPriceHistoryResult$SpotPriceHistory": "The historical Spot prices.
" } }, + "SpreadLevel": { + "base": null, + "refs": { + "CreatePlacementGroupRequest$SpreadLevel": "Determines how placement groups spread instances.
Host – You can use host only with Outpost placement groups.
Rack – No usage restrictions.
The spread level for the placement group. Only Outpost placement groups can be spread across hosts.
" + } + }, "StaleIpPermission": { "base": "Describes a stale rule in a security group.
", "refs": { @@ -17052,7 +17059,7 @@ "EnableFastSnapshotRestoreSuccessItem$OwnerAlias": "The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
", "EnableIpamOrganizationAdminAccountRequest$DelegatedAdminAccountId": "The Organizations member account ID that you want to enable as the IPAM account.
", "EventInformation$EventDescription": "The description of the event.
", - "EventInformation$EventSubType": "The event.
error events:
iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.
allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.
spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot Instances that you can launch.
spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.
fleetRequestChange events:
active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.
cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.
cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.
cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.
expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.
modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.
modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.
progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
instanceChange events:
launched - A new instance was launched.
terminated - An instance was terminated by the user.
termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.
Information events:
fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.
launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.
launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.
registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.
The event.
error events:
iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.
allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.
spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot Instances that you can launch.
spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.
fleetRequestChange events:
active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.
deleted (EC2 Fleet) / cancelled (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.
deleted_running (EC2 Fleet) / cancelled_running (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.
deleted_terminating (EC2 Fleet) / cancelled_terminating (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.
expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.
modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.
modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.
progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
instanceChange events:
launched - A new instance was launched.
terminated - An instance was terminated by the user.
termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.
Information events:
fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.
launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.
launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.
registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.
The ID of the instance. This information is available only for instanceChange events.
The direction. The following are the possible values:
egress
ingress
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The tags to apply to the new key pair.
", - "CreateLaunchTemplateRequest$TagSpecifications": "The tags to apply to the launch template during creation.
", + "CreateLaunchTemplateRequest$TagSpecifications": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.
To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the launch template data structure.
The tags to assign to the local gateway route table VPC association.
", "CreateManagedPrefixListRequest$TagSpecifications": "The tags to apply to the prefix list during creation.
", "CreateNatGatewayRequest$TagSpecifications": "The tags to assign to the NAT gateway.
", diff --git a/models/apis/finspace-data/2020-07-13/api-2.json b/models/apis/finspace-data/2020-07-13/api-2.json index 30f8414a528..b9f3b69eec2 100644 --- a/models/apis/finspace-data/2020-07-13/api-2.json +++ b/models/apis/finspace-data/2020-07-13/api-2.json @@ -255,6 +255,22 @@ {"shape":"ConflictException"} ] }, + "GetExternalDataViewAccessDetails":{ + "name":"GetExternalDataViewAccessDetails", + "http":{ + "method":"POST", + "requestUri":"/datasets/{datasetId}/dataviewsv2/{dataviewId}/external-access-details" + }, + "input":{"shape":"GetExternalDataViewAccessDetailsRequest"}, + "output":{"shape":"GetExternalDataViewAccessDetailsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ] + }, "GetPermissionGroup":{ "name":"GetPermissionGroup", "http":{ @@ -523,6 +539,12 @@ "error":{"httpStatusCode":403}, "exception":true }, + "AccessKeyId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\s\\S]*\\S[\\s\\S]*" + }, "AliasString":{ "type":"string", "max":255, @@ -584,6 +606,15 @@ } } }, + "AwsCredentials":{ + "type":"structure", + "members":{ + "accessKeyId":{"shape":"AccessKeyId"}, + "secretAccessKey":{"shape":"SecretAccessKey"}, + "sessionToken":{"shape":"SessionToken"}, + "expiration":{"shape":"TimestampEpoch"} + } + }, "Boolean":{"type":"boolean"}, "ChangeType":{ "type":"string", @@ -1230,6 +1261,32 @@ "status":{"shape":"DatasetStatus"} } }, + "GetExternalDataViewAccessDetailsRequest":{ + "type":"structure", + "required":[ + "dataViewId", + "datasetId" + ], + "members":{ + "dataViewId":{ + "shape":"DataViewId", + "location":"uri", + "locationName":"dataviewId" + }, + "datasetId":{ + "shape":"DatasetId", + "location":"uri", + "locationName":"datasetId" + } + } + }, + "GetExternalDataViewAccessDetailsResponse":{ + "type":"structure", + "members":{ + "credentials":{"shape":"AwsCredentials"}, + "s3Location":{"shape":"S3Location"} + } + }, "GetPermissionGroupRequest":{ "type":"structure", "required":["permissionGroupId"], @@ -1679,11 +1736,34 @@ "min":20, "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, + "S3BucketName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^.*\\S.*$" + }, "S3DestinationFormatOptions":{ "type":"map", "key":{"shape":"StringMapKey"}, "value":{"shape":"StringMapValue"} }, + "S3Key":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^.*\\S.*$" + }, + "S3Location":{ + "type":"structure", + "required":[ + "bucket", + "key" + ], + "members":{ + "bucket":{"shape":"S3BucketName"}, + "key":{"shape":"S3Key"} + } + }, "SchemaDefinition":{ "type":"structure", "members":{ @@ -1697,11 +1777,25 @@ "tabularSchemaConfig":{"shape":"SchemaDefinition"} } }, + "SecretAccessKey":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"[\\s\\S]*\\S[\\s\\S]*", + "sensitive":true + }, "SessionDuration":{ "type":"long", "max":720, "min":60 }, + "SessionToken":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"[\\s\\S]*\\S[\\s\\S]*", + "sensitive":true + }, "SortColumnList":{ "type":"list", "member":{"shape":"StringValueLength1to255"} diff --git a/models/apis/finspace-data/2020-07-13/docs-2.json b/models/apis/finspace-data/2020-07-13/docs-2.json index c0685c5f580..1a1d3178cbd 100644 --- a/models/apis/finspace-data/2020-07-13/docs-2.json +++ b/models/apis/finspace-data/2020-07-13/docs-2.json @@ -16,6 +16,7 @@ "GetChangeset": "Get information about a Changeset.
", "GetDataView": "Gets information about a Dataview.
", "GetDataset": "Returns information about a Dataset.
", + "GetExternalDataViewAccessDetails": "Returns the credentials to access the external Dataview from an S3 location. To call this API:
You must retrieve the programmatic credentials.
You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.
Retrieves the details of a specific permission group.
", "GetProgrammaticAccessCredentials": "Request programmatic credentials to use with FinSpace SDK.
", "GetUser": "Retrieves details for a specific user.
", @@ -39,6 +40,12 @@ "refs": { } }, + "AccessKeyId": { + "base": null, + "refs": { + "AwsCredentials$accessKeyId": "The unique identifier for the security credentials.
" + } + }, "AliasString": { "base": null, "refs": { @@ -67,9 +74,9 @@ "ApplicationPermissionList": { "base": null, "refs": { - "CreatePermissionGroupRequest$applicationPermissions": "The option to indicate FinSpace application permissions that are granted to a specific group.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
The permissions that are granted to a specific group for accessing the FinSpace application.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
The option to indicate FinSpace application permissions that are granted to a specific group.
When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
The permissions that are granted to a specific group for accessing the FinSpace application.
When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
The credentials required to access the external Dataview from the S3 location.
", + "refs": { + "GetExternalDataViewAccessDetailsResponse$credentials": "The credentials required to access the external Dataview from the S3 location.
" + } + }, "Boolean": { "base": "Common Boolean data type", "refs": { @@ -292,7 +305,8 @@ "CreateDataViewResponse$dataViewId": "The unique identifier for the created Dataview.
", "DataViewSummary$dataViewId": "The unique identifier for the Dataview.
", "GetDataViewRequest$dataViewId": "The unique identifier for the Dataview.
", - "GetDataViewResponse$dataViewId": "The unique identifier for the Dataview.
" + "GetDataViewResponse$dataViewId": "The unique identifier for the Dataview.
", + "GetExternalDataViewAccessDetailsRequest$dataViewId": "The unique identifier for the Dataview that you want to access.
" } }, "DataViewList": { @@ -354,6 +368,7 @@ "GetDataViewRequest$datasetId": "The unique identifier for the Dataset used in the Dataview.
", "GetDataViewResponse$datasetId": "The unique identifier for the Dataset used in the Dataview.
", "GetDatasetResponse$datasetId": "The unique identifier for a Dataset.
", + "GetExternalDataViewAccessDetailsRequest$datasetId": "The unique identifier for the Dataset.
", "ListChangesetsRequest$datasetId": "The unique identifier for the FinSpace Dataset to which the Changeset belongs.
", "ListDataViewsRequest$datasetId": "The unique identifier of the Dataset for which to retrieve Dataviews.
", "UpdateChangesetRequest$datasetId": "The unique identifier for the FinSpace Dataset in which the Changeset is created.
", @@ -528,6 +543,16 @@ "refs": { } }, + "GetExternalDataViewAccessDetailsRequest": { + "base": null, + "refs": { + } + }, + "GetExternalDataViewAccessDetailsResponse": { + "base": null, + "refs": { + } + }, "GetPermissionGroupRequest": { "base": null, "refs": { @@ -838,12 +863,30 @@ "UserByPermissionGroup$apiAccessPrincipalArn": "The IAM ARN identifier that is attached to FinSpace API calls.
" } }, + "S3BucketName": { + "base": null, + "refs": { + "S3Location$bucket": "The name of the S3 bucket.
" + } + }, "S3DestinationFormatOptions": { "base": null, "refs": { "DataViewDestinationTypeParams$s3DestinationExportFileFormatOptions": "Format Options for S3 Destination type.
Here is an example of how you could specify the s3DestinationExportFileFormatOptions
{ \"header\": \"true\", \"delimiter\": \",\", \"compression\": \"gzip\" }
The path of the folder, within the S3 bucket that contains the Dataset.
" + } + }, + "S3Location": { + "base": "The location of an external Dataview in an S3 bucket.
", + "refs": { + "GetExternalDataViewAccessDetailsResponse$s3Location": "The location where the external Dataview is stored.
" + } + }, "SchemaDefinition": { "base": "Definition for a schema on a tabular Dataset.
", "refs": { @@ -859,6 +902,12 @@ "UpdateDatasetRequest$schemaDefinition": "Definition for a schema on a tabular Dataset.
" } }, + "SecretAccessKey": { + "base": null, + "refs": { + "AwsCredentials$secretAccessKey": "The secret access key that can be used to sign requests.
" + } + }, "SessionDuration": { "base": null, "refs": { @@ -866,6 +915,12 @@ "GetProgrammaticAccessCredentialsResponse$durationInMinutes": "Returns the duration in which the credentials will remain valid.
" } }, + "SessionToken": { + "base": null, + "refs": { + "AwsCredentials$sessionToken": "The token that users must pass to use the credentials.
" + } + }, "SortColumnList": { "base": "DataView Sort Column List", "refs": { @@ -928,6 +983,7 @@ "TimestampEpoch": { "base": "Milliseconds since UTC epoch", "refs": { + "AwsCredentials$expiration": "The Epoch time when the current credentials expire.
", "ChangesetSummary$createTime": "The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "ChangesetSummary$activeUntilTimestamp": "Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", "ChangesetSummary$activeFromTimestamp": "Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", diff --git a/models/apis/polly/2016-06-10/api-2.json b/models/apis/polly/2016-06-10/api-2.json index af1d84b187a..f0d3f2256d8 100644 --- a/models/apis/polly/2016-06-10/api-2.json +++ b/models/apis/polly/2016-06-10/api-2.json @@ -833,7 +833,11 @@ "Aria", "Ayanda", "Arlet", - "Hannah" + "Hannah", + "Arthur", + "Daniel", + "Liam", + "Pedro" ] }, "VoiceList":{ diff --git a/service/datasync/api.go b/service/datasync/api.go index e797ca4b828..81bcbc56975 100644 --- a/service/datasync/api.go +++ b/service/datasync/api.go @@ -370,6 +370,90 @@ func (c *DataSync) CreateLocationFsxLustreWithContext(ctx aws.Context, input *Cr return out, req.Send() } +const opCreateLocationFsxOntap = "CreateLocationFsxOntap" + +// CreateLocationFsxOntapRequest generates a "aws/request.Request" representing the +// client's request for the CreateLocationFsxOntap operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateLocationFsxOntap for more information on using the CreateLocationFsxOntap +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateLocationFsxOntapRequest method. +// req, resp := client.CreateLocationFsxOntapRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxOntap +func (c *DataSync) CreateLocationFsxOntapRequest(input *CreateLocationFsxOntapInput) (req *request.Request, output *CreateLocationFsxOntapOutput) { + op := &request.Operation{ + Name: opCreateLocationFsxOntap, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateLocationFsxOntapInput{} + } + + output = &CreateLocationFsxOntapOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateLocationFsxOntap API operation for AWS DataSync. +// +// Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync +// can access for a transfer. For more information, see Creating a location +// for FSx for ONTAP (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS DataSync's +// API operation CreateLocationFsxOntap for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// This exception is thrown when the client submits a malformed request. +// +// * InternalException +// This exception is thrown when an error occurs in the DataSync service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxOntap +func (c *DataSync) CreateLocationFsxOntap(input *CreateLocationFsxOntapInput) (*CreateLocationFsxOntapOutput, error) { + req, out := c.CreateLocationFsxOntapRequest(input) + return out, req.Send() +} + +// CreateLocationFsxOntapWithContext is the same as CreateLocationFsxOntap with the addition of +// the ability to pass a context and additional request options. +// +// See CreateLocationFsxOntap for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *DataSync) CreateLocationFsxOntapWithContext(ctx aws.Context, input *CreateLocationFsxOntapInput, opts ...request.Option) (*CreateLocationFsxOntapOutput, error) { + req, out := c.CreateLocationFsxOntapRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateLocationFsxOpenZfs = "CreateLocationFsxOpenZfs" // CreateLocationFsxOpenZfsRequest generates a "aws/request.Request" representing the @@ -743,9 +827,9 @@ func (c *DataSync) CreateLocationObjectStorageRequest(input *CreateLocationObjec // CreateLocationObjectStorage API operation for AWS DataSync. // -// Creates an endpoint for a self-managed object storage bucket. For more information -// about self-managed object storage locations, see Creating a location for -// object storage (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html). +// 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 (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1554,6 +1638,89 @@ func (c *DataSync) DescribeLocationFsxLustreWithContext(ctx aws.Context, input * return out, req.Send() } +const opDescribeLocationFsxOntap = "DescribeLocationFsxOntap" + +// DescribeLocationFsxOntapRequest generates a "aws/request.Request" representing the +// client's request for the DescribeLocationFsxOntap operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeLocationFsxOntap for more information on using the DescribeLocationFsxOntap +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeLocationFsxOntapRequest method. +// req, resp := client.DescribeLocationFsxOntapRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxOntap +func (c *DataSync) DescribeLocationFsxOntapRequest(input *DescribeLocationFsxOntapInput) (req *request.Request, output *DescribeLocationFsxOntapOutput) { + op := &request.Operation{ + Name: opDescribeLocationFsxOntap, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeLocationFsxOntapInput{} + } + + output = &DescribeLocationFsxOntapOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeLocationFsxOntap API operation for AWS DataSync. +// +// Provides details about how an DataSync location for an Amazon FSx for NetApp +// ONTAP file system is configured. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS DataSync's +// API operation DescribeLocationFsxOntap for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// This exception is thrown when the client submits a malformed request. +// +// * InternalException +// This exception is thrown when an error occurs in the DataSync service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxOntap +func (c *DataSync) DescribeLocationFsxOntap(input *DescribeLocationFsxOntapInput) (*DescribeLocationFsxOntapOutput, error) { + req, out := c.DescribeLocationFsxOntapRequest(input) + return out, req.Send() +} + +// DescribeLocationFsxOntapWithContext is the same as DescribeLocationFsxOntap with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeLocationFsxOntap for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *DataSync) DescribeLocationFsxOntapWithContext(ctx aws.Context, input *DescribeLocationFsxOntapInput, opts ...request.Option) (*DescribeLocationFsxOntapOutput, error) { + req, out := c.DescribeLocationFsxOntapRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeLocationFsxOpenZfs = "DescribeLocationFsxOpenZfs" // DescribeLocationFsxOpenZfsRequest generates a "aws/request.Request" representing the @@ -1929,9 +2096,7 @@ func (c *DataSync) DescribeLocationObjectStorageRequest(input *DescribeLocationO // DescribeLocationObjectStorage API operation for AWS DataSync. // -// Returns metadata about a self-managed object storage server location. For -// more information about self-managed object storage locations, see Creating -// a location for object storage (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html). +// Returns metadata about your DataSync location for an object storage system. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4180,8 +4345,8 @@ type CreateLocationEfsInput struct { // when mounting the Amazon EFS file system. FileSystemAccessRoleArn *string `type:"string"` - // Specifies whether you want DataSync to use TLS encryption when transferring - // data to or from your Amazon EFS file system. + // Specifies whether you want DataSync to use Transport Layer Security (TLS) + // 1.2 encryption when it copies data to or from the Amazon EFS file system. // // If you specify an access point using AccessPointArn or an IAM role using // FileSystemAccessRoleArn, you must set this parameter to TLS1_2. @@ -4454,6 +4619,165 @@ func (s *CreateLocationFsxLustreOutput) SetLocationArn(v string) *CreateLocation return s } +type CreateLocationFsxOntapInput struct { + _ struct{} `type:"structure"` + + // Specifies the data transfer protocol that DataSync uses to access your Amazon + // FSx file system. + // + // Protocol is a required field + Protocol *FsxProtocol `type:"structure" required:"true"` + + // Specifies the security groups that DataSync can use to access your FSx for + // ONTAP file system. You must configure the security groups to allow outbound + // traffic on the following ports (depending on the protocol that you're using): + // + // * Network File System (NFS): TCP port 2049 + // + // * Server Message Block (SMB): TCP port 445 + // + // Your file system's security groups must also allow inbound traffic on the + // same port. + // + // SecurityGroupArns is a required field + SecurityGroupArns []*string `min:"1" type:"list" required:"true"` + + // Specifies the ARN of the storage virtual machine (SVM) on your file system + // where you're copying data to or from. + // + // StorageVirtualMachineArn is a required field + StorageVirtualMachineArn *string `type:"string" required:"true"` + + // Specifies the junction path (also known as a mount point) in the SVM volume + // where you're copying data to or from (for example, /vol1). + // + // Don't specify a junction path in the SVM's root volume. For more information, + // see Managing FSx for ONTAP storage virtual machines (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) + // in the Amazon FSx for NetApp ONTAP User Guide. + Subdirectory *string `type:"string"` + + // 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. + Tags []*TagListEntry `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateLocationFsxOntapInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateLocationFsxOntapInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateLocationFsxOntapInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateLocationFsxOntapInput"} + if s.Protocol == nil { + invalidParams.Add(request.NewErrParamRequired("Protocol")) + } + if s.SecurityGroupArns == nil { + invalidParams.Add(request.NewErrParamRequired("SecurityGroupArns")) + } + if s.SecurityGroupArns != nil && len(s.SecurityGroupArns) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SecurityGroupArns", 1)) + } + if s.StorageVirtualMachineArn == nil { + invalidParams.Add(request.NewErrParamRequired("StorageVirtualMachineArn")) + } + if s.Protocol != nil { + if err := s.Protocol.Validate(); err != nil { + invalidParams.AddNested("Protocol", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetProtocol sets the Protocol field's value. +func (s *CreateLocationFsxOntapInput) SetProtocol(v *FsxProtocol) *CreateLocationFsxOntapInput { + s.Protocol = v + return s +} + +// SetSecurityGroupArns sets the SecurityGroupArns field's value. +func (s *CreateLocationFsxOntapInput) SetSecurityGroupArns(v []*string) *CreateLocationFsxOntapInput { + s.SecurityGroupArns = v + return s +} + +// SetStorageVirtualMachineArn sets the StorageVirtualMachineArn field's value. +func (s *CreateLocationFsxOntapInput) SetStorageVirtualMachineArn(v string) *CreateLocationFsxOntapInput { + s.StorageVirtualMachineArn = &v + return s +} + +// SetSubdirectory sets the Subdirectory field's value. +func (s *CreateLocationFsxOntapInput) SetSubdirectory(v string) *CreateLocationFsxOntapInput { + s.Subdirectory = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateLocationFsxOntapInput) SetTags(v []*TagListEntry) *CreateLocationFsxOntapInput { + s.Tags = v + return s +} + +type CreateLocationFsxOntapOutput struct { + _ struct{} `type:"structure"` + + // Specifies the ARN of the FSx for ONTAP file system location that you create. + LocationArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateLocationFsxOntapOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateLocationFsxOntapOutput) GoString() string { + return s.String() +} + +// SetLocationArn sets the LocationArn field's value. +func (s *CreateLocationFsxOntapOutput) SetLocationArn(v string) *CreateLocationFsxOntapOutput { + s.LocationArn = &v + return s +} + type CreateLocationFsxOpenZfsInput struct { _ struct{} `type:"structure"` @@ -4518,6 +4842,11 @@ func (s *CreateLocationFsxOpenZfsInput) Validate() error { if s.SecurityGroupArns != nil && len(s.SecurityGroupArns) < 1 { invalidParams.Add(request.NewErrParamMinLen("SecurityGroupArns", 1)) } + if s.Protocol != nil { + if err := s.Protocol.Validate(); err != nil { + invalidParams.AddNested("Protocol", err.(request.ErrInvalidParams)) + } + } if s.Tags != nil { for i, v := range s.Tags { if v == nil { @@ -5221,57 +5550,50 @@ func (s *CreateLocationNfsOutput) SetLocationArn(v string) *CreateLocationNfsOut type CreateLocationObjectStorageInput struct { _ struct{} `type:"structure"` - // Optional. The access key is used if credentials are required to access the - // self-managed object storage server. If your object storage requires a user - // name and password to authenticate, use AccessKey and SecretKey to provide - // the user name and password, respectively. + // Specifies the access key (for example, a user name) if credentials are required + // to authenticate with the object storage server. AccessKey *string `min:"8" type:"string"` - // The Amazon Resource Name (ARN) of the agents associated with the self-managed - // object storage server location. + // Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can + // securely connect with your location. // // AgentArns is a required field AgentArns []*string `min:"1" type:"list" required:"true"` - // The bucket on the self-managed object storage server that is used to read - // data from. + // Specifies the name of the object storage bucket involved in the transfer. // // BucketName is a required field BucketName *string `min:"3" type:"string" required:"true"` - // Optional. The secret key is used if credentials are required to access the - // self-managed object storage server. If your object storage requires a user - // name and password to authenticate, use AccessKey and SecretKey to provide - // the user name and password, respectively. + // Specifies the secret key (for example, a password) if credentials are required + // to authenticate with the object storage server. // // SecretKey is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateLocationObjectStorageInput's // String and GoString methods. SecretKey *string `min:"8" type:"string" sensitive:"true"` - // The name of the self-managed object storage server. This value is the IP - // address or Domain Name Service (DNS) name of the object storage server. An + // Specifies the domain name or IP address of the object storage server. A DataSync // agent uses this hostname to mount the object storage server in a network. // // ServerHostname is a required field ServerHostname *string `type:"string" required:"true"` - // The port that your self-managed object storage server accepts inbound network - // traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 - // (HTTPS). You can specify a custom port if your self-managed object storage - // server requires one. + // Specifies the port that your object storage server accepts inbound network + // traffic on (for example, port 443). ServerPort *int64 `min:"1" type:"integer"` - // The protocol that the object storage server uses to communicate. Valid values - // are HTTP or HTTPS. + // Specifies the protocol that your object storage server uses to communicate. ServerProtocol *string `type:"string" enum:"ObjectStorageServerProtocol"` - // The subdirectory in the self-managed object storage server that is used to - // read data from. + // 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. Subdirectory *string `type:"string"` - // 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 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. Tags []*TagListEntry `type:"list"` } @@ -5395,8 +5717,7 @@ func (s *CreateLocationObjectStorageInput) SetTags(v []*TagListEntry) *CreateLoc type CreateLocationObjectStorageOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the agents associated with the self-managed - // object storage server location. + // Specifies the ARN of the object storage system location that you create. LocationArn *string `type:"string"` } @@ -5654,7 +5975,8 @@ type CreateLocationSmbInput struct { // folders in the SMB share. // // For information about choosing a user name that ensures sufficient permissions - // to files, folders, and metadata, see user (create-smb-location.html#SMBuser). + // to files, folders, and metadata, see the User setting (create-smb-location.html#SMBuser) + // for SMB locations. // // User is a required field User *string `type:"string" required:"true"` @@ -6410,8 +6732,8 @@ type DescribeLocationEfsOutput struct { // mounting the Amazon EFS file system. FileSystemAccessRoleArn *string `type:"string"` - // Whether DataSync uses TLS encryption when transferring data to or from your - // Amazon EFS file system. + // Describes whether DataSync uses Transport Layer Security (TLS) encryption + // when copying data to or from the Amazon EFS file system. InTransitEncryption *string `type:"string" enum:"EfsInTransitEncryption"` // The ARN of the Amazon EFS file system location. @@ -6586,6 +6908,141 @@ func (s *DescribeLocationFsxLustreOutput) SetSecurityGroupArns(v []*string) *Des return s } +type DescribeLocationFsxOntapInput struct { + _ struct{} `type:"structure"` + + // Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system + // location that you want information about. + // + // LocationArn is a required field + LocationArn *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeLocationFsxOntapInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeLocationFsxOntapInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeLocationFsxOntapInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeLocationFsxOntapInput"} + if s.LocationArn == nil { + invalidParams.Add(request.NewErrParamRequired("LocationArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLocationArn sets the LocationArn field's value. +func (s *DescribeLocationFsxOntapInput) SetLocationArn(v string) *DescribeLocationFsxOntapInput { + s.LocationArn = &v + return s +} + +type DescribeLocationFsxOntapOutput struct { + _ struct{} `type:"structure"` + + // The time that the location was created. + CreationTime *time.Time `type:"timestamp"` + + // The ARN of the FSx for ONTAP file system. + FsxFilesystemArn *string `type:"string"` + + // The ARN of the FSx for ONTAP file system location. + LocationArn *string `type:"string"` + + // The uniform resource identifier (URI) of the FSx for ONTAP file system location. + LocationUri *string `type:"string"` + + // Specifies the data transfer protocol that DataSync uses to access your Amazon + // FSx file system. + Protocol *FsxProtocol `type:"structure"` + + // The security groups that DataSync uses to access your FSx for ONTAP file + // system. + SecurityGroupArns []*string `min:"1" type:"list"` + + // The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system + // where you're copying data to or from. + StorageVirtualMachineArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeLocationFsxOntapOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeLocationFsxOntapOutput) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeLocationFsxOntapOutput) SetCreationTime(v time.Time) *DescribeLocationFsxOntapOutput { + s.CreationTime = &v + return s +} + +// SetFsxFilesystemArn sets the FsxFilesystemArn field's value. +func (s *DescribeLocationFsxOntapOutput) SetFsxFilesystemArn(v string) *DescribeLocationFsxOntapOutput { + s.FsxFilesystemArn = &v + return s +} + +// SetLocationArn sets the LocationArn field's value. +func (s *DescribeLocationFsxOntapOutput) SetLocationArn(v string) *DescribeLocationFsxOntapOutput { + s.LocationArn = &v + return s +} + +// SetLocationUri sets the LocationUri field's value. +func (s *DescribeLocationFsxOntapOutput) SetLocationUri(v string) *DescribeLocationFsxOntapOutput { + s.LocationUri = &v + return s +} + +// SetProtocol sets the Protocol field's value. +func (s *DescribeLocationFsxOntapOutput) SetProtocol(v *FsxProtocol) *DescribeLocationFsxOntapOutput { + s.Protocol = v + return s +} + +// SetSecurityGroupArns sets the SecurityGroupArns field's value. +func (s *DescribeLocationFsxOntapOutput) SetSecurityGroupArns(v []*string) *DescribeLocationFsxOntapOutput { + s.SecurityGroupArns = v + return s +} + +// SetStorageVirtualMachineArn sets the StorageVirtualMachineArn field's value. +func (s *DescribeLocationFsxOntapOutput) SetStorageVirtualMachineArn(v string) *DescribeLocationFsxOntapOutput { + s.StorageVirtualMachineArn = &v + return s +} + type DescribeLocationFsxOpenZfsInput struct { _ struct{} `type:"structure"` @@ -7131,8 +7588,8 @@ func (s *DescribeLocationNfsOutput) SetOnPremConfig(v *OnPremConfig) *DescribeLo type DescribeLocationObjectStorageInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the self-managed object storage server - // location that was described. + // The Amazon Resource Name (ARN) of the object storage system location that + // you want information about. // // LocationArn is a required field LocationArn *string `type:"string" required:"true"` @@ -7179,34 +7636,27 @@ func (s *DescribeLocationObjectStorageInput) SetLocationArn(v string) *DescribeL type DescribeLocationObjectStorageOutput struct { _ struct{} `type:"structure"` - // Optional. The access key is used if credentials are required to access the - // self-managed object storage server. If your object storage requires a user - // name and password to authenticate, use AccessKey and SecretKey to provide - // the user name and password, respectively. + // The access key (for example, a user name) required to authenticate with the + // object storage server. AccessKey *string `min:"8" type:"string"` - // The Amazon Resource Name (ARN) of the agents associated with the self-managed - // object storage server location. + // The ARNs of the DataSync agents that can securely connect with your location. AgentArns []*string `min:"1" type:"list"` - // The time that the self-managed object storage server agent was created. + // The time that the location was created. CreationTime *time.Time `type:"timestamp"` - // The Amazon Resource Name (ARN) of the self-managed object storage server - // location to describe. + // The ARN of the object storage system location. LocationArn *string `type:"string"` - // The URL of the source self-managed object storage server location that was - // described. + // The URL of the object storage system location. LocationUri *string `type:"string"` - // The port that your self-managed object storage server accepts inbound network - // traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 - // (HTTPS). + // The port that your object storage server accepts inbound network traffic + // on (for example, port 443). ServerPort *int64 `min:"1" type:"integer"` - // The protocol that the object storage server uses to communicate. Valid values - // are HTTP or HTTPS. + // The protocol that your object storage server uses to communicate. ServerProtocol *string `type:"string" enum:"ObjectStorageServerProtocol"` } @@ -8120,14 +8570,19 @@ func (s *FilterRule) SetValue(v string) *FilterRule { return s } -// Represents the protocol that DataSync uses to access your Amazon FSx for -// OpenZFS file system. +// Specifies the data transfer protocol that DataSync uses to access your Amazon +// FSx file system. type FsxProtocol struct { _ struct{} `type:"structure"` - // Represents the Network File System (NFS) protocol that DataSync uses to access - // your FSx for OpenZFS file system. + // Specifies the Network File System (NFS) protocol configuration that DataSync + // uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's + // storage virtual machine (SVM). NFS *FsxProtocolNfs `type:"structure"` + + // Specifies the Server Message Block (SMB) protocol configuration that DataSync + // uses to access your FSx for ONTAP file system's SVM. + SMB *FsxProtocolSmb `type:"structure"` } // String returns the string representation. @@ -8148,19 +8603,40 @@ func (s FsxProtocol) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *FsxProtocol) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FsxProtocol"} + if s.SMB != nil { + if err := s.SMB.Validate(); err != nil { + invalidParams.AddNested("SMB", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetNFS sets the NFS field's value. func (s *FsxProtocol) SetNFS(v *FsxProtocolNfs) *FsxProtocol { s.NFS = v return s } -// Represents the Network File System (NFS) protocol that DataSync uses to access -// your Amazon FSx for OpenZFS file system. +// SetSMB sets the SMB field's value. +func (s *FsxProtocol) SetSMB(v *FsxProtocolSmb) *FsxProtocol { + s.SMB = v + return s +} + +// Specifies the Network File System (NFS) protocol configuration that DataSync +// uses to access your Amazon FSx for OpenZFS or Amazon FSx for NetApp ONTAP +// file system. type FsxProtocolNfs struct { _ struct{} `type:"structure"` - // Represents the mount options that are available for DataSync to access an - // NFS location. + // Specifies how DataSync can access a location using the NFS protocol. MountOptions *NfsMountOptions `type:"structure"` } @@ -8188,6 +8664,92 @@ func (s *FsxProtocolNfs) SetMountOptions(v *NfsMountOptions) *FsxProtocolNfs { return s } +// Specifies the Server Message Block (SMB) protocol configuration that DataSync +// uses to access your Amazon FSx for NetApp ONTAP file system. For more information, +// see Accessing FSx for ONTAP file systems (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access). +type FsxProtocolSmb struct { + _ struct{} `type:"structure"` + + // Specifies the fully qualified domain name (FQDN) of the Microsoft Active + // Directory that your storage virtual machine (SVM) belongs to. + Domain *string `type:"string"` + + // Specifies how DataSync can access a location using the SMB protocol. + MountOptions *SmbMountOptions `type:"structure"` + + // Specifies the password of a user who has permission to access your SVM. + // + // Password is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by FsxProtocolSmb's + // String and GoString methods. + // + // Password is a required field + Password *string `type:"string" required:"true" sensitive:"true"` + + // Specifies a user who has permission to access your SVM. + // + // User is a required field + User *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FsxProtocolSmb) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FsxProtocolSmb) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *FsxProtocolSmb) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FsxProtocolSmb"} + if s.Password == nil { + invalidParams.Add(request.NewErrParamRequired("Password")) + } + if s.User == nil { + invalidParams.Add(request.NewErrParamRequired("User")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomain sets the Domain field's value. +func (s *FsxProtocolSmb) SetDomain(v string) *FsxProtocolSmb { + s.Domain = &v + return s +} + +// SetMountOptions sets the MountOptions field's value. +func (s *FsxProtocolSmb) SetMountOptions(v *SmbMountOptions) *FsxProtocolSmb { + s.MountOptions = v + return s +} + +// SetPassword sets the Password field's value. +func (s *FsxProtocolSmb) SetPassword(v string) *FsxProtocolSmb { + s.Password = &v + return s +} + +// SetUser sets the User field's value. +func (s *FsxProtocolSmb) SetUser(v string) *FsxProtocolSmb { + s.User = &v + return s +} + // The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages // the file system's namespace. The NameNode performs operations such as opening, // closing, and renaming files and directories. The NameNode contains the information @@ -9052,28 +9614,29 @@ func (s *LocationListEntry) SetLocationUri(v string) *LocationListEntry { return s } -// Represents the mount options that are available for DataSync to access an -// NFS location. +// Specifies how DataSync can access a location using the NFS protocol. type NfsMountOptions struct { _ struct{} `type:"structure"` - // The specific NFS version that you want DataSync to use to mount your NFS - // share. If the server refuses to use the version specified, the sync will - // fail. If you don't specify a version, DataSync defaults to AUTOMATIC. That - // is, DataSync automatically selects a version based on negotiation with the - // NFS server. + // Specifies the NFS version that you want DataSync to use when mounting your + // NFS share. If the server refuses to use the version specified, the task fails. + // + // You can specify the following options: + // + // * AUTOMATIC (default): DataSync chooses NFS version 4.1. // - // You can specify the following NFS versions: + // * NFS3: Stateless protocol version that allows for asynchronous writes + // on the server. // - // * NFSv3 (https://tools.ietf.org/html/rfc1813) - stateless protocol version - // that allows for asynchronous writes on the server. + // * NFSv4_0: Stateful, firewall-friendly protocol version that supports + // delegations and pseudo file systems. // - // * NFSv4.0 (https://tools.ietf.org/html/rfc3530) - stateful, firewall-friendly - // protocol version that supports delegations and pseudo file systems. + // * NFSv4_1: Stateful protocol version that supports sessions, directory + // delegations, and parallel data processing. NFS version 4.1 also includes + // all features available in version 4.0. // - // * NFSv4.1 (https://tools.ietf.org/html/rfc5661) - stateful protocol version - // that supports sessions, directory delegations, and parallel data processing. - // Version 4.1 also includes all features available in version 4.0. + // DataSync currently only supports NFS version 3 with Amazon FSx for NetApp + // ONTAP locations. Version *string `type:"string" enum:"NfsVersion"` } @@ -9173,7 +9736,7 @@ type Options struct { // behavior is not fully standard across platforms, so DataSync can only do // this on a best-effort basis. // - // Default value: BEST_EFFORT. + // Default value: BEST_EFFORT // // BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended). // @@ -9188,9 +9751,9 @@ type Options struct { // DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024). BytesPerSecond *int64 `type:"long"` - // The POSIX group ID (GID) of the file's owners. This option should only be - // set for NFS, EFS, and S3 locations. For more information about what metadata - // is copied by DataSync, see Metadata Copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). + // The POSIX group ID (GID) of the file's owners. + // + // For more information, see Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). // // Default value: INT_VALUE. This preserves the integer value of the ID. // @@ -9242,11 +9805,11 @@ type Options struct { OverwriteMode *string `type:"string" enum:"OverwriteMode"` // A value that determines which users or groups can access a file for a specific - // purpose such as reading, writing, or execution of the file. This option should - // only be set for NFS, EFS, and S3 locations. For more information about what - // metadata is copied by DataSync, see Metadata Copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). + // purpose such as reading, writing, or execution of the file. + // + // For more information, see Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). // - // Default value: PRESERVE. + // Default value: PRESERVE // // PRESERVE: Preserve POSIX-style permissions (recommended). // @@ -9262,7 +9825,7 @@ type Options struct { // Considerations when working with Amazon S3 storage classes in DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) // in the DataSync User Guide. // - // Default value: PRESERVE. + // Default value: PRESERVE // // PRESERVE: Ignore such destination files (recommended). // @@ -9277,7 +9840,7 @@ type Options struct { // DataSync can't sync the actual contents of such devices, because they are // nonterminal and don't return an end-of-file (EOF) marker. // - // Default value: NONE. + // Default value: NONE // // NONE: Ignore special devices (recommended). // @@ -9293,7 +9856,7 @@ type Options struct { // locations. For more information about how DataSync handles metadata, see // How DataSync Handles Metadata and Special Files (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html). // - // Default value: OWNER_DACL. + // Default value: OWNER_DACL // // OWNER_DACL: For each copied object, DataSync copies the following metadata: // @@ -9345,9 +9908,9 @@ type Options struct { // comparing to existing content on the destination. TransferMode *string `type:"string" enum:"TransferMode"` - // The POSIX user ID (UID) of the file's owner. This option should only be set - // for NFS, EFS, and S3 locations. To learn more about what metadata is copied - // by DataSync, see Metadata Copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). + // The POSIX user ID (UID) of the file's owner. + // + // For more information, see Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). // // Default value: INT_VALUE. This preserves the integer value of the ID. // @@ -9360,7 +9923,7 @@ type Options struct { // at the end of a task execution after all data and metadata have been transferred. // For more information, see Configure task settings (https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html). // - // Default value: POINT_IN_TIME_CONSISTENT. + // Default value: POINT_IN_TIME_CONSISTENT // // ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files // that were transferred. @@ -9663,15 +10226,13 @@ func (s *S3Config) SetBucketAccessRoleArn(v string) *S3Config { return s } -// Represents the mount options that are available for DataSync to access an -// SMB location. +// Specifies how DataSync can access a location using the SMB protocol. type SmbMountOptions struct { _ struct{} `type:"structure"` - // The specific SMB version that you want DataSync to use to mount your SMB - // share. If you don't specify a version, DataSync defaults to AUTOMATIC. That - // is, DataSync automatically selects a version based on negotiation with the - // SMB server. + // Specifies the SMB version that you want DataSync to use when mounting your + // SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC + // and chooses a version based on negotiation with the SMB server. Version *string `type:"string" enum:"SmbVersion"` } @@ -10718,8 +11279,7 @@ type UpdateLocationNfsInput struct { // LocationArn is a required field LocationArn *string `type:"string" required:"true"` - // Represents the mount options that are available for DataSync to access an - // NFS location. + // Specifies how DataSync can access a location using the NFS protocol. MountOptions *NfsMountOptions `type:"structure"` // A list of Amazon Resource Names (ARNs) of agents to use for a Network File @@ -11001,8 +11561,7 @@ type UpdateLocationSmbInput struct { // LocationArn is a required field LocationArn *string `type:"string" required:"true"` - // Represents the mount options that are available for DataSync to access an - // SMB location. + // Specifies how DataSync can access a location using the SMB protocol. MountOptions *SmbMountOptions `type:"structure"` // The password of the user who can mount the share has the permissions to access diff --git a/service/datasync/datasynciface/interface.go b/service/datasync/datasynciface/interface.go index 46d66b93577..27a61388bcd 100644 --- a/service/datasync/datasynciface/interface.go +++ b/service/datasync/datasynciface/interface.go @@ -76,6 +76,10 @@ type DataSyncAPI interface { CreateLocationFsxLustreWithContext(aws.Context, *datasync.CreateLocationFsxLustreInput, ...request.Option) (*datasync.CreateLocationFsxLustreOutput, error) CreateLocationFsxLustreRequest(*datasync.CreateLocationFsxLustreInput) (*request.Request, *datasync.CreateLocationFsxLustreOutput) + CreateLocationFsxOntap(*datasync.CreateLocationFsxOntapInput) (*datasync.CreateLocationFsxOntapOutput, error) + CreateLocationFsxOntapWithContext(aws.Context, *datasync.CreateLocationFsxOntapInput, ...request.Option) (*datasync.CreateLocationFsxOntapOutput, error) + CreateLocationFsxOntapRequest(*datasync.CreateLocationFsxOntapInput) (*request.Request, *datasync.CreateLocationFsxOntapOutput) + CreateLocationFsxOpenZfs(*datasync.CreateLocationFsxOpenZfsInput) (*datasync.CreateLocationFsxOpenZfsOutput, error) CreateLocationFsxOpenZfsWithContext(aws.Context, *datasync.CreateLocationFsxOpenZfsInput, ...request.Option) (*datasync.CreateLocationFsxOpenZfsOutput, error) CreateLocationFsxOpenZfsRequest(*datasync.CreateLocationFsxOpenZfsInput) (*request.Request, *datasync.CreateLocationFsxOpenZfsOutput) @@ -132,6 +136,10 @@ type DataSyncAPI interface { DescribeLocationFsxLustreWithContext(aws.Context, *datasync.DescribeLocationFsxLustreInput, ...request.Option) (*datasync.DescribeLocationFsxLustreOutput, error) DescribeLocationFsxLustreRequest(*datasync.DescribeLocationFsxLustreInput) (*request.Request, *datasync.DescribeLocationFsxLustreOutput) + DescribeLocationFsxOntap(*datasync.DescribeLocationFsxOntapInput) (*datasync.DescribeLocationFsxOntapOutput, error) + DescribeLocationFsxOntapWithContext(aws.Context, *datasync.DescribeLocationFsxOntapInput, ...request.Option) (*datasync.DescribeLocationFsxOntapOutput, error) + DescribeLocationFsxOntapRequest(*datasync.DescribeLocationFsxOntapInput) (*request.Request, *datasync.DescribeLocationFsxOntapOutput) + DescribeLocationFsxOpenZfs(*datasync.DescribeLocationFsxOpenZfsInput) (*datasync.DescribeLocationFsxOpenZfsOutput, error) DescribeLocationFsxOpenZfsWithContext(aws.Context, *datasync.DescribeLocationFsxOpenZfsInput, ...request.Option) (*datasync.DescribeLocationFsxOpenZfsOutput, error) DescribeLocationFsxOpenZfsRequest(*datasync.DescribeLocationFsxOpenZfsInput) (*request.Request, *datasync.DescribeLocationFsxOpenZfsOutput) diff --git a/service/ec2/api.go b/service/ec2/api.go index f0ffc658a04..f501155e77b 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -7091,9 +7091,8 @@ func (c *EC2) CreateRouteRequest(input *CreateRouteInput) (req *request.Request, // // Creates a route in a route table within a VPC. // -// You must specify one of the following targets: internet gateway or virtual -// private gateway, NAT instance, NAT gateway, VPC peering connection, network -// interface, egress-only internet gateway, or transit gateway. +// You must specify either a destination CIDR block or a prefix list ID. You +// must also specify exactly one of the resources from the parameter list. // // When determining how to route traffic, we use the route with the most specific // match. For example, traffic is destined for the IPv4 address 192.0.2.3, and @@ -8630,9 +8629,8 @@ func (c *EC2) CreateTransitGatewayPeeringAttachmentRequest(input *CreateTransitG // CreateTransitGatewayPeeringAttachment API operation for Amazon Elastic Compute Cloud. // // Requests a transit gateway peering attachment between the specified transit -// gateway (requester) and a peer transit gateway (accepter). The transit gateways -// must be in different Regions. The peer transit gateway can be in your account -// or a different Amazon Web Services account. +// gateway (requester) and a peer transit gateway (accepter). The peer transit +// gateway can be in your account or a different Amazon Web Services account. // // After you create the peering attachment, the owner of the accepter transit // gateway must accept the attachment request. @@ -44908,6 +44906,9 @@ func (c *EC2) ReleaseAddressRequest(input *ReleaseAddressInput) (req *request.Re // [EC2-VPC] After you release an Elastic IP address for use in a VPC, you might // be able to recover it. For more information, see AllocateAddress. // +// For more information, see Elastic IP Addresses (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) +// in the Amazon Elastic Compute Cloud User Guide. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -45379,10 +45380,11 @@ func (c *EC2) ReplaceRouteRequest(input *ReplaceRouteInput) (req *request.Reques // ReplaceRoute API operation for Amazon Elastic Compute Cloud. // -// Replaces an existing route within a route table in a VPC. You must provide -// only one of the following: internet gateway, virtual private gateway, NAT -// instance, NAT gateway, VPC peering connection, network interface, egress-only -// internet gateway, or transit gateway. +// Replaces an existing route within a route table in a VPC. +// +// You must specify either a destination CIDR block or a prefix list ID. You +// must also specify exactly one of the resources from the parameter list, or +// reset the local route to its default target. // // For more information, see Route tables (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) // in the Amazon Virtual Private Cloud User Guide. @@ -56465,8 +56467,7 @@ type CapacityReservation struct { // date and time. EndDateType *string `locationName:"endDateType" type:"string" enum:"EndDateType"` - // Indicates whether the Capacity Reservation supports instances with temporary, - // block-level storage. + // Deprecated. EphemeralStorage *bool `locationName:"ephemeralStorage" type:"boolean"` // Indicates the type of instance launches that the Capacity Reservation accepts. @@ -60302,8 +60303,7 @@ type CreateCapacityReservationInput struct { // is limited. EndDateType *string `type:"string" enum:"EndDateType"` - // Indicates whether the Capacity Reservation supports instances with temporary, - // block-level storage. + // Deprecated. EphemeralStorage *bool `type:"boolean"` // The number of instances for which to reserve capacity. @@ -63611,7 +63611,13 @@ type CreateLaunchTemplateInput struct { // LaunchTemplateName is a required field LaunchTemplateName *string `min:"3" type:"string" required:"true"` - // The tags to apply to the launch template during creation. + // The tags to apply to the launch template on creation. To tag the launch template, + // the resource type must be launch-template. + // + // To specify the tags for the resources that are created when an instance is + // launched, you must use the TagSpecifications parameter in the launch template + // data (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html) + // structure. TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" type:"list"` // A description for the first version of the launch template. @@ -65391,6 +65397,13 @@ type CreatePlacementGroupInput struct { // The number of partitions. Valid only when Strategy is set to partition. PartitionCount *int64 `type:"integer"` + // Determines how placement groups spread instances. + // + // * Host – You can use host only with Outpost placement groups. + // + // * Rack – No usage restrictions. + SpreadLevel *string `type:"string" enum:"SpreadLevel"` + // The placement strategy. Strategy *string `locationName:"strategy" type:"string" enum:"PlacementStrategy"` @@ -65434,6 +65447,12 @@ func (s *CreatePlacementGroupInput) SetPartitionCount(v int64) *CreatePlacementG return s } +// SetSpreadLevel sets the SpreadLevel field's value. +func (s *CreatePlacementGroupInput) SetSpreadLevel(v string) *CreatePlacementGroupInput { + s.SpreadLevel = &v + return s +} + // SetStrategy sets the Strategy field's value. func (s *CreatePlacementGroupInput) SetStrategy(v string) *CreatePlacementGroupInput { s.Strategy = &v @@ -87160,6 +87179,9 @@ type DescribeNetworkAclsInput struct { // // * entry.rule-action - Allows or denies the matching traffic (allow | deny). // + // * entry.egress - A Boolean that indicates the type of rule. Specify true + // for egress rules, or false for ingress rules. + // // * entry.rule-number - The number of an entry (in other words, rule) in // the set of ACL entries. // @@ -88387,6 +88409,8 @@ type DescribePlacementGroupsInput struct { // // * group-arn - The Amazon Resource Name (ARN) of the placement group. // + // * spread-level - The spread level for the placement group (host | rack). + // // * state - The state of the placement group (pending | available | deleting // | deleted). // @@ -102234,18 +102258,21 @@ type EventInformation struct { // * active - The EC2 Fleet or Spot Fleet request has been validated and // Amazon EC2 is attempting to maintain the target number of running instances. // - // * cancelled - The EC2 Fleet or Spot Fleet request is canceled and has - // no running instances. The EC2 Fleet or Spot Fleet will be deleted two - // days after its instances are terminated. + // * deleted (EC2 Fleet) / cancelled (Spot Fleet) - The EC2 Fleet is deleted + // or the Spot Fleet request is canceled and has no running instances. The + // EC2 Fleet or Spot Fleet will be deleted two days after its instances are + // terminated. // - // * cancelled_running - The EC2 Fleet or Spot Fleet request is canceled - // and does not launch additional instances. Its existing instances continue - // to run until they are interrupted or terminated. The request remains in - // this state until all instances are interrupted or terminated. + // * deleted_running (EC2 Fleet) / cancelled_running (Spot Fleet) - The EC2 + // Fleet is deleted or the Spot Fleet request is canceled and does not launch + // additional instances. Its existing instances continue to run until they + // are interrupted or terminated. The request remains in this state until + // all instances are interrupted or terminated. // - // * cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled - // and its instances are terminating. The request remains in this state until - // all instances are terminated. + // * deleted_terminating (EC2 Fleet) / cancelled_terminating (Spot Fleet) + // - The EC2 Fleet is deleted or the Spot Fleet request is canceled and its + // instances are terminating. The request remains in this state until all + // instances are terminated. // // * expired - The EC2 Fleet or Spot Fleet request has expired. If the request // was created with TerminateInstancesWithExpiration set, a subsequent terminated @@ -116367,9 +116394,9 @@ type InstanceRequirements struct { // // * For instance types with hard disk drive (HDD) storage, specify hdd. // - // * For instance types with solid state drive (SDD) storage, specify sdd. + // * For instance types with solid state drive (SSD) storage, specify ssd. // - // Default: hdd and sdd + // Default: hdd and ssd LocalStorageTypes []*string `locationName:"localStorageTypeSet" locationNameList:"item" type:"list" enum:"LocalStorageType"` // The minimum and maximum amount of memory per vCPU, in GiB. @@ -116749,9 +116776,9 @@ type InstanceRequirementsRequest struct { // // * For instance types with hard disk drive (HDD) storage, specify hdd. // - // * For instance types with solid state drive (SDD) storage, specify sdd. + // * For instance types with solid state drive (SSD) storage, specify ssd. // - // Default: hdd and sdd + // Default: hdd and ssd LocalStorageTypes []*string `locationName:"LocalStorageType" locationNameList:"item" type:"list" enum:"LocalStorageType"` // The minimum and maximum amount of memory per vCPU, in GiB. @@ -122688,11 +122715,11 @@ func (s *LaunchTemplateSpotMarketOptionsRequest) SetValidUntil(v time.Time) *Lau return s } -// The tag specification for the launch template. +// The tags specification for the launch template. type LaunchTemplateTagSpecification struct { _ struct{} `type:"structure"` - // The type of resource. + // The type of resource to tag. ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"` // The tags for the resource. @@ -122729,12 +122756,17 @@ func (s *LaunchTemplateTagSpecification) SetTags(v []*Tag) *LaunchTemplateTagSpe return s } -// The tags specification for the launch template. +// The tags specification for the resources that are created during instance +// launch. type LaunchTemplateTagSpecificationRequest struct { _ struct{} `type:"structure"` - // The type of resource to tag. Currently, the resource types that support tagging - // on creation are instance, volume, elastic-gpu, network-interface, and spot-instances-request. + // The type of resource to tag. + // + // The Valid Values are all the resource types that can be tagged. However, + // when creating a launch template, you can specify tags for the following resource + // types only: instance | volume | elastic-gpu | network-interface | spot-instances-request + // // To tag a resource after it has been created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). ResourceType *string `type:"string" enum:"ResourceType"` @@ -134835,7 +134867,7 @@ type PathComponent struct { // The subnet. Subnet *AnalysisComponent `locationName:"subnet" type:"structure"` - // Describes a path component. + // The transit gateway. TransitGateway *AnalysisComponent `locationName:"transitGateway" type:"structure"` // The route in a transit gateway route table. @@ -135819,6 +135851,10 @@ type PlacementGroup struct { // The number of partitions. Valid only if strategy is set to partition. PartitionCount *int64 `locationName:"partitionCount" type:"integer"` + // The spread level for the placement group. Only Outpost placement groups can + // be spread across hosts. + SpreadLevel *string `locationName:"spreadLevel" type:"string" enum:"SpreadLevel"` + // The state of the placement group. State *string `locationName:"state" type:"string" enum:"PlacementGroupState"` @@ -135871,6 +135907,12 @@ func (s *PlacementGroup) SetPartitionCount(v int64) *PlacementGroup { return s } +// SetSpreadLevel sets the SpreadLevel field's value. +func (s *PlacementGroup) SetSpreadLevel(v string) *PlacementGroup { + s.SpreadLevel = &v + return s +} + // SetState sets the State field's value. func (s *PlacementGroup) SetState(v string) *PlacementGroup { s.State = &v @@ -140842,8 +140884,7 @@ type RequestLaunchTemplateData struct { // in the Amazon Elastic Compute Cloud User Guide. CpuOptions *LaunchTemplateCpuOptionsRequest `type:"structure"` - // The credit option for CPU usage of the instance. Valid for T2, T3, or T3a - // instances only. + // The credit option for CPU usage of the instance. Valid only for T instances. CreditSpecification *CreditSpecificationRequest `type:"structure"` // Indicates whether to enable the instance for stop protection. For more information, @@ -140968,10 +141009,24 @@ type RequestLaunchTemplateData struct { // group ID and security name in the same request. SecurityGroups []*string `locationName:"SecurityGroup" locationNameList:"SecurityGroup" type:"list"` - // The tags to apply to the resources during launch. You can only tag instances - // and volumes on launch. The specified tags are applied to all instances or - // volumes that are created during launch. To tag a resource after it has been - // created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). + // The tags to apply to the resources that are created during instance launch. + // + // You can specify tags for the following resources only: + // + // * Instances + // + // * Volumes + // + // * Elastic graphics + // + // * Spot Instance requests + // + // * Network interfaces + // + // To tag a resource after it has been created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). + // + // To tag the launch template itself, you must use the TagSpecification (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) + // parameter. TagSpecifications []*LaunchTemplateTagSpecificationRequest `locationName:"TagSpecification" locationNameList:"LaunchTemplateTagSpecificationRequest" type:"list"` // The user data to make available to the instance. You must provide base64-encoded @@ -143678,7 +143733,8 @@ type ResponseLaunchTemplateData struct { // The security group names. SecurityGroups []*string `locationName:"securityGroupSet" locationNameList:"item" type:"list"` - // The tags. + // The tags that are applied to the resources that are created during instance + // launch. TagSpecifications []*LaunchTemplateTagSpecification `locationName:"tagSpecificationSet" locationNameList:"item" type:"list"` // The user data for the instance. @@ -168161,6 +168217,22 @@ func SpotInstanceType_Values() []string { } } +const ( + // SpreadLevelHost is a SpreadLevel enum value + SpreadLevelHost = "host" + + // SpreadLevelRack is a SpreadLevel enum value + SpreadLevelRack = "rack" +) + +// SpreadLevel_Values returns all elements of the SpreadLevel enum +func SpreadLevel_Values() []string { + return []string{ + SpreadLevelHost, + SpreadLevelRack, + } +} + const ( // StatePendingAcceptance is a State enum value StatePendingAcceptance = "PendingAcceptance" diff --git a/service/finspacedata/api.go b/service/finspacedata/api.go index 09347214476..071f55a5ac5 100644 --- a/service/finspacedata/api.go +++ b/service/finspacedata/api.go @@ -1355,6 +1355,104 @@ func (c *FinSpaceData) GetDatasetWithContext(ctx aws.Context, input *GetDatasetI return out, req.Send() } +const opGetExternalDataViewAccessDetails = "GetExternalDataViewAccessDetails" + +// GetExternalDataViewAccessDetailsRequest generates a "aws/request.Request" representing the +// client's request for the GetExternalDataViewAccessDetails operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetExternalDataViewAccessDetails for more information on using the GetExternalDataViewAccessDetails +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetExternalDataViewAccessDetailsRequest method. +// req, resp := client.GetExternalDataViewAccessDetailsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetExternalDataViewAccessDetails +func (c *FinSpaceData) GetExternalDataViewAccessDetailsRequest(input *GetExternalDataViewAccessDetailsInput) (req *request.Request, output *GetExternalDataViewAccessDetailsOutput) { + op := &request.Operation{ + Name: opGetExternalDataViewAccessDetails, + HTTPMethod: "POST", + HTTPPath: "/datasets/{datasetId}/dataviewsv2/{dataviewId}/external-access-details", + } + + if input == nil { + input = &GetExternalDataViewAccessDetailsInput{} + } + + output = &GetExternalDataViewAccessDetailsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetExternalDataViewAccessDetails API operation for FinSpace Public API. +// +// Returns the credentials to access the external Dataview from an S3 location. +// To call this API: +// +// * You must retrieve the programmatic credentials. +// +// * You must be a member of a FinSpace user group, where the dataset that +// you want to access has Read Dataset Data permissions. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for FinSpace Public API's +// API operation GetExternalDataViewAccessDetails for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetExternalDataViewAccessDetails +func (c *FinSpaceData) GetExternalDataViewAccessDetails(input *GetExternalDataViewAccessDetailsInput) (*GetExternalDataViewAccessDetailsOutput, error) { + req, out := c.GetExternalDataViewAccessDetailsRequest(input) + return out, req.Send() +} + +// GetExternalDataViewAccessDetailsWithContext is the same as GetExternalDataViewAccessDetails with the addition of +// the ability to pass a context and additional request options. +// +// See GetExternalDataViewAccessDetails for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *FinSpaceData) GetExternalDataViewAccessDetailsWithContext(ctx aws.Context, input *GetExternalDataViewAccessDetailsInput, opts ...request.Option) (*GetExternalDataViewAccessDetailsOutput, error) { + req, out := c.GetExternalDataViewAccessDetailsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetPermissionGroup = "GetPermissionGroup" // GetPermissionGroupRequest generates a "aws/request.Request" representing the @@ -3301,6 +3399,73 @@ func (s *AssociateUserToPermissionGroupOutput) SetStatusCode(v int64) *Associate return s } +// The credentials required to access the external Dataview from the S3 location. +type AwsCredentials struct { + _ struct{} `type:"structure"` + + // The unique identifier for the security credentials. + AccessKeyId *string `locationName:"accessKeyId" min:"1" type:"string"` + + // The Epoch time when the current credentials expire. + Expiration *int64 `locationName:"expiration" type:"long"` + + // The secret access key that can be used to sign requests. + // + // SecretAccessKey is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by AwsCredentials's + // String and GoString methods. + SecretAccessKey *string `locationName:"secretAccessKey" min:"1" type:"string" sensitive:"true"` + + // The token that users must pass to use the credentials. + // + // SessionToken is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by AwsCredentials's + // String and GoString methods. + SessionToken *string `locationName:"sessionToken" min:"1" type:"string" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsCredentials) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsCredentials) GoString() string { + return s.String() +} + +// SetAccessKeyId sets the AccessKeyId field's value. +func (s *AwsCredentials) SetAccessKeyId(v string) *AwsCredentials { + s.AccessKeyId = &v + return s +} + +// SetExpiration sets the Expiration field's value. +func (s *AwsCredentials) SetExpiration(v int64) *AwsCredentials { + s.Expiration = &v + return s +} + +// SetSecretAccessKey sets the SecretAccessKey field's value. +func (s *AwsCredentials) SetSecretAccessKey(v string) *AwsCredentials { + s.SecretAccessKey = &v + return s +} + +// SetSessionToken sets the SessionToken field's value. +func (s *AwsCredentials) SetSessionToken(v string) *AwsCredentials { + s.SessionToken = &v + return s +} + // The structure with error messages. type ChangesetErrorInfo struct { _ struct{} `type:"structure"` @@ -4184,13 +4349,20 @@ type CreatePermissionGroupInput struct { // The option to indicate FinSpace application permissions that are granted // to a specific group. // + // When assigning application permissions, be aware that the permission ManageUsersAndGroups + // allows users to grant themselves or others access to any functionality in + // their FinSpace environment's application. It should only be granted to trusted + // users. + // // * CreateDataset – Group members can create new datasets. // // * ManageClusters – Group members can manage Apache Spark clusters from // FinSpace notebooks. // // * ManageUsersAndGroups – Group members can manage users and permission - // groups. + // groups. This is a privileged permission that allows users to grant themselves + // or others access to any functionality in the application. It should only + // be granted to trusted users. // // * ManageAttributeSets – Group members can manage attribute sets. // @@ -6138,6 +6310,112 @@ func (s *GetDatasetOutput) SetStatus(v string) *GetDatasetOutput { return s } +type GetExternalDataViewAccessDetailsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The unique identifier for the Dataview that you want to access. + // + // DataViewId is a required field + DataViewId *string `location:"uri" locationName:"dataviewId" min:"1" type:"string" required:"true"` + + // The unique identifier for the Dataset. + // + // DatasetId is a required field + DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetExternalDataViewAccessDetailsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetExternalDataViewAccessDetailsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetExternalDataViewAccessDetailsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetExternalDataViewAccessDetailsInput"} + if s.DataViewId == nil { + invalidParams.Add(request.NewErrParamRequired("DataViewId")) + } + if s.DataViewId != nil && len(*s.DataViewId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataViewId", 1)) + } + if s.DatasetId == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetId")) + } + if s.DatasetId != nil && len(*s.DatasetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataViewId sets the DataViewId field's value. +func (s *GetExternalDataViewAccessDetailsInput) SetDataViewId(v string) *GetExternalDataViewAccessDetailsInput { + s.DataViewId = &v + return s +} + +// SetDatasetId sets the DatasetId field's value. +func (s *GetExternalDataViewAccessDetailsInput) SetDatasetId(v string) *GetExternalDataViewAccessDetailsInput { + s.DatasetId = &v + return s +} + +type GetExternalDataViewAccessDetailsOutput struct { + _ struct{} `type:"structure"` + + // The credentials required to access the external Dataview from the S3 location. + Credentials *AwsCredentials `locationName:"credentials" type:"structure"` + + // The location where the external Dataview is stored. + S3Location *S3Location `locationName:"s3Location" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetExternalDataViewAccessDetailsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetExternalDataViewAccessDetailsOutput) GoString() string { + return s.String() +} + +// SetCredentials sets the Credentials field's value. +func (s *GetExternalDataViewAccessDetailsOutput) SetCredentials(v *AwsCredentials) *GetExternalDataViewAccessDetailsOutput { + s.Credentials = v + return s +} + +// SetS3Location sets the S3Location field's value. +func (s *GetExternalDataViewAccessDetailsOutput) SetS3Location(v *S3Location) *GetExternalDataViewAccessDetailsOutput { + s.S3Location = v + return s +} + type GetPermissionGroupInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -7515,13 +7793,20 @@ type PermissionGroup struct { // Indicates the permissions that are granted to a specific group for accessing // the FinSpace application. // + // When assigning application permissions, be aware that the permission ManageUsersAndGroups + // allows users to grant themselves or others access to any functionality in + // their FinSpace environment's application. It should only be granted to trusted + // users. + // // * CreateDataset – Group members can create new datasets. // // * ManageClusters – Group members can manage Apache Spark clusters from // FinSpace notebooks. // // * ManageUsersAndGroups – Group members can manage users and permission - // groups. + // groups. This is a privileged permission that allows users to grant themselves + // or others access to any functionality in the application. It should only + // be granted to trusted users. // // * ManageAttributeSets – Group members can manage attribute sets. // @@ -8002,6 +8287,51 @@ func (s *ResourcePermission) SetPermission(v string) *ResourcePermission { return s } +// The location of an external Dataview in an S3 bucket. +type S3Location struct { + _ struct{} `type:"structure"` + + // The name of the S3 bucket. + // + // Bucket is a required field + Bucket *string `locationName:"bucket" min:"1" type:"string" required:"true"` + + // The path of the folder, within the S3 bucket that contains the Dataset. + // + // Key is a required field + Key *string `locationName:"key" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Location) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Location) GoString() string { + return s.String() +} + +// SetBucket sets the Bucket field's value. +func (s *S3Location) SetBucket(v string) *S3Location { + s.Bucket = &v + return s +} + +// SetKey sets the Key field's value. +func (s *S3Location) SetKey(v string) *S3Location { + s.Key = &v + return s +} + // Definition for a schema on a tabular Dataset. type SchemaDefinition struct { _ struct{} `type:"structure"` @@ -8492,13 +8822,20 @@ type UpdatePermissionGroupInput struct { // The permissions that are granted to a specific group for accessing the FinSpace // application. // + // When assigning application permissions, be aware that the permission ManageUsersAndGroups + // allows users to grant themselves or others access to any functionality in + // their FinSpace environment's application. It should only be granted to trusted + // users. + // // * CreateDataset – Group members can create new datasets. // // * ManageClusters – Group members can manage Apache Spark clusters from // FinSpace notebooks. // // * ManageUsersAndGroups – Group members can manage users and permission - // groups. + // groups. This is a privileged permission that allows users to grant themselves + // or others access to any functionality in the application. It should only + // be granted to trusted users. // // * ManageAttributeSets – Group members can manage attribute sets. // diff --git a/service/finspacedata/finspacedataiface/interface.go b/service/finspacedata/finspacedataiface/interface.go index e23a7f3b901..b19fa682e4f 100644 --- a/service/finspacedata/finspacedataiface/interface.go +++ b/service/finspacedata/finspacedataiface/interface.go @@ -116,6 +116,10 @@ type FinSpaceDataAPI interface { GetDatasetWithContext(aws.Context, *finspacedata.GetDatasetInput, ...request.Option) (*finspacedata.GetDatasetOutput, error) GetDatasetRequest(*finspacedata.GetDatasetInput) (*request.Request, *finspacedata.GetDatasetOutput) + GetExternalDataViewAccessDetails(*finspacedata.GetExternalDataViewAccessDetailsInput) (*finspacedata.GetExternalDataViewAccessDetailsOutput, error) + GetExternalDataViewAccessDetailsWithContext(aws.Context, *finspacedata.GetExternalDataViewAccessDetailsInput, ...request.Option) (*finspacedata.GetExternalDataViewAccessDetailsOutput, error) + GetExternalDataViewAccessDetailsRequest(*finspacedata.GetExternalDataViewAccessDetailsInput) (*request.Request, *finspacedata.GetExternalDataViewAccessDetailsOutput) + GetPermissionGroup(*finspacedata.GetPermissionGroupInput) (*finspacedata.GetPermissionGroupOutput, error) GetPermissionGroupWithContext(aws.Context, *finspacedata.GetPermissionGroupInput, ...request.Option) (*finspacedata.GetPermissionGroupOutput, error) GetPermissionGroupRequest(*finspacedata.GetPermissionGroupInput) (*request.Request, *finspacedata.GetPermissionGroupOutput) diff --git a/service/polly/api.go b/service/polly/api.go index 023c2efa54a..fc385d8b5a0 100644 --- a/service/polly/api.go +++ b/service/polly/api.go @@ -4314,6 +4314,18 @@ const ( // VoiceIdHannah is a VoiceId enum value VoiceIdHannah = "Hannah" + + // VoiceIdArthur is a VoiceId enum value + VoiceIdArthur = "Arthur" + + // VoiceIdDaniel is a VoiceId enum value + VoiceIdDaniel = "Daniel" + + // VoiceIdLiam is a VoiceId enum value + VoiceIdLiam = "Liam" + + // VoiceIdPedro is a VoiceId enum value + VoiceIdPedro = "Pedro" ) // VoiceId_Values returns all elements of the VoiceId enum @@ -4386,5 +4398,9 @@ func VoiceId_Values() []string { VoiceIdAyanda, VoiceIdArlet, VoiceIdHannah, + VoiceIdArthur, + VoiceIdDaniel, + VoiceIdLiam, + VoiceIdPedro, } }