The store's description.
" } }, + "ETag": { + "base": "The entity tag (ETag) is a hash of the object representing its semantic content.
", + "refs": { + "GetReadSetMetadataResponse$etag": "The entity tag (ETag) is a hash of the object meant to represent its semantic content.
", + "ReadSetListItem$etag": "The entity tag (ETag) is a hash of the object representing its semantic content.
" + } + }, + "ETagAlgorithm": { + "base": null, + "refs": { + "ETag$algorithm": "The algorithm used to calculate the read set’s ETag(s).
" + } + }, "Encoding": { "base": null, "refs": { @@ -2864,6 +2877,8 @@ "DeleteAnnotationStoreVersionsRequest$name": "The name of the annotation store from which versions are being deleted.
", "DeleteShareRequest$shareId": "The ID for the share request to be deleted.
", "DeleteVariantStoreRequest$name": "The store's name.
", + "ETag$source1": "The ETag hash calculated on Source1 of the read set.
", + "ETag$source2": "The ETag hash calculated on Source2 of the read set.
", "GetAnnotationStoreRequest$name": "The store's name.
", "GetAnnotationStoreResponse$name": "The store's name.
", "GetAnnotationStoreVersionRequest$name": "The name given to an annotation store version to distinguish it from others.
", diff --git a/models/apis/rds/2014-10-31/docs-2.json b/models/apis/rds/2014-10-31/docs-2.json index b81b382b959..0daec914fd2 100644 --- a/models/apis/rds/2014-10-31/docs-2.json +++ b/models/apis/rds/2014-10-31/docs-2.json @@ -22,7 +22,7 @@ "CreateDBClusterParameterGroup": "Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", "CreateDBClusterSnapshot": "Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", "CreateDBInstance": "Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
", - "CreateDBInstanceReadReplica": "Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.
Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance operation.
All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Your source DB instance or cluster must have backup retention enabled.
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
This command doesn't apply to RDS Custom.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Creates a new DB proxy.
", "CreateDBProxyEndpoint": "Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", "DeleteDBClusterSnapshot": "Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", - "DeleteDBInstance": "The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted.
If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it's no longer a read replica. After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.
For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
", "DeleteDBProxy": "Deletes an existing DB proxy.
", @@ -62,7 +62,7 @@ "DescribeDBClusterSnapshotAttributes": "Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", "DescribeDBClusters": "Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
", - "DescribeDBEngineVersions": "Returns a list of the available DB engines.
", + "DescribeDBEngineVersions": "Describes the properties of specific versions of DB engines.
", "DescribeDBInstanceAutomatedBackups": "Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.
All parameters are optional.
", "DescribeDBInstances": "Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
", @@ -315,7 +315,7 @@ "CreateDBClusterMessage$AvailabilityZones": "A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
", "DBCluster$AvailabilityZones": "The list of Availability Zones (AZs) where instances in the DB cluster can be created.
", "DBClusterAutomatedBackup$AvailabilityZones": "The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
", - "DBClusterSnapshot$AvailabilityZones": "Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
", + "DBClusterSnapshot$AvailabilityZones": "The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
", "RestoreDBClusterFromS3Message$AvailabilityZones": "A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
", "RestoreDBClusterFromSnapshotMessage$AvailabilityZones": "Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
" } @@ -430,20 +430,20 @@ "Boolean": { "base": null, "refs": { - "CreateDBProxyRequest$RequireTLS": "A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
", - "CreateDBProxyRequest$DebugLogging": "Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
", + "CreateDBProxyRequest$RequireTLS": "Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
", + "CreateDBProxyRequest$DebugLogging": "Specifies whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
", "DBCluster$StorageEncrypted": "Indicates whether the DB cluster is encrypted.
", "DBCluster$AutoMinorVersionUpgrade": "Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
", - "DBClusterAutomatedBackup$IAMDatabaseAuthenticationEnabled": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
", - "DBClusterAutomatedBackup$StorageEncrypted": "Specifies whether the source DB cluster is encrypted.
", - "DBClusterMember$IsClusterWriter": "Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Specifies whether the DB cluster snapshot is encrypted.
", - "DBClusterSnapshot$IAMDatabaseAuthenticationEnabled": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
", - "DBEngineVersion$SupportsLogExportsToCloudwatchLogs": "A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
", + "DBClusterAutomatedBackup$IAMDatabaseAuthenticationEnabled": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
", + "DBClusterAutomatedBackup$StorageEncrypted": "Indicates whether the source DB cluster is encrypted.
", + "DBClusterMember$IsClusterWriter": "Indicates whether the cluster member is the primary DB instance for the DB cluster.
", + "DBClusterSnapshot$StorageEncrypted": "Indicates whether the DB cluster snapshot is encrypted.
", + "DBClusterSnapshot$IAMDatabaseAuthenticationEnabled": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
", + "DBEngineVersion$SupportsLogExportsToCloudwatchLogs": "Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
", "DBEngineVersion$SupportsReadReplica": "Indicates whether the database engine version supports read replicas.
", - "DBEngineVersion$SupportsParallelQuery": "A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
", - "DBEngineVersion$SupportsGlobalDatabases": "A value that indicates whether you can use Aurora global databases with a specific DB engine version.
", - "DBEngineVersion$SupportsBabelfish": "A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
", + "DBEngineVersion$SupportsParallelQuery": "Indicates whether you can use Aurora parallel query with a specific DB engine version.
", + "DBEngineVersion$SupportsGlobalDatabases": "Indicates whether you can use Aurora global databases with a specific DB engine version.
", + "DBEngineVersion$SupportsBabelfish": "Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
", "DBInstance$MultiAZ": "Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
", "DBInstance$AutoMinorVersionUpgrade": "Indicates whether minor version patches are applied automatically.
", "DBInstance$PubliclyAccessible": "Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", @@ -451,46 +451,46 @@ "DBInstance$CopyTagsToSnapshot": "Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
", "DBInstance$DeletionProtection": "Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
", - "DBInstanceAutomatedBackup$Encrypted": "Specifies whether the automated backup is encrypted.
", + "DBInstanceAutomatedBackup$Encrypted": "Indicates whether the automated backup is encrypted.
", "DBInstanceAutomatedBackup$IAMDatabaseAuthenticationEnabled": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
", - "DBInstanceStatusInfo$Normal": "Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
", + "DBInstanceStatusInfo$Normal": "A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
", "DBProxy$RequireTLS": "Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
", - "DBProxy$DebugLogging": "Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
", - "DBProxyEndpoint$IsDefault": "A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
", - "DBProxyTargetGroup$IsDefault": "Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.
Specifies whether the DB snapshot is encrypted.
", - "DBSnapshot$IAMDatabaseAuthenticationEnabled": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
", - "DeleteDBClusterMessage$SkipFinalSnapshot": "A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.
If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
", - "DescribeDBClusterSnapshotsMessage$IncludeShared": "A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
", + "DBProxy$DebugLogging": "Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
", + "DBProxyEndpoint$IsDefault": "Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
", + "DBProxyTargetGroup$IsDefault": "Indicates whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.
Indicates whether the DB snapshot is encrypted.
", + "DBSnapshot$IAMDatabaseAuthenticationEnabled": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
", + "DeleteDBClusterMessage$SkipFinalSnapshot": "Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
Specifies whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.
If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
", + "DescribeDBClusterSnapshotsMessage$IncludeShared": "Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
", "DescribeDBClustersMessage$IncludeShared": "Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
", - "DescribeDBEngineVersionsMessage$DefaultOnly": "A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
", - "DescribeDBSnapshotsMessage$IncludeShared": "A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
", - "DescribeDBSnapshotsMessage$IncludePublic": "A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
", - "DownloadDBLogFilePortionDetails$AdditionalDataPending": "Boolean value that if true, indicates there is more data to be downloaded.
", + "DescribeDBEngineVersionsMessage$DefaultOnly": "Specifies whether to return only the default version of the specified engine or the engine and major version combination.
", + "DescribeDBSnapshotsMessage$IncludeShared": "Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
", + "DescribeDBSnapshotsMessage$IncludePublic": "Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
", + "DownloadDBLogFilePortionDetails$AdditionalDataPending": "A Boolean value that, if true, indicates there is more data to be downloaded.
", "EventSubscription$Enabled": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
", "FailoverState$IsDataLossAllowed": "Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
", - "GlobalClusterMember$IsWriter": "Specifies whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.
", + "GlobalClusterMember$IsWriter": "Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.
", "ModifyDBClusterMessage$ApplyImmediately": "Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "ModifyDBClusterMessage$AllowMajorVersionUpgrade": "Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
Specifies whether engine mode changes from serverless to provisioned are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that's a different major version than the DB instance's current version.
A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
", - "Option$Persistent": "Indicate if this option is persistent.
", - "Option$Permanent": "Indicate if this option is permanent.
", + "ModifyOptionGroupMessage$ApplyImmediately": "Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
", + "Option$Persistent": "Indicates whether this option is persistent.
", + "Option$Permanent": "Indicates whether this option is permanent.
", "OptionGroup$AllowsVpcAndNonVpcInstanceMemberships": "Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
Specifies whether the option requires a port.
", + "OptionGroupOption$PortRequired": "Indicates whether the option requires a port.
", "OptionGroupOption$Persistent": "Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
", "OptionGroupOption$Permanent": "Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
", "OptionGroupOption$RequiresAutoMinorEngineVersionUpgrade": "If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
", "OptionGroupOption$VpcOnly": "If true, you can only use this option with a DB instance that is in a VPC.
", - "OptionGroupOptionSetting$IsModifiable": "Boolean value where true indicates that this option group option can be changed from the default value.
", - "OptionGroupOptionSetting$IsRequired": "Boolean value where true indicates that a value must be specified for this option setting of the option group option.
", - "OptionSetting$IsModifiable": "A Boolean value that, when true, indicates the option setting can be modified from the default.
", - "OptionSetting$IsCollection": "Indicates if the option setting is part of a collection.
", - "OptionVersion$IsDefault": "True if the version is the default version of the option, and otherwise false.
", + "OptionGroupOptionSetting$IsModifiable": "Indicates whether this option group option can be changed from the default value.
", + "OptionGroupOptionSetting$IsRequired": "Indicates whether a value must be specified for this option setting of the option group option.
", + "OptionSetting$IsModifiable": "Indicates whether the option setting can be modified from the default.
", + "OptionSetting$IsCollection": "Indicates whether the option setting is part of a collection.
", + "OptionVersion$IsDefault": "Indicates whether the version is the default version of the option.
", "OrderableDBInstanceOption$MultiAZCapable": "Indicates whether a DB instance is Multi-AZ capable.
", "OrderableDBInstanceOption$ReadReplicaCapable": "Indicates whether a DB instance can have a read replica.
", "OrderableDBInstanceOption$Vpc": "Indicates whether a DB instance is in a VPC.
", @@ -498,35 +498,35 @@ "OrderableDBInstanceOption$SupportsIops": "Indicates whether a DB instance supports provisioned IOPS.
", "OrderableDBInstanceOption$SupportsEnhancedMonitoring": "Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
", "OrderableDBInstanceOption$SupportsIAMDatabaseAuthentication": "Indicates whether a DB instance supports IAM database authentication.
", - "OrderableDBInstanceOption$SupportsPerformanceInsights": "True if a DB instance supports Performance Insights, otherwise false.
", - "OrderableDBInstanceOption$OutpostCapable": "Whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
", - "OrderableDBInstanceOption$SupportsGlobalDatabases": "A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
", - "OrderableDBInstanceOption$SupportsClusters": "Whether DB instances can be configured as a Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", + "OrderableDBInstanceOption$SupportsPerformanceInsights": "Indicates whether a DB instance supports Performance Insights.
", + "OrderableDBInstanceOption$OutpostCapable": "Indicates whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
", + "OrderableDBInstanceOption$SupportsGlobalDatabases": "Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
", + "OrderableDBInstanceOption$SupportsClusters": "Indicates whether DB instances can be configured as a Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", "OrderableDBInstanceOption$SupportsStorageThroughput": "Indicates whether a DB instance supports storage throughput.
", "Parameter$IsModifiable": "Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
Indicates if the reservation applies to Multi-AZ deployments.
", - "ReservedDBInstancesOffering$MultiAZ": "Indicates if the offering applies to Multi-AZ deployments.
", - "ResetDBClusterParameterGroupMessage$ResetAllParameters": "A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
", - "RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime": "A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "ReservedDBInstance$MultiAZ": "Indicates whether the reservation applies to Multi-AZ deployments.
", + "ReservedDBInstancesOffering$MultiAZ": "Indicates whether the offering applies to Multi-AZ deployments.
", + "ResetDBClusterParameterGroupMessage$ResetAllParameters": "Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
Specifies whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
", + "RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime": "Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBInstanceToPointInTimeMessage$UseLatestRestorableTime": "Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints:
Can't be specified if the RestoreTime parameter is provided.
Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
", + "SourceRegion$SupportsDBInstanceAutomatedBackupsReplication": "Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
", "StartActivityStreamResponse$ApplyImmediately": "Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
", - "UpgradeTarget$AutoUpgrade": "A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.
", - "ValidStorageOptions$SupportsStorageAutoscaling": "Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
" + "UpgradeTarget$AutoUpgrade": "Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
", + "ValidStorageOptions$SupportsStorageAutoscaling": "Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
" } }, "BooleanOptional": { "base": null, "refs": { - "BacktrackDBClusterMessage$Force": "A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
", - "BacktrackDBClusterMessage$UseEarliestTimeOnPointInTimeUnavailable": "A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
", - "Certificate$CustomerOverride": "Whether there is an override for the default certificate identifier.
", - "ClusterPendingModifiedValues$IAMDatabaseAuthenticationEnabled": "A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
", - "CopyDBClusterSnapshotMessage$CopyTags": "A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
", - "CopyDBSnapshotMessage$CopyTags": "A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.
", - "CopyDBSnapshotMessage$CopyOptionGroup": "A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.
", + "BacktrackDBClusterMessage$Force": "Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
", + "BacktrackDBClusterMessage$UseEarliestTimeOnPointInTimeUnavailable": "Specifies whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
", + "Certificate$CustomerOverride": "Indicates whether there is an override for the default certificate identifier.
", + "ClusterPendingModifiedValues$IAMDatabaseAuthenticationEnabled": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
", + "CopyDBClusterSnapshotMessage$CopyTags": "Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
", + "CopyDBSnapshotMessage$CopyTags": "Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.
", + "CopyDBSnapshotMessage$CopyOptionGroup": "Specifies whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.
", "CreateCustomDBEngineVersionMessage$UseAwsProvidedLatestImage": "Reserved for future use.
", "CreateDBClusterMessage$StorageEncrypted": "Specifies whether the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "CreateDBClusterMessage$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
", @@ -549,16 +549,16 @@ "CreateDBInstanceMessage$DeletionProtection": "Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
", "CreateDBInstanceMessage$ManageMasterUserPassword": "Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
A value that indicates whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.
This setting doesn't apply to RDS Custom.
Default: Inherits from the source DB instance
", - "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", - "CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.
", - "CreateDBInstanceReadReplicaMessage$EnableIAMDatabaseAuthentication": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights": "A value that indicates whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceReadReplicaMessage$UseDefaultProcessorFeatures": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceReadReplicaMessage$DeletionProtection": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
", - "CreateDBInstanceReadReplicaMessage$EnableCustomerOwnedIp": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
", - "CreateEventSubscriptionMessage$Enabled": "A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
", + "CreateDBInstanceReadReplicaMessage$MultiAZ": "Specifies whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.
This setting doesn't apply to RDS Custom DB instances.
Default: Inherits the value from the source DB instance.
", + "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", + "CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot": "Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren't copied.
", + "CreateDBInstanceReadReplicaMessage$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights": "Specifies whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceReadReplicaMessage$UseDefaultProcessorFeatures": "Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceReadReplicaMessage$DeletionProtection": "Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
", + "CreateDBInstanceReadReplicaMessage$EnableCustomerOwnedIp": "Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
", + "CreateEventSubscriptionMessage$Enabled": "Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
", "CreateGlobalClusterMessage$DeletionProtection": "Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.
", "CreateGlobalClusterMessage$StorageEncrypted": "Specifies whether to enable storage encryption for the new global database cluster.
Constraints:
Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.
Indicates whether the DB cluster has instances in multiple Availability Zones.
", @@ -567,29 +567,29 @@ "DBCluster$HttpEndpointEnabled": "Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
", "DBCluster$CopyTagsToSnapshot": "Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
", "DBCluster$CrossAccountClone": "Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
", - "DBCluster$GlobalWriteForwardingRequested": "Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
", "DBCluster$PerformanceInsightsEnabled": "Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
", - "DBEngineVersion$SupportsCertificateRotationWithoutRestart": "A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
", - "DBEngineVersion$SupportsLocalWriteForwarding": "A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
", + "DBEngineVersion$SupportsCertificateRotationWithoutRestart": "Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
", + "DBEngineVersion$SupportsLocalWriteForwarding": "Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
", "DBInstance$PerformanceInsightsEnabled": "Indicates whether Performance Insights is enabled for the DB instance.
", "DBInstance$CustomerOwnedIpEnabled": "Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
", "DBInstance$ActivityStreamEngineNativeAuditFieldsIncluded": "Indicates whether engine-native audit fields are included in the database activity stream.
", "DeleteBlueGreenDeploymentRequest$DeleteTarget": "Specifies whether to delete the resources in the green environment. You can't specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.
A value that indicates whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.
", - "DeleteDBInstanceMessage$DeleteAutomatedBackups": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
", - "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "A value that indicates whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.
A value that indicates whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.
A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
", - "DescribeOrderableDBInstanceOptionsMessage$Vpc": "A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
", - "DescribeReservedDBInstancesMessage$MultiAZ": "A value that indicates whether to show only those reservations that support Multi-AZ.
", - "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "A value that indicates whether to show only those reservations that support Multi-AZ.
", + "DeleteDBClusterMessage$DeleteAutomatedBackups": "Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.
", + "DeleteDBInstanceMessage$DeleteAutomatedBackups": "Specifies whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
", + "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
", + "DescribeDBEngineVersionsMessage$ListSupportedTimezones": "Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
", + "DescribeDBEngineVersionsMessage$IncludeAll": "Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
", + "DescribeOrderableDBInstanceOptionsMessage$Vpc": "Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
", + "DescribeReservedDBInstancesMessage$MultiAZ": "Specifies whether to show only those reservations that support Multi-AZ.
", + "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "Specifies whether to show only those reservations that support Multi-AZ.
", "FailoverGlobalClusterMessage$AllowDataLoss": "Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.
If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.
Constraints:
Can't be specified together with the Switchover parameter.
Specifies whether to switch over this global database cluster.
Constraints:
Can't be specified together with the AllowDataLoss parameter.
The storage encryption setting for the global database cluster.
", "GlobalCluster$DeletionProtection": "The deletion protection setting for the new global database cluster.
", "ModifyActivityStreamResponse$EngineNativeAuditFieldsIncluded": "Indicates whether engine-native audit fields are included in the database activity stream.
", - "ModifyCertificatesMessage$RemoveCustomerOverride": "A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
", + "ModifyCertificatesMessage$RemoveCustomerOverride": "Specifies whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
", "ModifyDBClusterMessage$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
", "ModifyDBClusterMessage$DeletionProtection": "Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "ModifyDBClusterMessage$EnableHttpEndpoint": "Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
", @@ -615,65 +615,65 @@ "ModifyDBInstanceMessage$RotateMasterUserPassword": "Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.
", "ModifyDBProxyRequest$DebugLogging": "Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
", - "ModifyEventSubscriptionMessage$Enabled": "A value that indicates whether to activate the subscription.
", + "ModifyEventSubscriptionMessage$Enabled": "Specifies whether to activate the subscription.
", "ModifyGlobalClusterMessage$DeletionProtection": "Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.
", "ModifyGlobalClusterMessage$AllowMajorVersionUpgrade": "Specifies whether to allow major version upgrades.
Constraints: Must be enabled if you specify a value for the EngineVersion parameter that's a different major version than the global cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
", "OptionGroupOption$SupportsOptionVersionDowngrade": "If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
", - "OptionGroupOption$CopyableCrossAccount": "Specifies whether the option can be copied across Amazon Web Services accounts.
", - "OrderableDBInstanceOption$SupportsStorageAutoscaling": "Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
", - "OrderableDBInstanceOption$SupportsKerberosAuthentication": "Whether a DB instance supports Kerberos Authentication.
", - "PendingModifiedValues$MultiAZ": "A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
", - "PendingModifiedValues$IAMDatabaseAuthenticationEnabled": "Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
", - "RebootDBInstanceMessage$ForceFailover": "A value that indicates whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
", - "RestoreDBClusterFromS3Message$StorageEncrypted": "A value that indicates whether the restored DB cluster is encrypted.
", - "RestoreDBClusterFromS3Message$EnableIAMDatabaseAuthentication": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
", - "RestoreDBClusterFromS3Message$DeletionProtection": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
", - "RestoreDBClusterFromS3Message$CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
", - "RestoreDBClusterFromS3Message$ManageMasterUserPassword": "A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", - "RestoreDBClusterFromSnapshotMessage$DeletionProtection": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "RestoreDBClusterFromSnapshotMessage$CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "RestoreDBClusterFromSnapshotMessage$PubliclyAccessible": "A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "RestoreDBClusterToPointInTimeMessage$EnableIAMDatabaseAuthentication": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", - "RestoreDBClusterToPointInTimeMessage$DeletionProtection": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "RestoreDBClusterToPointInTimeMessage$CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "RestoreDBClusterToPointInTimeMessage$PubliclyAccessible": "A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
", - "RestoreDBInstanceFromDBSnapshotMessage$MultiAZ": "A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", - "RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade": "A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
", - "RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
", - "RestoreDBInstanceFromDBSnapshotMessage$EnableIAMDatabaseAuthentication": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
", - "RestoreDBInstanceFromDBSnapshotMessage$UseDefaultProcessorFeatures": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
", - "RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
", - "RestoreDBInstanceFromDBSnapshotMessage$EnableCustomerOwnedIp": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
", - "RestoreDBInstanceFromS3Message$MultiAZ": "A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
", - "RestoreDBInstanceFromS3Message$PubliclyAccessible": "A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", - "RestoreDBInstanceFromS3Message$StorageEncrypted": "A value that indicates whether the new DB instance is encrypted or not.
", - "RestoreDBInstanceFromS3Message$CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
", - "RestoreDBInstanceFromS3Message$EnableIAMDatabaseAuthentication": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
", - "RestoreDBInstanceFromS3Message$EnablePerformanceInsights": "A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
", - "RestoreDBInstanceFromS3Message$UseDefaultProcessorFeatures": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
", - "RestoreDBInstanceFromS3Message$DeletionProtection": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
", - "RestoreDBInstanceFromS3Message$ManageMasterUserPassword": "A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Indicates whether the option can be copied across Amazon Web Services accounts.
", + "OrderableDBInstanceOption$SupportsStorageAutoscaling": "Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
", + "OrderableDBInstanceOption$SupportsKerberosAuthentication": "Indicates whether a DB instance supports Kerberos Authentication.
", + "PendingModifiedValues$MultiAZ": "Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
", + "PendingModifiedValues$IAMDatabaseAuthenticationEnabled": "Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
", + "RebootDBInstanceMessage$ForceFailover": "Specifies whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
", + "RestoreDBClusterFromS3Message$StorageEncrypted": "Specifies whether the restored DB cluster is encrypted.
", + "RestoreDBClusterFromS3Message$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
", + "RestoreDBClusterFromS3Message$DeletionProtection": "Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
", + "RestoreDBClusterFromS3Message$CopyTagsToSnapshot": "Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
", + "RestoreDBClusterFromS3Message$ManageMasterUserPassword": "Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", + "RestoreDBClusterFromSnapshotMessage$DeletionProtection": "Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "RestoreDBClusterFromSnapshotMessage$CopyTagsToSnapshot": "Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "RestoreDBClusterFromSnapshotMessage$PubliclyAccessible": "Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "RestoreDBClusterToPointInTimeMessage$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", + "RestoreDBClusterToPointInTimeMessage$DeletionProtection": "Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "RestoreDBClusterToPointInTimeMessage$CopyTagsToSnapshot": "Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "RestoreDBClusterToPointInTimeMessage$PubliclyAccessible": "Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
", + "RestoreDBInstanceFromDBSnapshotMessage$MultiAZ": "Specifies whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", + "RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade": "Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
", + "RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot": "Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
", + "RestoreDBInstanceFromDBSnapshotMessage$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
", + "RestoreDBInstanceFromDBSnapshotMessage$UseDefaultProcessorFeatures": "Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
", + "RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection": "Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
", + "RestoreDBInstanceFromDBSnapshotMessage$EnableCustomerOwnedIp": "Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
", + "RestoreDBInstanceFromS3Message$MultiAZ": "Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
", + "RestoreDBInstanceFromS3Message$PubliclyAccessible": "Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", + "RestoreDBInstanceFromS3Message$StorageEncrypted": "Specifies whether the new DB instance is encrypted or not.
", + "RestoreDBInstanceFromS3Message$CopyTagsToSnapshot": "Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
", + "RestoreDBInstanceFromS3Message$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
", + "RestoreDBInstanceFromS3Message$EnablePerformanceInsights": "Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
", + "RestoreDBInstanceFromS3Message$UseDefaultProcessorFeatures": "Specifies whether the DB instance class of the DB instance uses its default processor features.
", + "RestoreDBInstanceFromS3Message$DeletionProtection": "Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
", + "RestoreDBInstanceFromS3Message$ManageMasterUserPassword": "Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Secifies whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraints:
You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
", "RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade": "Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
", "RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot": "Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
", "RestoreDBInstanceToPointInTimeMessage$EnableIAMDatabaseAuthentication": "Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
", - "RestoreDBInstanceToPointInTimeMessage$UseDefaultProcessorFeatures": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
", + "RestoreDBInstanceToPointInTimeMessage$UseDefaultProcessorFeatures": "Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
", "RestoreDBInstanceToPointInTimeMessage$DeletionProtection": "Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
", "RestoreDBInstanceToPointInTimeMessage$EnableCustomerOwnedIp": "Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
", - "ScalingConfiguration$AutoPause": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
", + "ScalingConfiguration$AutoPause": "Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
", "StartActivityStreamRequest$ApplyImmediately": "Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
", "StartActivityStreamRequest$EngineNativeAuditFieldsIncluded": "Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
", "StartActivityStreamResponse$EngineNativeAuditFieldsIncluded": "Indicates whether engine-native audit fields are included in the database activity stream.
", "StopActivityStreamRequest$ApplyImmediately": "Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
", - "UpgradeTarget$SupportsParallelQuery": "A value that indicates whether you can use Aurora parallel query with the target engine version.
", - "UpgradeTarget$SupportsGlobalDatabases": "A value that indicates whether you can use Aurora global databases with the target engine version.
", - "UpgradeTarget$SupportsBabelfish": "A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
", - "UpgradeTarget$SupportsLocalWriteForwarding": "A value that indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
" + "UpgradeTarget$SupportsParallelQuery": "Indicates whether you can use Aurora parallel query with the target engine version.
", + "UpgradeTarget$SupportsGlobalDatabases": "Indicates whether you can use Aurora global databases with the target engine version.
", + "UpgradeTarget$SupportsBabelfish": "Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
", + "UpgradeTarget$SupportsLocalWriteForwarding": "Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
" } }, "BucketName": { @@ -1402,7 +1402,7 @@ } }, "DBInstanceRole": { - "base": "Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
", + "base": "Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
", "refs": { "DBInstanceRoles$member": null } @@ -1564,7 +1564,7 @@ "DBProxyEndpointTargetRole": { "base": null, "refs": { - "CreateDBProxyEndpointRequest$TargetRole": "A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
" } }, @@ -2423,7 +2423,7 @@ } }, "ExportTask": { - "base": "Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks action.
Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks operation.
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
", "DBClusterAutomatedBackup$AllocatedStorage": "For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
The port number that the automated backup used for connections.
Default: Inherits from the source DB cluster
Valid Values: 1150-65535
Specifies the allocated storage size in gibibytes (GiB).
", - "DBClusterSnapshot$Port": "Specifies the port that the DB cluster was listening on at the time of the snapshot.
", - "DBClusterSnapshot$PercentProgress": "Specifies the percentage of the estimated data that has been transferred.
", + "DBClusterSnapshot$AllocatedStorage": "The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
", + "DBClusterSnapshot$Port": "The port that the DB cluster was listening on at the time of the snapshot.
", + "DBClusterSnapshot$PercentProgress": "The percentage of the estimated data that has been transferred.
", "DBInstance$AllocatedStorage": "The amount of storage in gibibytes (GiB) allocated for the DB instance.
", "DBInstance$BackupRetentionPeriod": "The number of days for which automatic DB snapshots are retained.
", "DBInstance$DbInstancePort": "The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
", - "DBInstanceAutomatedBackup$AllocatedStorage": "Specifies the allocated storage size in gibibytes (GiB).
", + "DBInstanceAutomatedBackup$AllocatedStorage": "The allocated storage size for the the automated backup in gibibytes (GiB).
", "DBInstanceAutomatedBackup$Port": "The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
", "DBProxyTarget$Port": "The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
", @@ -2696,9 +2696,9 @@ "ClusterPendingModifiedValues$BackupRetentionPeriod": "The number of days for which automatic DB snapshots are retained.
", "ClusterPendingModifiedValues$AllocatedStorage": "The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
", - "ConnectionPoolConfiguration$MaxConnectionsPercent": "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints: Must be between 1 and 100.
", - "ConnectionPoolConfiguration$MaxIdleConnectionsPercent": "Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
Default: 120
Constraints: between 1 and 3600, or 0 representing unlimited
", + "ConnectionPoolConfiguration$MaxConnectionsPercent": "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints:
Must be between 1 and 100.
A value that controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.
Constraints:
Must be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions. For an unlimited wait time, specify 0.
Default: 120
Constraints:
Must be between 0 and 3600.
The number of days for which automated backups are retained.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
The port number on which the instances in the DB cluster accept connections.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: 1150-65535
Default:
RDS for MySQL and Aurora MySQL - 3306
RDS for PostgreSQL and Aurora PostgreSQL - 5432
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
This setting is required to create a Multi-AZ DB cluster.
", @@ -2714,12 +2714,12 @@ "CreateDBInstanceMessage$PerformanceInsightsRetentionPeriod": "The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
Amazon Aurora (Storage is managed by the DB cluster.)
RDS Custom
The storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
", - "CreateDBInstanceReadReplicaMessage$Port": "The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
", - "CreateDBInstanceReadReplicaMessage$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
", + "CreateDBInstanceReadReplicaMessage$Port": "The port number that the DB instance uses for connections.
Valid Values: 1150-65535
Default: Inherits the value from the source DB instance.
", + "CreateDBInstanceReadReplicaMessage$Iops": "The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
", + "CreateDBInstanceReadReplicaMessage$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
", - "CreateDBInstanceReadReplicaMessage$StorageThroughput": "Specifies the storage throughput value for the read replica.
This setting doesn't apply to RDS Custom or Amazon Aurora.
", + "CreateDBInstanceReadReplicaMessage$StorageThroughput": "Specifies the storage throughput value for the read replica.
This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.
", "CreateDBInstanceReadReplicaMessage$AllocatedStorage": "The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
", "DBCluster$AllocatedStorage": "For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
The IOPS (I/O operations per second) value for the automated backup.
", "DBInstanceAutomatedBackup$BackupRetentionPeriod": "The retention period for the automated backups.
", - "DBInstanceAutomatedBackup$StorageThroughput": "Specifies the storage throughput for the automated backup.
", + "DBInstanceAutomatedBackup$StorageThroughput": "The storage throughput for the automated backup.
", "DBSnapshot$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
", "DBSnapshot$StorageThroughput": "Specifies the storage throughput for the DB snapshot.
", "DescribeCertificatesMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
", @@ -3006,7 +3006,7 @@ "LocalWriteForwardingStatus": { "base": null, "refs": { - "DBCluster$LocalWriteForwardingStatus": "Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
" + "DBCluster$LocalWriteForwardingStatus": "Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
" } }, "LogTypeList": { @@ -3016,7 +3016,7 @@ "CloudwatchLogsExportConfiguration$DisableLogTypes": "The list of log types to disable.
", "CreateDBClusterMessage$EnableCloudwatchLogsExports": "The list of log types that need to be enabled for exporting to CloudWatch Logs.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
", "CreateDBInstanceMessage$EnableCloudwatchLogsExports": "The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
RDS Custom
The following values are valid for each DB engine:
RDS for MariaDB - audit | error | general | slowquery
RDS for Microsoft SQL Server - agent | error
RDS for MySQL - audit | error | general | slowquery
RDS for Oracle - alert | audit | listener | trace | oemagent
RDS for PostgreSQL - postgresql | upgrade
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
", + "CreateDBInstanceReadReplicaMessage$EnableCloudwatchLogsExports": "The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
", "DBCluster$EnabledCloudwatchLogsExports": "A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
", "DBEngineVersion$ExportableLogTypes": "The types of logs that the database engine has available for export to CloudWatch Logs.
", "DBInstance$EnabledCloudwatchLogsExports": "A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
", @@ -3254,7 +3254,7 @@ } }, "Option": { - "base": "Option details.
", + "base": "The details of an option.
", "refs": { "OptionsList$member": null } @@ -3494,7 +3494,7 @@ "base": null, "refs": { "CreateDBInstanceMessage$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
", - "CreateDBInstanceReadReplicaMessage$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
", + "CreateDBInstanceReadReplicaMessage$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom DB instances.
", "DBInstance$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
", "DBSnapshot$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
", "ModifyDBInstanceMessage$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom DB instances.
", @@ -3804,7 +3804,7 @@ "base": "Earliest and latest time an instance can be restored to:
", "refs": { "DBClusterAutomatedBackup$RestoreWindow": null, - "DBInstanceAutomatedBackup$RestoreWindow": "Earliest and latest time an instance can be restored to.
" + "DBInstanceAutomatedBackup$RestoreWindow": "The earliest and latest time a DB instance can be restored to.
" } }, "RevokeDBSecurityGroupIngressMessage": { @@ -4034,8 +4034,8 @@ "AddSourceIdentifierToSubscriptionMessage$SourceIdentifier": "The identifier of the event source to be added.
Constraints:
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", "ApplyPendingMaintenanceActionMessage$ResourceIdentifier": "The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", - "ApplyPendingMaintenanceActionMessage$ApplyAction": "The pending maintenance action to apply to this resource.
Valid values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.
Valid values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
The pending maintenance action to apply to this resource.
Valid Values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.
Valid Values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
The name of the DB security group to add authorization to.
", "AuthorizeDBSecurityGroupIngressMessage$CIDRIP": "The IP range to authorize.
", @@ -4123,7 +4123,7 @@ "CreateDBInstanceMessage$DBInstanceClass": "The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
The database engine to use for this DB instance.
Not every database engine is available in every Amazon Web Services Region.
Valid Values:
aurora-mysql (for Aurora MySQL DB instances)
aurora-postgresql (for Aurora PostgreSQL DB instances)
custom-oracle-ee (for RDS Custom for Oracle DB instances)
custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The name for the master user.
This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.
This setting is required for RDS DB instances.
Constraints:
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
The password for the master user.
This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.
Constraints:
Can't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\".
Length Constraints:
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
The password for the master user.
This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.
Constraints:
Can't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.
Length Constraints:
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Constraints:
The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
Example: us-east-1d
A DB subnet group to associate with this DB instance.
Constraints:
Must match the name of an existing DB subnet group.
Must not be default.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term \"Oracle database instance\" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
", "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
Can't be specified if the SourceDBClusterIdentifier parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
", + "CreateDBInstanceReadReplicaMessage$DBInstanceClass": "The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits the value from the source DB instance.
", "CreateDBInstanceReadReplicaMessage$AvailabilityZone": "The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
The option group the DB instance is associated with. If omitted, the option group associated with the source instance or cluster is used.
For SQL Server, you must use the option group associated with the source.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceReadReplicaMessage$DBParameterGroupName": "The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't supported for RDS Custom.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
Constraints:
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
Not specify a DB subnet group. All these read replicas are created outside of any VPC.
Example: mydbsubnetgroup
Specifies the storage type to be associated with the read replica.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
", + "CreateDBInstanceReadReplicaMessage$OptionGroupName": "The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.
For SQL Server, you must use the option group associated with the source.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceReadReplicaMessage$DBParameterGroupName": "The name of the DB parameter group to associate with this DB instance.
If you don't specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of the source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or for RDS Custom.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
Constraints:
If supplied, must match the name of an existing DB subnet group.
The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:
Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
Not specify a DB subnet group. All these read replicas are created outside of any VPC.
Example: mydbsubnetgroup
The storage type to associate with the read replica.
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Valid Values: gp2 | gp3 | io1 | standard
Default: io1 if the Iops parameter is specified. Otherwise, gp2.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
", "CreateDBInstanceReadReplicaMessage$KmsKeyId": "The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
", - "CreateDBInstanceReadReplicaMessage$PreSignedUrl": "When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
This setting applies only when replicating from a source DB instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceReadReplicaMessage$PerformanceInsightsKMSKeyId": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceReadReplicaMessage$Domain": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceReadReplicaMessage$DomainIAMRoleName": "The name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
", + "CreateDBInstanceReadReplicaMessage$PreSignedUrl": "When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
This setting applies only when replicating from a source DB instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceReadReplicaMessage$PerformanceInsightsKMSKeyId": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceReadReplicaMessage$Domain": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceReadReplicaMessage$DomainIAMRoleName": "The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom DB instances.
", "CreateDBInstanceReadReplicaMessage$DomainFqdn": "The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
", - "CreateDBInstanceReadReplicaMessage$NetworkType": "The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", + "CreateDBInstanceReadReplicaMessage$CustomIamInstanceProfile": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom DB instances.
", + "CreateDBInstanceReadReplicaMessage$NetworkType": "The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", "CreateDBInstanceReadReplicaMessage$SourceDBClusterIdentifier": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
Must be the identifier of an existing Multi-AZ DB cluster.
Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn't supported.
The name of the DB parameter group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The description for the DB subnet group.
", "CreateEventSubscriptionMessage$SubscriptionName": "The name of the subscription.
Constraints: The name must be less than 255 characters.
", "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", - "CreateEventSubscriptionMessage$SourceType": "The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
", "CreateGlobalClusterMessage$SourceDBClusterIdentifier": "The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:
DatabaseName
Engine
EngineVersion
StorageEncrypted
The database engine to use for this global database cluster.
Valid Values: aurora-mysql | aurora-postgresql
Constraints:
Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
", "DBClusterRole$Status": "Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
", - "DBClusterSnapshot$DBClusterSnapshotIdentifier": "Specifies the identifier for the DB cluster snapshot.
", - "DBClusterSnapshot$DBClusterIdentifier": "Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
", - "DBClusterSnapshot$Engine": "Specifies the name of the database engine for this DB cluster snapshot.
", - "DBClusterSnapshot$EngineMode": "Provides the engine mode of the database engine for this DB cluster snapshot.
", - "DBClusterSnapshot$Status": "Specifies the status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
Provides the VPC ID associated with the DB cluster snapshot.
", - "DBClusterSnapshot$MasterUsername": "Provides the master username for this DB cluster snapshot.
", - "DBClusterSnapshot$EngineVersion": "Provides the version of the database engine for this DB cluster snapshot.
", - "DBClusterSnapshot$LicenseModel": "Provides the license model information for this DB cluster snapshot.
", - "DBClusterSnapshot$SnapshotType": "Provides the type of the DB cluster snapshot.
", + "DBClusterSnapshot$DBClusterSnapshotIdentifier": "The identifier for the DB cluster snapshot.
", + "DBClusterSnapshot$DBClusterIdentifier": "The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
", + "DBClusterSnapshot$Engine": "The name of the database engine for this DB cluster snapshot.
", + "DBClusterSnapshot$EngineMode": "The engine mode of the database engine for this DB cluster snapshot.
", + "DBClusterSnapshot$Status": "The status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
The VPC ID associated with the DB cluster snapshot.
", + "DBClusterSnapshot$MasterUsername": "The master username for this DB cluster snapshot.
", + "DBClusterSnapshot$EngineVersion": "The version of the database engine for this DB cluster snapshot.
", + "DBClusterSnapshot$LicenseModel": "The license model information for this DB cluster snapshot.
", + "DBClusterSnapshot$SnapshotType": "The type of the DB cluster snapshot.
", "DBClusterSnapshot$KmsKeyId": "If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
", - "DBClusterSnapshot$DBClusterSnapshotArn": "Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot.
", + "DBClusterSnapshot$DBClusterSnapshotArn": "The Amazon Resource Name (ARN) for the DB cluster snapshot.
", "DBClusterSnapshot$SourceDBClusterSnapshotArn": "If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
", "DBClusterSnapshot$DBSystemId": "Reserved for future use.
", "DBClusterSnapshot$StorageType": "The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
", - "DBClusterSnapshot$DbClusterResourceId": "Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from.
", + "DBClusterSnapshot$DbClusterResourceId": "The resource ID of the DB cluster that this DB cluster snapshot was created from.
", "DBClusterSnapshotAttribute$AttributeName": "The name of the manual DB cluster snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The identifier of the manual DB cluster snapshot that the attributes apply to.
", "DBClusterSnapshotMessage$Marker": "An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
", "DBInstanceAutomatedBackup$Region": "The Amazon Web Services Region associated with the automated backup.
", "DBInstanceAutomatedBackup$DBInstanceIdentifier": "The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
", - "DBInstanceAutomatedBackup$Status": "Provides a list of status information for an automated backup:
active - Automated backups for current instances.
retained - Automated backups for deleted instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
A list of status information for an automated backup:
active - Automated backups for current instances.
retained - Automated backups for deleted instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
", - "DBInstanceAutomatedBackup$VpcId": "Provides the VPC ID associated with the DB instance.
", + "DBInstanceAutomatedBackup$VpcId": "The VPC ID associated with the DB instance.
", "DBInstanceAutomatedBackup$MasterUsername": "The master user name of an automated backup.
", "DBInstanceAutomatedBackup$Engine": "The name of the database engine for this automated backup.
", "DBInstanceAutomatedBackup$EngineVersion": "The version of the database engine for the automated backup.
", - "DBInstanceAutomatedBackup$LicenseModel": "License model information for the automated backup.
", + "DBInstanceAutomatedBackup$LicenseModel": "The license model information for the automated backup.
", "DBInstanceAutomatedBackup$OptionGroupName": "The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
", "DBInstanceAutomatedBackup$TdeCredentialArn": "The ARN from the key store with which the automated backup is associated for TDE encryption.
", - "DBInstanceAutomatedBackup$StorageType": "Specifies the storage type associated with the automated backup.
", + "DBInstanceAutomatedBackup$StorageType": "The storage type associated with the automated backup.
", "DBInstanceAutomatedBackup$KmsKeyId": "The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
", "DBInstanceAutomatedBackup$Timezone": "The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
The Amazon Resource Name (ARN) for the replicated automated backups.
", - "DBInstanceAutomatedBackup$BackupTarget": "Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
", + "DBInstanceAutomatedBackup$BackupTarget": "The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
", "DBInstanceAutomatedBackup$AwsBackupRecoveryPointArn": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
", "DBInstanceAutomatedBackupMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the replicated automated backups.
", "DBInstanceMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
", "DBInstanceRole$FeatureName": "The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
This value is currently \"read replication.\"
", - "DBInstanceStatusInfo$Status": "Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
", + "DBInstanceStatusInfo$Status": "The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
", "DBInstanceStatusInfo$Message": "Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
", "DBParameterGroup$DBParameterGroupName": "The name of the DB parameter group.
", "DBParameterGroup$DBParameterGroupFamily": "The name of the DB parameter group family that this DB parameter group is compatible with.
", @@ -4472,7 +4472,7 @@ "DescribeDBClusterParameterGroupsMessage$DBClusterParameterGroupName": "The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.
A specific source to return parameters for.
Valid Values:
customer
engine
service
An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the DB cluster snapshot to describe the attributes for.
", "DescribeDBClusterSnapshotsMessage$DBClusterIdentifier": "The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
A specific DB cluster resource ID to describe.
", "DescribeDBClustersMessage$DBClusterIdentifier": "The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DB cluster identifier.
An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The database engine to return.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DBParameterGroupFamily.
The database engine to return version details for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
A specific database engine version to return details for.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DB parameter group family.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.
", "DescribeDBInstanceAutomatedBackupsMessage$DBInstanceIdentifier": "(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.
", @@ -4529,7 +4529,7 @@ "DescribeEngineDefaultClusterParametersMessage$Marker": "An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group family.
Valid Values:
aurora-mysql5.7
aurora-mysql8.0
aurora-postgresql10
aurora-postgresql11
aurora-postgresql12
aurora-postgresql13
aurora-postgresql14
custom-oracle-ee-19
mariadb10.2
mariadb10.3
mariadb10.4
mariadb10.5
mariadb10.6
mysql5.7
mysql8.0
oracle-ee-19
oracle-ee-cdb-19
oracle-ee-cdb-21
oracle-se2-19
oracle-se2-cdb-19
oracle-se2-cdb-21
postgres10
postgres11
postgres12
postgres13
postgres14
sqlserver-ee-11.0
sqlserver-ee-12.0
sqlserver-ee-13.0
sqlserver-ee-14.0
sqlserver-ee-15.0
sqlserver-ex-11.0
sqlserver-ex-12.0
sqlserver-ex-13.0
sqlserver-ex-14.0
sqlserver-ex-15.0
sqlserver-se-11.0
sqlserver-se-12.0
sqlserver-se-13.0
sqlserver-se-14.0
sqlserver-se-15.0
sqlserver-web-11.0
sqlserver-web-12.0
sqlserver-web-13.0
sqlserver-web-14.0
sqlserver-web-15.0
An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The name of the RDS event notification subscription you want to describe.
", "DescribeEventSubscriptionsMessage$Marker": "An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
Can't end with a hyphen or contain two consecutive hyphens.
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
", "ExportTask$SourceArn": "The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
", - "ExportTask$S3Bucket": "The Amazon S3 bucket that the snapshot or cluster is exported to.
", + "ExportTask$S3Bucket": "The Amazon S3 bucket where the snapshot or cluster is exported to.
", "ExportTask$S3Prefix": "The Amazon S3 bucket prefix that is the file name and path of the exported data.
", "ExportTask$IamRoleArn": "The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
", "ExportTask$KmsKeyId": "The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
", @@ -4615,7 +4615,7 @@ "ExportTask$FailureCause": "The reason the export failed, if it failed.
", "ExportTask$WarningMessage": "A warning about the snapshot or cluster export task.
", "ExportTasksMessage$Marker": "A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.
A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
", "FailoverState$FromDbClusterArn": "The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
", "FailoverState$ToDbClusterArn": "The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
", @@ -4631,8 +4631,8 @@ "GlobalCluster$DatabaseName": "The default database name within the new global database cluster.
", "GlobalClusterMember$DBClusterArn": "The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
", "GlobalClustersMessage$Marker": "An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", - "IPRange$CIDRIP": "Specifies the IP range.
", + "IPRange$Status": "The status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "IPRange$CIDRIP": "The IP range.
", "KeyList$member": null, "ListTagsForResourceMessage$ResourceName": "The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
", "LogTypeList$member": null, @@ -4711,7 +4711,7 @@ "ModifyDBSubnetGroupMessage$DBSubnetGroupDescription": "The description for the DB subnet group.
", "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription.
", "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", - "ModifyEventSubscriptionMessage$SourceType": "The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster.
The new cluster identifier for the global database cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
The version number of the database engine to which you want to upgrade.
To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
The DB instance class for a DB instance.
", "OrderableDBInstanceOption$LicenseModel": "The license model for a DB instance.
", "OrderableDBInstanceOption$AvailabilityZoneGroup": "The Availability Zone group for a DB instance.
", - "OrderableDBInstanceOption$StorageType": "Indicates the storage type for a DB instance.
", + "OrderableDBInstanceOption$StorageType": "The storage type for a DB instance.
", "OrderableDBInstanceOptionsMessage$Marker": "An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the Outpost.
", - "Parameter$ParameterName": "Specifies the name of the parameter.
", - "Parameter$ParameterValue": "Specifies the value of the parameter.
", + "Parameter$ParameterName": "The name of the parameter.
", + "Parameter$ParameterValue": "The value of the parameter.
", "Parameter$Description": "Provides a description of the parameter.
", - "Parameter$Source": "Indicates the source of the parameter value.
", + "Parameter$Source": "The source of the parameter value.
", "Parameter$ApplyType": "Specifies the engine specific parameters type.
", "Parameter$DataType": "Specifies the valid data type for the parameter.
", "Parameter$AllowedValues": "Specifies the valid range of values for the parameter.
", @@ -4842,16 +4842,16 @@ "RestoreDBClusterFromS3Message$PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
", "RestoreDBClusterFromS3Message$KmsKeyId": "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid Values: mysql
The version of the database that the backup files were created from.
MySQL versions 5.7 and 8.0 are supported.
Example: 5.7.40, 8.0.28
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
", "RestoreDBClusterFromS3Message$S3Prefix": "The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
", "RestoreDBClusterFromS3Message$S3IngestionRoleArn": "The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
", "RestoreDBClusterFromS3Message$Domain": "Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
", "RestoreDBClusterFromS3Message$DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
", - "RestoreDBClusterFromS3Message$NetworkType": "The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
", + "RestoreDBClusterFromS3Message$NetworkType": "The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
", "RestoreDBClusterFromS3Message$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", - "RestoreDBClusterFromS3Message$StorageType": "Specifies the storage type to be associated with the DB cluster.
Valid values: aurora, aurora-iopt1
Default: aurora
Valid for: Aurora DB clusters only
", + "RestoreDBClusterFromS3Message$StorageType": "Specifies the storage type to be associated with the DB cluster.
Valid Values: aurora, aurora-iopt1
Default: aurora
Valid for: Aurora DB clusters only
", "RestoreDBClusterFromSnapshotMessage$DBClusterIdentifier": "The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier": "The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterFromSnapshotMessage$Engine": "The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", @@ -4862,11 +4862,11 @@ "RestoreDBClusterFromSnapshotMessage$KmsKeyId": "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterFromSnapshotMessage$EngineMode": "The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
", "RestoreDBClusterFromSnapshotMessage$DBClusterParameterGroupName": "The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "RestoreDBClusterFromSnapshotMessage$Domain": "Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
", - "RestoreDBClusterFromSnapshotMessage$DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
", + "RestoreDBClusterFromSnapshotMessage$Domain": "The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
", + "RestoreDBClusterFromSnapshotMessage$DomainIAMRoleName": "The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
", "RestoreDBClusterFromSnapshotMessage$DBClusterInstanceClass": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
", - "RestoreDBClusterFromSnapshotMessage$StorageType": "Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "RestoreDBClusterFromSnapshotMessage$NetworkType": "The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", + "RestoreDBClusterFromSnapshotMessage$StorageType": "Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "RestoreDBClusterFromSnapshotMessage$NetworkType": "The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", "RestoreDBClusterToPointInTimeMessage$DBClusterIdentifier": "The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterToPointInTimeMessage$RestoreType": "The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier": "The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", @@ -4874,34 +4874,34 @@ "RestoreDBClusterToPointInTimeMessage$OptionGroupName": "The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can't be modified.
", "RestoreDBClusterToPointInTimeMessage$KmsKeyId": "The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterToPointInTimeMessage$DBClusterParameterGroupName": "The name of the custom DB cluster parameter group to associate with this DB cluster.
If the DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "RestoreDBClusterToPointInTimeMessage$Domain": "Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", - "RestoreDBClusterToPointInTimeMessage$DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
", + "RestoreDBClusterToPointInTimeMessage$Domain": "The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", + "RestoreDBClusterToPointInTimeMessage$DomainIAMRoleName": "The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
", "RestoreDBClusterToPointInTimeMessage$EngineMode": "The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
", "RestoreDBClusterToPointInTimeMessage$DBClusterInstanceClass": "The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
", - "RestoreDBClusterToPointInTimeMessage$StorageType": "Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "RestoreDBClusterToPointInTimeMessage$NetworkType": "The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", + "RestoreDBClusterToPointInTimeMessage$StorageType": "Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "RestoreDBClusterToPointInTimeMessage$NetworkType": "The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", "RestoreDBClusterToPointInTimeMessage$SourceDbClusterResourceId": "The resource ID of the source DB cluster from which to restore.
", "RestoreDBInstanceFromDBSnapshotMessage$DBInstanceIdentifier": "Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
Can't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
", "RestoreDBInstanceFromDBSnapshotMessage$AvailabilityZone": "The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid Values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
", "RestoreDBInstanceFromDBSnapshotMessage$Engine": "The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
", - "RestoreDBInstanceFromDBSnapshotMessage$StorageType": "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
Specifies the storage type to be associated with the DB instance.
Valid Values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
", "RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialPassword": "The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
", "RestoreDBInstanceFromDBSnapshotMessage$Domain": "Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
", "RestoreDBInstanceFromDBSnapshotMessage$DomainFqdn": "The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
Can't be longer than 64 characters.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom DB instances.
", "RestoreDBInstanceFromDBSnapshotMessage$DBParameterGroupName": "The name of the DB parameter group to associate with this DB instance.
If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
", "RestoreDBInstanceFromDBSnapshotMessage$BackupTarget": "Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
", - "RestoreDBInstanceFromDBSnapshotMessage$NetworkType": "The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", + "RestoreDBInstanceFromDBSnapshotMessage$NetworkType": "The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", "RestoreDBInstanceFromDBSnapshotMessage$DBClusterSnapshotIdentifier": "The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
The license model for this DB instance. Use general-public-license.
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
", - "RestoreDBInstanceFromS3Message$StorageType": "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
Specifies the storage type to be associated with the DB instance.
Valid Values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The name of the engine of your source database.
Valid Values: mysql
The prefix of your Amazon S3 bucket.
", "RestoreDBInstanceFromS3Message$S3IngestionRoleArn": "An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
", "RestoreDBInstanceFromS3Message$PerformanceInsightsKMSKeyId": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", + "RestoreDBInstanceFromS3Message$NetworkType": "The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", "RestoreDBInstanceFromS3Message$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", "RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier": "The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
The name of the new DB instance to create.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
One or more DB instance identifiers.
", "DeregisterDBProxyTargetsRequest$DBClusterIdentifiers": "One or more DB cluster identifiers.
", "DomainMembership$DnsIps": "The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
", - "ExportTask$ExportOnly": "The data exported from the snapshot or cluster. Valid values are the following:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The data exported from the snapshot or cluster.
Valid Values:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
List of DB instance identifiers that are part of the custom endpoint group.
", "ModifyDBClusterEndpointMessage$ExcludedMembers": "List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
", "ModifyDBInstanceMessage$DomainDnsIps": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
One or more DB cluster identifiers.
", "RestoreDBInstanceFromDBSnapshotMessage$DomainDnsIps": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
The data to be exported from the snapshot or cluster. If this parameter is not provided, all of the data is exported. Valid values are the following:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.
Valid Values:
database - Export all the data from a specified database.
database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
The timestamp of the time to which the DB cluster was backtracked.
", "DBClusterBacktrack$BacktrackedFrom": "The timestamp of the time from which the DB cluster was backtracked.
", "DBClusterBacktrack$BacktrackRequestCreationTime": "The timestamp of the time at which the backtrack was requested.
", - "DBClusterSnapshot$SnapshotCreateTime": "Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
", - "DBClusterSnapshot$ClusterCreateTime": "Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
", + "DBClusterSnapshot$SnapshotCreateTime": "The time when the snapshot was taken, in Universal Coordinated Time (UTC).
", + "DBClusterSnapshot$ClusterCreateTime": "The time when the DB cluster was created, in Universal Coordinated Time (UTC).
", "DBEngineVersion$CreateTime": "The creation time of the DB engine version.
", "DBInstance$AutomaticRestartTime": "The time when a stopped DB instance is restarted automatically.
", "DBInstance$InstanceCreateTime": "The date and time when the DB instance was created.
", "DBInstance$LatestRestorableTime": "The latest time to which a database in this DB instance can be restored with point-in-time restore.
", "DBInstance$ResumeFullAutomationModeTime": "The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
", - "DBInstanceAutomatedBackup$InstanceCreateTime": "Provides the date and time that the DB instance was created.
", + "DBInstanceAutomatedBackup$InstanceCreateTime": "The date and time when the DB instance was created.
", "DBProxy$CreatedDate": "The date and time when the proxy was first created.
", "DBProxy$UpdatedDate": "The date and time when the proxy was last updated.
", "DBProxyEndpoint$CreatedDate": "The date and time when the DB proxy endpoint was first created.
", @@ -5201,9 +5201,9 @@ "DescribeEventsMessage$StartTime": "The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", "DescribeEventsMessage$EndTime": "The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", "Event$Date": "Specifies the date and time of the event.
", - "ExportTask$SnapshotTime": "The time that the snapshot was created.
", - "ExportTask$TaskStartTime": "The time that the snapshot or cluster export task started.
", - "ExportTask$TaskEndTime": "The time that the snapshot or cluster export task ended.
", + "ExportTask$SnapshotTime": "The time when the snapshot was created.
", + "ExportTask$TaskStartTime": "The time when the snapshot or cluster export task started.
", + "ExportTask$TaskEndTime": "The time when the snapshot or cluster export task ended.
", "OptionGroup$CopyTimestamp": "Indicates when the option group was copied.
", "PendingMaintenanceAction$AutoAppliedAfterDate": "The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.
", "PendingMaintenanceAction$ForcedApplyDate": "The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
", @@ -5395,7 +5395,7 @@ "refs": { "CreateDBClusterMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "CreateDBInstanceMessage$VpcSecurityGroupIds": "A list of Amazon EC2 VPC security groups to associate with this DB instance.
This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
", - "CreateDBInstanceReadReplicaMessage$VpcSecurityGroupIds": "A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn't apply to RDS Custom.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
", + "CreateDBInstanceReadReplicaMessage$VpcSecurityGroupIds": "A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn't apply to RDS Custom DB instances.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
", "ModifyDBClusterMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "ModifyDBInstanceMessage$VpcSecurityGroupIds": "A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
A list of VpcSecurityGroupMembership name strings used for this option.
", @@ -5425,7 +5425,7 @@ "base": null, "refs": { "DBCluster$GlobalWriteForwardingStatus": "The status of write forwarding for a secondary cluster in an Aurora global database.
", - "GlobalClusterMember$GlobalWriteForwardingStatus": "Specifies whether a secondary cluster in the global cluster has write forwarding enabled, not enabled, or is in the process of enabling it.
" + "GlobalClusterMember$GlobalWriteForwardingStatus": "The status of write forwarding for a secondary cluster in the global cluster.
" } } } diff --git a/models/apis/route53/2013-04-01/api-2.json b/models/apis/route53/2013-04-01/api-2.json index 3584c228db8..a12abd61698 100644 --- a/models/apis/route53/2013-04-01/api-2.json +++ b/models/apis/route53/2013-04-01/api-2.json @@ -2935,6 +2935,10 @@ "Owner":{"shape":"HostedZoneOwner"} } }, + "HostedZoneType":{ + "type":"string", + "enum":["PrivateHostedZone"] + }, "HostedZones":{ "type":"list", "member":{ @@ -3390,6 +3394,11 @@ "shape":"ResourceId", "location":"querystring", "locationName":"delegationsetid" + }, + "HostedZoneType":{ + "shape":"HostedZoneType", + "location":"querystring", + "locationName":"hostedzonetype" } } }, diff --git a/models/apis/route53/2013-04-01/docs-2.json b/models/apis/route53/2013-04-01/docs-2.json index 03882669b99..89eefa79536 100644 --- a/models/apis/route53/2013-04-01/docs-2.json +++ b/models/apis/route53/2013-04-01/docs-2.json @@ -5,7 +5,7 @@ "ActivateKeySigningKey": "Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE.
Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.
When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
aws - Amazon Web Services Regions
aws-cn - China Regions
aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations.
A change request can update multiple locations in a collection at a time, which is helpful if you want to move one or more CIDR blocks from one location to another in one transaction, without downtime.
Limits
The max number of CIDR blocks included in the request is 1000. As a result, big updates require multiple API calls.
PUT and DELETE_IF_EXISTS
Use ChangeCidrCollection to perform the following actions:
PUT: Create a CIDR block within the specified collection.
DELETE_IF_EXISTS: Delete an existing CIDR block from the collection.
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
Deleting Resource Record Sets
To delete a resource record set, you must specify all the same values that you specified when you created it.
Change Batches and Transactional Changes
The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone.
For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the DELETE or the CREATE action fails, then the request is canceled, and the original CNAME record continues to exist.
If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch error.
Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest to perform the following actions:
CREATE: Creates a resource record set that has the specified values.
DELETE: Deletes an existing resource record set that has the specified values.
UPSERT: If a resource set exists Route 53 updates it with the values in the request.
Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see \"Examples.\"
Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.
Change Propagation to Route 53 DNS Servers
When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers managing the hosted zone. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers managing the hosted zone within 60 seconds. For more information, see GetChange.
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
Deleting Resource Record Sets
To delete a resource record set, you must specify all the same values that you specified when you created it.
Change Batches and Transactional Changes
The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone.
For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the DELETE or the CREATE action fails, then the request is canceled, and the original CNAME record continues to exist.
If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch error.
Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest to perform the following actions:
CREATE: Creates a resource record set that has the specified values.
DELETE: Deletes an existing resource record set that has the specified values.
UPSERT: If a resource set doesn't exist, Route 53 creates it. If a resource set exists Route 53 updates it with the values in the request.
Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see \"Examples.\"
Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.
Change Propagation to Route 53 DNS Servers
When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers managing the hosted zone. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers managing the hosted zone within 60 seconds. For more information, see GetChange.
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.
Adds, edits, or deletes tags for a health check or a hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
", "CreateCidrCollection": "Creates a CIDR collection in the current Amazon Web Services account.
", "CreateHealthCheck": "Creates a new health check.
For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
ELB Load Balancers
If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.
Private Hosted Zones
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.
Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
Route 53 edge location that responded to the DNS query
Domain or subdomain that was requested
DNS record type, such as A or AAAA
DNS response code, such as NoError or ServFail
Before you create a query logging configuration, perform the following operations.
If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.
Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:
You must create the log group in the us-east-1 region.
You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for.
When you create log groups for query logging, we recommend that you use a consistent prefix, for example:
/aws/route53/hosted zone name
In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.
Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:
arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*
To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:
For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID.
For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111.
For more information, see The confused deputy problem in the Amazon Web Services IAM User Guide.
You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.
When Route 53 finishes creating the configuration for DNS query logging, it does the following:
Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.
Begins to send query logs to the applicable log stream.
The name of each log stream is in the following format:
hosted zone ID/edge location code
The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page.
Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.
For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.
For information about charges for query logs, see Amazon CloudWatch Pricing.
If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account.
You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request.
You can't associate a reusable delegation set with a private hosted zone.
For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.
The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:
Create a reusable delegation set.
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
Recreate resource record sets in the new hosted zones.
Change the registrar's name servers to use the name servers for the new hosted zones.
Monitor traffic for the website or application.
Change TTLs back to their original values.
If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:
For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.
For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.
For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
", - "CreateTrafficPolicyInstance": "Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.
Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.
After you submit an CreateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance request completed successfully. For more information, see the State response element.
Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.
", "CreateVPCAssociationAuthorization": "Authorizes the Amazon Web Services account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.
If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.
Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to INACTIVE.
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
", "GetReusableDelegationSetLimit": "Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
", "GetTrafficPolicy": "Gets information about a specific traffic policy version.
For information about how of deleting a traffic policy affects the response from GetTrafficPolicy, see DeleteTrafficPolicy.
Gets information about a specified traffic policy instance.
After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
In the Route 53 console, traffic policy instances are known as policy records.
Gets information about a specified traffic policy instance.
Use GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.
In the Route 53 console, traffic policy instances are known as policy records.
Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.
", "ListCidrBlocks": "Returns a paginated list of location objects and their CIDR blocks.
", "ListCidrCollections": "Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
", @@ -71,7 +71,7 @@ "UpdateHealthCheck": "Updates an existing health check. Note that some values can't be updated.
For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.
", "UpdateHostedZoneComment": "Updates the comment for a specified hosted zone.
", "UpdateTrafficPolicyComment": "Updates the comment for a specified traffic policy version.
", - "UpdateTrafficPolicyInstance": "Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations:
Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.
When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.
After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm that the UpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.
Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations:
Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.
When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.
For geolocation resource record sets, the two-letter code for a country.
Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
", + "GeoLocation$CountryCode": "For geolocation resource record sets, the two-letter code for a country.
Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
Route 53 also supports the contry code UA forr Ukraine.
", "GeoLocationDetails$CountryCode": "The two-letter code for the country.
", - "GetGeoLocationRequest$CountryCode": "Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
", + "GetGeoLocationRequest$CountryCode": "Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
Route 53 also supports the contry code UA forr Ukraine.
", "ListGeoLocationsRequest$StartCountryCode": "The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in startcountrycode to return the next page of results.
If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextCountryCode in the startcountrycode parameter in another ListGeoLocations request.
A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:
If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check.
If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.
A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:
If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check.
If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.
Route 53 does not store the CallerReference for a deleted health check indefinitely. The CallerReference for a deleted health check will be deleted after a number of days.
A unique string that you specified when you created the health check.
" } }, @@ -1319,6 +1319,12 @@ "HostedZoneSummaries$member": null } }, + "HostedZoneType": { + "base": null, + "refs": { + "ListHostedZonesRequest$HostedZoneType": "(Optional) Specifies if the hosted zone is private.
" + } + }, "HostedZones": { "base": null, "refs": { @@ -1821,7 +1827,7 @@ "refs": { "ListGeoLocationsRequest$MaxItems": "(Optional) The maximum number of geolocations to be included in the response body for this request. If more than maxitems geolocations remain to be listed, then the value of the IsTruncated element in the response is true.
The value that you specified for MaxItems in the request.
The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100 health checks.
The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 1000 items. If you set MaxItems to a value greater than 1000, Route 53 returns only the first 1000 health checks.
The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.
The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.
The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.
A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
" } }, + "AwsDmsEndpointDetails": { + "base": "Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data store type, and location information about your data store.
", + "refs": { + "ResourceDetails$AwsDmsEndpoint": "Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data store type, and location information about your data store.
" + } + }, + "AwsDmsReplicationInstanceDetails": { + "base": "Provides details about an Database Migration Service (DMS) replication instance. DMS uses a replication instance to connect to your source data store, read the source data, and format the data for consumption by the target data store.
", + "refs": { + "ResourceDetails$AwsDmsReplicationInstance": "Provides details about an DMS replication instance. DMS uses a replication instance to connect to your source data store, read the source data, and format the data for consumption by the target data store.
" + } + }, + "AwsDmsReplicationInstanceReplicationSubnetGroupDetails": { + "base": "Provides details about the replication subnet group.
", + "refs": { + "AwsDmsReplicationInstanceDetails$ReplicationSubnetGroup": "The subnet group for the replication instance.
" + } + }, + "AwsDmsReplicationInstanceVpcSecurityGroupsDetails": { + "base": "Provides details about the virtual private cloud (VPC) security group that’s associated with the replication instance.
", + "refs": { + "AwsDmsReplicationInstanceVpcSecurityGroupsList$member": null + } + }, + "AwsDmsReplicationInstanceVpcSecurityGroupsList": { + "base": null, + "refs": { + "AwsDmsReplicationInstanceDetails$VpcSecurityGroups": "The virtual private cloud (VPC) security group for the replication instance.
" + } + }, + "AwsDmsReplicationTaskDetails": { + "base": "Provides details about an Database Migration Service (DMS) replication task. A replication task moves a set of data from the source endpoint to the target endpoint.
", + "refs": { + "ResourceDetails$AwsDmsReplicationTask": "Provides details about an DMS replication task. A replication task moves a set of data from the source endpoint to the target endpoint.
" + } + }, "AwsDynamoDbTableAttributeDefinition": { "base": "Contains a definition of an attribute for the table.
", "refs": { @@ -2530,6 +2566,60 @@ "ResourceDetails$AwsEventSchemasRegistry": "A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for schemas. They collect and organize schemas so that your schemas are in logical groups.
" } }, + "AwsEventsEndpointDetails": { + "base": "Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s availability by making it Regional-fault tolerant.
", + "refs": { + "ResourceDetails$AwsEventsEndpoint": "Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s availability by making it Regional-fault tolerant.
" + } + }, + "AwsEventsEndpointEventBusesDetails": { + "base": "Provides details about the Amazon EventBridge event buses that the endpoint is associated with.
", + "refs": { + "AwsEventsEndpointEventBusesList$member": null + } + }, + "AwsEventsEndpointEventBusesList": { + "base": null, + "refs": { + "AwsEventsEndpointDetails$EventBuses": "The event buses being used by the endpoint.
" + } + }, + "AwsEventsEndpointReplicationConfigDetails": { + "base": "Indicates whether replication is enabled or disabled for the endpoint. If enabled, the endpoint can replicate all events to a secondary Amazon Web Services Region.
", + "refs": { + "AwsEventsEndpointDetails$ReplicationConfig": " Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED, which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.
Provides details about the routing configuration of the endpoint.
", + "refs": { + "AwsEventsEndpointDetails$RoutingConfig": "The routing configuration of the endpoint.
" + } + }, + "AwsEventsEndpointRoutingConfigFailoverConfigDetails": { + "base": "The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
", + "refs": { + "AwsEventsEndpointRoutingConfigDetails$FailoverConfig": "The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
" + } + }, + "AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails": { + "base": "Provides details about the primary Amazon Web Services Region of the endpoint.
", + "refs": { + "AwsEventsEndpointRoutingConfigFailoverConfigDetails$Primary": "The main Region of the endpoint.
" + } + }, + "AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails": { + "base": "The Amazon Web Services Region that events are routed to when failover is triggered or event replication is enabled.
", + "refs": { + "AwsEventsEndpointRoutingConfigFailoverConfigDetails$Secondary": "The Region that events are routed to when failover is triggered or event replication is enabled.
" + } + }, + "AwsEventsEventbusDetails": { + "base": "Provides details about Amazon EventBridge event bus. An event bus is a router that receives events and delivers them to zero or more destinations, or targets. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.
", + "refs": { + "ResourceDetails$AwsEventsEventbus": "Provides details about Amazon EventBridge event bus for an endpoint. An event bus is a router that receives events and delivers them to zero or more destinations, or targets.
" + } + }, "AwsGuardDutyDetectorDataSourcesCloudTrailDetails": { "base": "An object that contains information on the status of CloudTrail as a data source for the detector.
", "refs": { @@ -2858,6 +2948,72 @@ "AwsEcsContainerDetails$MountPoints": "The mount points for data volumes in your container.
" } }, + "AwsMskClusterClusterInfoClientAuthenticationDetails": { + "base": "Provides details about different modes of client authentication.
", + "refs": { + "AwsMskClusterClusterInfoDetails$ClientAuthentication": "Provides information for different modes of client authentication.
" + } + }, + "AwsMskClusterClusterInfoClientAuthenticationSaslDetails": { + "base": "Provides details for client authentication using SASL.
", + "refs": { + "AwsMskClusterClusterInfoClientAuthenticationDetails$Sasl": "Provides details for client authentication using SASL.
" + } + }, + "AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails": { + "base": "Details for SASL/IAM client authentication.
", + "refs": { + "AwsMskClusterClusterInfoClientAuthenticationSaslDetails$Iam": "Provides details for SASL client authentication using IAM.
" + } + }, + "AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails": { + "base": "Details for SASL/SCRAM client authentication.
", + "refs": { + "AwsMskClusterClusterInfoClientAuthenticationSaslDetails$Scram": "Details for SASL client authentication using SCRAM.
" + } + }, + "AwsMskClusterClusterInfoClientAuthenticationTlsDetails": { + "base": "Provides details for client authentication using TLS.
", + "refs": { + "AwsMskClusterClusterInfoClientAuthenticationDetails$Tls": "Provides details for client authentication using TLS.
" + } + }, + "AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails": { + "base": "Provides details for allowing no client authentication.
", + "refs": { + "AwsMskClusterClusterInfoClientAuthenticationDetails$Unauthenticated": "Provides details for allowing no client authentication.
" + } + }, + "AwsMskClusterClusterInfoDetails": { + "base": "Provide details about an Amazon MSK cluster.
", + "refs": { + "AwsMskClusterDetails$ClusterInfo": "Provides information about a cluster.
" + } + }, + "AwsMskClusterClusterInfoEncryptionInfoDetails": { + "base": "Includes encryption-related information, such as the KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.
", + "refs": { + "AwsMskClusterClusterInfoDetails$EncryptionInfo": "Includes encryption-related information, such as the KMS key used for encrypting data at rest and whether you want Amazon MSK to encrypt your data in transit.
" + } + }, + "AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails": { + "base": "The data-volume encryption details. You can't update encryption at rest settings for existing clusters.
", + "refs": { + "AwsMskClusterClusterInfoEncryptionInfoDetails$EncryptionAtRest": "The data-volume encryption details. You can't update encryption at rest settings for existing clusters.
" + } + }, + "AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails": { + "base": "The settings for encrypting data in transit.
", + "refs": { + "AwsMskClusterClusterInfoEncryptionInfoDetails$EncryptionInTransit": "The settings for encrypting data in transit.
" + } + }, + "AwsMskClusterDetails": { + "base": "Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.
", + "refs": { + "ResourceDetails$AwsMskCluster": "Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.
" + } + }, "AwsNetworkFirewallFirewallDetails": { "base": "Details about an Network Firewall firewall.
", "refs": { @@ -3339,6 +3495,48 @@ "AwsRedshiftClusterDetails$VpcSecurityGroups": "The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
" } }, + "AwsRoute53HostedZoneConfigDetails": { + "base": "An object that contains an optional comment about your Amazon Route 53 hosted zone.
", + "refs": { + "AwsRoute53HostedZoneObjectDetails$Config": " An object that includes the Comment element.
Provides details about a specified Amazon Route 53 hosted zone, including the four name servers assigned to the hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.
", + "refs": { + "ResourceDetails$AwsRoute53HostedZone": "Provides details about an Amazon Route 53 hosted zone, including the four name servers assigned to the hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.
" + } + }, + "AwsRoute53HostedZoneNameServersList": { + "base": null, + "refs": { + "AwsRoute53HostedZoneDetails$NameServers": "An object that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.
" + } + }, + "AwsRoute53HostedZoneObjectDetails": { + "base": "An object that contains information about an Amazon Route 53 hosted zone.
", + "refs": { + "AwsRoute53HostedZoneDetails$HostedZone": "An object that contains information about the specified hosted zone.
" + } + }, + "AwsRoute53HostedZoneVpcDetails": { + "base": "For private hosted zones, this is a complex type that contains information about an Amazon VPC.
", + "refs": { + "AwsRoute53HostedZoneVpcsList$member": null + } + }, + "AwsRoute53HostedZoneVpcsList": { + "base": null, + "refs": { + "AwsRoute53HostedZoneDetails$Vpcs": "An object that contains information about the Amazon Virtual Private Clouds (Amazon VPCs) that are associated with the specified hosted zone.
" + } + }, + "AwsRoute53QueryLoggingConfigDetails": { + "base": "Provides details about a specified Amazon Route 53 configuration for DNS query logging.
", + "refs": { + "AwsRoute53HostedZoneDetails$QueryLoggingConfig": " An array that contains one QueryLoggingConfig element for each DNS query logging configuration that is associated with the current Amazon Web Services account.
provides information about the Amazon S3 Public Access Block configuration for accounts.
", "refs": { @@ -4184,6 +4382,9 @@ "AwsCodeBuildProjectLogsConfigS3LogsDetails$EncryptionDisabled": "Whether to disable encryption of the S3 build log output.
", "AwsCodeBuildProjectSource$InsecureSsl": "Whether to ignore SSL warnings while connecting to the project source code.
", "AwsCorsConfiguration$AllowCredentials": "Indicates whether the CORS request includes credentials.
", + "AwsDmsReplicationInstanceDetails$AutoMinorVersionUpgrade": "Indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
", + "AwsDmsReplicationInstanceDetails$MultiAZ": " Specifies whether the replication instance is deployed across multiple Availability Zones (AZs). You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
Whether the index is currently backfilling.
", "AwsDynamoDbTableRestoreSummary$RestoreInProgress": "Whether a restore is currently in progress.
", "AwsDynamoDbTableStreamSpecification$StreamEnabled": "Indicates whether DynamoDB Streams is enabled on the table.
", @@ -4249,6 +4450,11 @@ "AwsIamPolicyDetails$IsAttachable": "Whether the policy can be attached to a user, group, or role.
", "AwsIamPolicyVersion$IsDefaultVersion": "Whether the version is the default version.
", "AwsKmsKeyDetails$KeyRotationStatus": "Whether the key has key rotation enabled.
", + "AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails$Enabled": "Indicates whether SASL/IAM authentication is enabled or not.
", + "AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails$Enabled": "Indicates whether SASL/SCRAM authentication is enabled or not.
", + "AwsMskClusterClusterInfoClientAuthenticationTlsDetails$Enabled": "Indicates whether TLS authentication is enabled or not.
", + "AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails$Enabled": "Indicates whether unauthenticated is allowed or not.
", + "AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails$InCluster": " When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plain text. The default value is true.
Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.
Whether the firewall is protected from a change to the firewall policy. If set to true, you cannot associate a different policy with the firewall.
Whether the firewall is protected from a change to the subnet associations. If set to true, you cannot map different subnets to the firewall.
Whether tags are copied from the DB cluster to snapshots of the DB cluster.
", "AwsRdsDbClusterDetails$CrossAccountClone": "Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
", "AwsRdsDbClusterDetails$IamDatabaseAuthenticationEnabled": "Whether the mapping of IAM accounts to database accounts is enabled.
", + "AwsRdsDbClusterDetails$AutoMinorVersionUpgrade": "Indicates if minor version upgrades are automatically applied to the cluster.
", "AwsRdsDbClusterMember$IsClusterWriter": "Whether the cluster member is the primary instance for the DB cluster.
", "AwsRdsDbClusterSnapshotDetails$StorageEncrypted": "Whether the DB cluster is encrypted.
", "AwsRdsDbClusterSnapshotDetails$IamDatabaseAuthenticationEnabled": "Whether mapping of IAM accounts to database accounts is enabled.
", @@ -4397,6 +4604,12 @@ "ClassificationResult$Status": "The current status of the sensitive data detection.
" } }, + "CloudWatchLogsLogGroupArnConfigDetails": { + "base": "The Amazon Resource Name (ARN) and other details of the Amazon CloudWatch Logs log group that Amazon Route 53 is publishing logs to.
", + "refs": { + "AwsRoute53QueryLoggingConfigDetails$CloudWatchLogsLogGroupArn": "The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that Route 53 is publishing logs to.
" + } + }, "CodeVulnerabilitiesFilePath": { "base": "Provides details about where a code vulnerability is located in your Lambda function.
", "refs": { @@ -5143,6 +5356,8 @@ "AwsCloudWatchAlarmDetails$Period": "The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.
", "AwsCodeBuildProjectSource$GitCloneDepth": "Information about the Git clone depth for the build project.
", "AwsCorsConfiguration$MaxAge": "The number of seconds for which the browser caches preflight request results.
", + "AwsDmsEndpointDetails$Port": "The port used to access the endpoint.
", + "AwsDmsReplicationInstanceDetails$AllocatedStorage": "The amount of storage (in gigabytes) that is allocated for the replication instance.
", "AwsDynamoDbTableDetails$ItemCount": "The number of items in the table.
", "AwsDynamoDbTableGlobalSecondaryIndex$ItemCount": "The number of items in the index.
", "AwsDynamoDbTableProvisionedThroughput$NumberOfDecreasesToday": "The number of times during the current UTC calendar day that the provisioned throughput was decreased.
", @@ -5246,6 +5461,7 @@ "AwsLambdaFunctionDetails$MemorySize": "The memory that is allocated to the function.
", "AwsLambdaFunctionDetails$Timeout": "The amount of time that Lambda allows a function to run before stopping it.
", "AwsLambdaFunctionLayer$CodeSize": "The size of the layer archive in bytes.
", + "AwsMskClusterClusterInfoDetails$NumberOfBrokerNodes": "The number of broker nodes in the cluster.
", "AwsNetworkFirewallRuleGroupDetails$Capacity": "The maximum number of operating resources that this rule group can use.
", "AwsOpenSearchServiceDomainClusterConfigDetails$InstanceCount": "The number of data nodes to use in the OpenSearch domain.
", "AwsOpenSearchServiceDomainClusterConfigDetails$WarmCount": "The number of UltraWarm instances.
", @@ -6069,6 +6285,39 @@ "AwsCodeBuildProjectSource$Type": "The type of repository that contains the source code to be built. Valid values are:
BITBUCKET - The source code is in a Bitbucket repository.
CODECOMMIT - The source code is in an CodeCommit repository.
CODEPIPELINE - The source code settings are specified in the source action of a pipeline in CodePipeline.
GITHUB - The source code is in a GitHub repository.
GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise repository.
NO_SOURCE - The project does not have input source code.
S3 - The source code is in an S3 input bucket.
Information about the location of the source code to be built.
Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec file (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
For source code in an S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip).
The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec file.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec file.
The ID of the VPC.
", + "AwsDmsEndpointDetails$CertificateArn": "The Amazon Resource Name (ARN) for the SSL certificate that encrypts connections between the DMS endpoint and the replication instance.
", + "AwsDmsEndpointDetails$DatabaseName": "The name of the endpoint database.
", + "AwsDmsEndpointDetails$EndpointArn": "The Amazon Resource Name (ARN) of the endpoint.
", + "AwsDmsEndpointDetails$EndpointIdentifier": "The database endpoint identifier.
", + "AwsDmsEndpointDetails$EndpointType": "The type of endpoint. Valid values are source and target.
", + "AwsDmsEndpointDetails$EngineName": " The type of engine for the endpoint, depending on the EndpointType value.
A value that can be used for cross-account validation.
", + "AwsDmsEndpointDetails$ExtraConnectionAttributes": "Additional attributes associated with the connection.
", + "AwsDmsEndpointDetails$KmsKeyId": " An DMS key identifier that is used to encrypt the connection parameters for the endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
The name of the server where the endpoint database resides.
", + "AwsDmsEndpointDetails$SslMode": "The SSL mode used to connect to the endpoint. The default is none.
", + "AwsDmsEndpointDetails$Username": "The user name to be used to log in to the endpoint database.
", + "AwsDmsReplicationInstanceDetails$AvailabilityZone": " The Availability Zone that the replication instance is created in. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, such as us-east-1d.
The engine version number of the replication instance. If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
", + "AwsDmsReplicationInstanceDetails$KmsKeyId": " An KMS key identifier that is used to encrypt the data on the replication instance. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
The maintenance window times for the replication instance. Upgrades to the replication instance are performed during this time.
", + "AwsDmsReplicationInstanceDetails$ReplicationInstanceClass": "The compute and memory capacity of the replication instance as defined for the specified replication instance class.
", + "AwsDmsReplicationInstanceDetails$ReplicationInstanceIdentifier": "The replication instance identifier.
", + "AwsDmsReplicationInstanceReplicationSubnetGroupDetails$ReplicationSubnetGroupIdentifier": "The identifier of the replication subnet group.
", + "AwsDmsReplicationInstanceVpcSecurityGroupsDetails$VpcSecurityGroupId": "The identifier of the VPC security group that’s associated with the replication instance.
", + "AwsDmsReplicationTaskDetails$CdcStartPosition": " Indicates when you want a change data capture (CDC) operation to start. CCdcStartPosition or CCdcStartTime specifies when you want a CDC operation to start. Only a value for one of these fields is included.
Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime specifies when you want a CDC operation to start. Only a value for one of these fields is included.
Indicates when you want a CDC operation to stop. The value can be either server time or commit time.
", + "AwsDmsReplicationTaskDetails$MigrationType": "The migration type.
", + "AwsDmsReplicationTaskDetails$Id": "The identifier of the replication task.
", + "AwsDmsReplicationTaskDetails$ResourceIdentifier": " A display name for the resource identifier at the end of the EndpointArn response parameter. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
The Amazon Resource Name (ARN) of a replication instance.
", + "AwsDmsReplicationTaskDetails$ReplicationTaskIdentifier": "The user-defined replication task identifier or name.
", + "AwsDmsReplicationTaskDetails$ReplicationTaskSettings": "The settings for the replication task.
", + "AwsDmsReplicationTaskDetails$SourceEndpointArn": "The ARN of the source endpoint.
", + "AwsDmsReplicationTaskDetails$TableMappings": "The table mappings for the replication task, in JSON format.
", + "AwsDmsReplicationTaskDetails$TargetEndpointArn": "The ARN of the target endpoint.
", + "AwsDmsReplicationTaskDetails$TaskData": "Supplemental information that the task requires to migrate the data for certain source and target endpoints.
", "AwsDynamoDbTableAttributeDefinition$AttributeName": "The name of the attribute.
", "AwsDynamoDbTableAttributeDefinition$AttributeType": "The type of the attribute.
", "AwsDynamoDbTableBillingModeSummary$BillingMode": "The method used to charge for read and write throughput and to manage capacity.
", @@ -6369,6 +6618,7 @@ "AwsEcsTaskDefinitionDetails$NetworkMode": "The Docker networking mode to use for the containers in the task. Valid values are as follows:
awsvpc
bridge
host
none
The process namespace to use for the containers in the task. Valid values are host or task.
The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.
", + "AwsEcsTaskDefinitionDetails$Status": "The status of the task definition.
", "AwsEcsTaskDefinitionInferenceAcceleratorsDetails$DeviceName": "The Elastic Inference accelerator device name.
", "AwsEcsTaskDefinitionInferenceAcceleratorsDetails$DeviceType": "The Elastic Inference accelerator type to use.
", "AwsEcsTaskDefinitionPlacementConstraintsDetails$Expression": "A cluster query language expression to apply to the constraint.
", @@ -6483,6 +6733,21 @@ "AwsEventSchemasRegistryDetails$Description": "A description of the registry to be created.
", "AwsEventSchemasRegistryDetails$RegistryArn": "The Amazon Resource Name (ARN) of the registry.
", "AwsEventSchemasRegistryDetails$RegistryName": "The name of the schema registry.
", + "AwsEventsEndpointDetails$Arn": "The Amazon Resource Name (ARN) of the endpoint.
", + "AwsEventsEndpointDetails$Description": "A description of the endpoint.
", + "AwsEventsEndpointDetails$EndpointId": " The URL subdomain of the endpoint. For example, if EndpointUrl is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
The URL of the endpoint.
", + "AwsEventsEndpointDetails$Name": "The name of the endpoint.
", + "AwsEventsEndpointDetails$RoleArn": "The ARN of the role used by event replication for the endpoint.
", + "AwsEventsEndpointDetails$State": "The current state of the endpoint.
", + "AwsEventsEndpointDetails$StateReason": "The reason the endpoint is in its current state.
", + "AwsEventsEndpointEventBusesDetails$EventBusArn": "The Amazon Resource Name (ARN) of the event bus that the endpoint is associated with.
", + "AwsEventsEndpointReplicationConfigDetails$State": "The state of event replication.
", + "AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails$HealthCheck": "The Amazon Resource Name (ARN) of the health check used by the endpoint to determine whether failover is triggered.
", + "AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails$Route": "Defines the secondary Region.
", + "AwsEventsEventbusDetails$Arn": "The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
", + "AwsEventsEventbusDetails$Name": "The name of the event bus.
", + "AwsEventsEventbusDetails$Policy": "The policy that enables the external account to send events to your account.
", "AwsGuardDutyDetectorDataSourcesCloudTrailDetails$Status": "Specifies whether CloudTrail is activated as a data source for the detector.
", "AwsGuardDutyDetectorDataSourcesDnsLogsDetails$Status": "Describes whether DNS logs is enabled as a data source for the detector.
", "AwsGuardDutyDetectorDataSourcesFlowLogsDetails$Status": "Describes whether VPC Flow Logs are activated as a data source for the detector.
", @@ -6581,6 +6846,10 @@ "AwsLambdaLayerVersionDetails$CreatedDate": "Indicates when the version was created.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.
The path on the container to mount the host volume at.
", + "AwsMskClusterClusterInfoDetails$CurrentVersion": "The current version of the MSK cluster.
", + "AwsMskClusterClusterInfoDetails$ClusterName": "The name of the cluster.
", + "AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails$DataVolumeKMSKeyId": "The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
", + "AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails$ClientBroker": "Indicates the encryption setting for data in transit between clients and brokers.
", "AwsNetworkFirewallFirewallDetails$Description": "A description of the firewall.
", "AwsNetworkFirewallFirewallDetails$FirewallArn": "The ARN of the firewall.
", "AwsNetworkFirewallFirewallDetails$FirewallId": "The identifier of the firewall.
", @@ -6817,6 +7086,12 @@ "AwsRedshiftClusterRestoreStatus$Status": "The status of the restore action.
Valid values: starting | restoring | completed | failed
The status of the VPC security group.
", "AwsRedshiftClusterVpcSecurityGroup$VpcSecurityGroupId": "The identifier of the VPC security group.
", + "AwsRoute53HostedZoneConfigDetails$Comment": "Any comments that you include about the hosted zone.
", + "AwsRoute53HostedZoneNameServersList$member": null, + "AwsRoute53HostedZoneObjectDetails$Id": "The ID that Route 53 assigns to the hosted zone when you create it.
", + "AwsRoute53HostedZoneObjectDetails$Name": "The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
", + "AwsRoute53HostedZoneVpcDetails$Id": "The identifier of an Amazon VPC.
", + "AwsRoute53HostedZoneVpcDetails$Region": "The Amazon Web Services Region that an Amazon VPC was created in.
", "AwsS3BucketBucketLifecycleConfigurationRulesDetails$ExpirationDate": "The date when objects are moved or deleted.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
The unique identifier of the rule.
", "AwsS3BucketBucketLifecycleConfigurationRulesDetails$Prefix": "A prefix that identifies one or more objects that the rule applies to.
", @@ -7008,6 +7283,9 @@ "ClassificationResult$MimeType": "The type of content that the finding applies to.
", "ClassificationStatus$Code": "The code that represents the status of the sensitive data detection.
", "ClassificationStatus$Reason": "A longer description of the current status of the sensitive data detection.
", + "CloudWatchLogsLogGroupArnConfigDetails$CloudWatchLogsLogGroupArn": "The ARN of the CloudWatch Logs log group that Route 53 is publishing logs to.
", + "CloudWatchLogsLogGroupArnConfigDetails$HostedZoneId": "The ID of the hosted zone that CloudWatch Logs is logging queries for.
", + "CloudWatchLogsLogGroupArnConfigDetails$Id": "The ID for a DNS query logging configuration.
", "CodeVulnerabilitiesFilePath$FileName": "The name of the file in which the code vulnerability is located.
", "CodeVulnerabilitiesFilePath$FilePath": "The file path to the code in which the vulnerability is located.
", "Compliance$SecurityControlId": "The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Service and a number, such as APIGateway.5.
", @@ -8317,6 +8595,7 @@ "AwsElbLoadBalancerListenerDescription$PolicyNames": "The policies enabled for the listener.
", "AwsElbLoadBalancerPolicies$OtherPolicies": "The policies other than the stickiness policies.
", "AwsIamUserDetails$GroupList": "A list of IAM groups that the user belongs to.
", + "AwsMskClusterClusterInfoClientAuthenticationTlsDetails$CertificateAuthorityArnList": "List of Amazon Web Services Private CA Amazon Resource Names (ARNs). Amazon Web Services Private CA enables creation of private certificate authority (CA) hierarchies, including root and subordinate CAs, without the investment and maintenance costs of operating an on-premises CA.
", "AwsRdsDbClusterDetails$AvailabilityZones": "A list of Availability Zones (AZs) where instances in the DB cluster can be created.
", "AwsRdsDbClusterDetails$CustomEndpoints": "A list of custom endpoints for the DB cluster.
", "AwsRdsDbClusterDetails$ReadReplicaIdentifiers": "The identifiers of the read replicas that are associated with this DB cluster.
", diff --git a/models/apis/storagegateway/2013-06-30/api-2.json b/models/apis/storagegateway/2013-06-30/api-2.json index 059647b033c..3d276e296aa 100644 --- a/models/apis/storagegateway/2013-06-30/api-2.json +++ b/models/apis/storagegateway/2013-06-30/api-2.json @@ -2106,7 +2106,8 @@ "DeprecationDate":{"shape":"DeprecationDate"}, "GatewayCapacity":{"shape":"GatewayCapacity"}, "SupportedGatewayCapacities":{"shape":"SupportedGatewayCapacities"}, - "HostEnvironmentId":{"shape":"HostEnvironmentId"} + "HostEnvironmentId":{"shape":"HostEnvironmentId"}, + "SoftwareVersion":{"shape":"SoftwareVersion"} } }, "DescribeMaintenanceStartTimeInput":{ @@ -2809,7 +2810,7 @@ "type":"string", "max":2048, "min":7, - "pattern":"(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)" + "pattern":"(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)" }, "LastSoftwareUpdate":{ "type":"string", @@ -3058,7 +3059,8 @@ "Ipv4Address":{"shape":"string"}, "MacAddress":{"shape":"string"}, "Ipv6Address":{"shape":"string"} - } + }, + "sensitive":true }, "NetworkInterfaceId":{ "type":"string", @@ -3286,7 +3288,7 @@ "type":"string", "max":2048, "min":20, - "pattern":"^arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\\S+)$" + "pattern":"^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\\S+)$" }, "SMBFileShareInfo":{ "type":"structure", @@ -3416,6 +3418,7 @@ "max":25, "min":1 }, + "SoftwareVersion":{"type":"string"}, "Squash":{ "type":"string", "max":15, @@ -3538,7 +3541,7 @@ "type":"string", "max":500, "min":50, - "pattern":"^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{5,16}$" + "pattern":"arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{5,16}$" }, "TapeARNs":{ "type":"list", diff --git a/models/apis/storagegateway/2013-06-30/docs-2.json b/models/apis/storagegateway/2013-06-30/docs-2.json index 023bea967c6..2ef87db329c 100644 --- a/models/apis/storagegateway/2013-06-30/docs-2.json +++ b/models/apis/storagegateway/2013-06-30/docs-2.json @@ -38,7 +38,7 @@ "DescribeCachediSCSIVolumes": "Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.
The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
", "DescribeChapCredentials": "Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.
", "DescribeFileSystemAssociations": "Gets the file system association information. This operation is only supported for FSx File Gateways.
", - "DescribeGatewayInformation": "Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "DescribeGatewayInformation": "Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", "DescribeMaintenanceStartTime": "Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
", "DescribeNFSFileShares": "Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.
", "DescribeSMBFileShares": "Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.
", @@ -54,9 +54,9 @@ "DetachVolume": "Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.
", "DisableGateway": "Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.
After a gateway is disabled, it cannot be enabled.
Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.
", - "JoinDomain": "Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
", + "JoinDomain": "Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.
To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.
Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.
This operation is only supported for tape gateways.
", - "ListFileShares": "Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling user account. This operation is only supported for S3 File Gateways.
", + "ListFileShares": "Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.
", "ListFileSystemAssociations": "Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.
Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
", "ListLocalDisks": "Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.
The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
", "ListVolumeRecoveryPoints": "Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.
Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
", "ListVolumes": "Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.
Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to S3. Amazon S3.
Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
For more information, see Getting file upload notification in the Storage Gateway User Guide.
", - "RefreshCache": "Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway User Guide.
Wait at least 60 seconds between consecutive RefreshCache API requests.
RefreshCache does not evict cache entries if invoked consecutively within 60 seconds of a previous RefreshCache request.
If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.
For more information, see Getting notified about file operations in the Storage Gateway User Guide.
", + "NotifyWhenUploaded": "Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to S3. Amazon S3.
Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.
", + "RefreshCache": "Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway User Guide.
Wait at least 60 seconds between consecutive RefreshCache API requests.
If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.
For more information, see Getting notified about file operations in the Storage Gateway User Guide.
", "RemoveTagsFromResource": "Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.
", "ResetCache": "Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.
Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.
", @@ -79,7 +79,7 @@ "StartGateway": "Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.
When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
", "UpdateAutomaticTapeCreationPolicy": "Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.
By default, there is no automatic tape creation policy.
A gateway can have only one automatic tape creation policy.
Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
", - "UpdateBandwidthRateLimitSchedule": "Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.
", + "UpdateBandwidthRateLimitSchedule": "Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.
", "UpdateChapCredentials": "Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
Updates a file system association. This operation is only supported in the FSx File Gateways.
", "UpdateGatewayInformation": "Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.
", + "BandwidthRateLimitInterval$AverageUploadRateLimitInBitsPerSec": "The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.
For Tape Gateway and Volume Gateway, the minimum value is 51200.
For S3 File Gateway and FSx File Gateway, the minimum value is 104857600.
The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
", "UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec": "The average upload bandwidth rate limit in bits per second.
" } @@ -2039,6 +2039,12 @@ "DescribeGatewayInformationOutput$SoftwareUpdatesEndDate": "Date after which this gateway will not receive software updates for new features.
" } }, + "SoftwareVersion": { + "base": null, + "refs": { + "DescribeGatewayInformationOutput$SoftwareVersion": "The version number of the software running on the gateway appliance.
" + } + }, "Squash": { "base": "The user mapped to anonymous user. Valid options are the following:
RootSquash: Only root is mapped to anonymous user.
NoSquash: No one is mapped to anonymous user.
AllSquash: Everyone is mapped to anonymous user.
Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
Associates the specified IP access control group with the specified directory.
", + "AssociateWorkspaceApplication": "Associates the specified application to the specified WorkSpace.
", "AuthorizeIpRules": "Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
", "CopyWorkspaceImage": "Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.
This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
", @@ -22,16 +23,22 @@ "DeleteTags": "Deletes the specified tags from the specified WorkSpaces resource.
", "DeleteWorkspaceBundle": "Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
", "DeleteWorkspaceImage": "Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
", + "DeployWorkspaceApplications": "Deploys associated applications to the specified WorkSpace
", "DeregisterWorkspaceDirectory": "Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
", "DescribeAccountModifications": "Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
", + "DescribeApplicationAssociations": "Describes the associations between the application and the specified associated resources.
", + "DescribeApplications": "Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
", + "DescribeBundleAssociations": "Describes the associations between the applications and the specified bundle.
", "DescribeClientBranding": "Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
Only device types that have branding information configured will be shown in the response.
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
", "DescribeConnectClientAddIns": "Retrieves a list of Amazon Connect client add-ins that have been created.
", "DescribeConnectionAliasPermissions": "Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
", "DescribeConnectionAliases": "Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
", + "DescribeImageAssociations": "Describes the associations between the applications and the specified image.
", "DescribeIpGroups": "Describes one or more of your IP access control groups.
", "DescribeTags": "Describes the specified tags for the specified WorkSpaces resource.
", + "DescribeWorkspaceAssociations": "Describes the associations betweens applications and the specified WorkSpace.
", "DescribeWorkspaceBundles": "Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
", "DescribeWorkspaceDirectories": "Describes the available directories that are registered with Amazon WorkSpaces.
", "DescribeWorkspaceImagePermissions": "Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
", @@ -41,6 +48,7 @@ "DescribeWorkspacesConnectionStatus": "Describes the connection status of the specified WorkSpaces.
", "DisassociateConnectionAlias": "Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
Disassociates the specified IP access control group from the specified directory.
", + "DisassociateWorkspaceApplication": "Disassociates the specified application from a WorkSpace.
", "ImportClientBranding": "Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience
You must specify at least one platform type when importing client branding.
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.
Imported data can take up to a minute to appear in the WorkSpaces client.
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
", "ListAvailableManagementCidrRanges": "Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
", @@ -142,12 +150,42 @@ "ApplicationList$member": null } }, + "ApplicationAssociatedResourceType": { + "base": null, + "refs": { + "ApplicationAssociatedResourceTypeList$member": null, + "ApplicationResourceAssociation$AssociatedResourceType": "The resource type of the associated resource.
" + } + }, + "ApplicationAssociatedResourceTypeList": { + "base": null, + "refs": { + "DescribeApplicationAssociationsRequest$AssociatedResourceTypes": "The resource type of the associated resources.
" + } + }, "ApplicationList": { "base": null, "refs": { "ImportWorkspaceImageRequest$Applications": "If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
Windows 11 only supports Microsoft_Office_2019.
The specified application is not supported.
", + "refs": { + } + }, + "ApplicationResourceAssociation": { + "base": "Describes the association between an application and an application resource.
", + "refs": { + "ApplicationResourceAssociationList$member": null + } + }, + "ApplicationResourceAssociationList": { + "base": null, + "refs": { + "DescribeApplicationAssociationsResult$Associations": "List of associations and information about them.
" + } + }, "AssociateConnectionAliasRequest": { "base": null, "refs": { @@ -168,6 +206,40 @@ "refs": { } }, + "AssociateWorkspaceApplicationRequest": { + "base": null, + "refs": { + } + }, + "AssociateWorkspaceApplicationResult": { + "base": null, + "refs": { + } + }, + "AssociationErrorCode": { + "base": null, + "refs": { + "AssociationStateReason$ErrorCode": "The error code of the association deployment failure.
" + } + }, + "AssociationState": { + "base": null, + "refs": { + "ApplicationResourceAssociation$State": "The status of the application resource association.
", + "BundleResourceAssociation$State": "The status of the bundle resource association.
", + "ImageResourceAssociation$State": "The status of the image resource association.
", + "WorkspaceResourceAssociation$State": "The status of the WorkSpace resource association.
" + } + }, + "AssociationStateReason": { + "base": "Indicates the reason that the association deployment failed, including the error code and error message.
", + "refs": { + "ApplicationResourceAssociation$StateReason": "The reason the association deployment failed.
", + "BundleResourceAssociation$StateReason": "The reason the association deployment failed.
", + "ImageResourceAssociation$StateReason": "The reason the association deployment failed.
", + "WorkspaceResourceAssociation$StateReason": "The reason the association deployment failed.
" + } + }, "AssociationStatus": { "base": null, "refs": { @@ -204,6 +276,7 @@ "DefaultWorkspaceCreationProperties$EnableInternetAccess": "Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
", "DefaultWorkspaceCreationProperties$UserEnabledAsLocalAdministrator": "Specifies whether WorkSpace users are local administrators on their WorkSpaces.
", "DefaultWorkspaceCreationProperties$EnableMaintenanceMode": "Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
", + "DeployWorkspaceApplicationsRequest$Force": "Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.
", "RegisterWorkspaceDirectoryRequest$EnableWorkDocs": "Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
Indicates whether self-service capabilities are enabled or disabled.
", "UpdateResult$UpdateAvailable": "Indicates whether updated drivers or other components are available for the specified WorkSpace image.
", @@ -218,11 +291,26 @@ "WorkspaceRequest$RootVolumeEncryptionEnabled": "Indicates whether the data stored on the root volume is encrypted.
" } }, + "BundleAssociatedResourceType": { + "base": null, + "refs": { + "BundleAssociatedResourceTypeList$member": null, + "BundleResourceAssociation$AssociatedResourceType": "The resource type of the associated resources.
" + } + }, + "BundleAssociatedResourceTypeList": { + "base": null, + "refs": { + "DescribeBundleAssociationsRequest$AssociatedResourceTypes": "The resource types of the associated resource.
" + } + }, "BundleId": { "base": null, "refs": { "BundleIdList$member": null, + "BundleResourceAssociation$BundleId": "The identifier of the bundle.
", "DeleteWorkspaceBundleRequest$BundleId": "The identifier of the bundle.
", + "DescribeBundleAssociationsRequest$BundleId": "The identifier of the bundle.
", "DescribeWorkspacesRequest$BundleId": "The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
", "MigrateWorkspaceRequest$BundleId": "The identifier of the target bundle type to migrate the WorkSpace to.
", "UpdateWorkspaceBundleRequest$BundleId": "The identifier of the bundle.
", @@ -250,6 +338,18 @@ "WorkspaceBundle$Owner": "The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
Describes the association between an application and a bundle resource.
", + "refs": { + "BundleResourceAssociationList$member": null + } + }, + "BundleResourceAssociationList": { + "base": null, + "refs": { + "DescribeBundleAssociationsResult$Associations": "List of information about the specified associations.
" + } + }, "BundleType": { "base": null, "refs": { @@ -347,10 +447,23 @@ "Compute": { "base": null, "refs": { + "ComputeList$member": null, "ComputeType$Name": "The compute type.
", "WorkspaceProperties$ComputeTypeName": "The compute type. For more information, see Amazon WorkSpaces Bundles.
" } }, + "ComputeList": { + "base": null, + "refs": { + "DescribeApplicationsRequest$ComputeTypeNames": "The compute types supported by the applications.
", + "WorkSpaceApplication$SupportedComputeTypeNames": "The supported compute types of the WorkSpace application.
" + } + }, + "ComputeNotCompatibleException": { + "base": "The compute type of the WorkSpace is not compatible with the application.
", + "refs": { + } + }, "ComputeType": { "base": "Describes the compute type of the bundle.
", "refs": { @@ -731,6 +844,16 @@ "refs": { } }, + "DeployWorkspaceApplicationsRequest": { + "base": null, + "refs": { + } + }, + "DeployWorkspaceApplicationsResult": { + "base": null, + "refs": { + } + }, "DeregisterWorkspaceDirectoryRequest": { "base": null, "refs": { @@ -761,6 +884,36 @@ "refs": { } }, + "DescribeApplicationAssociationsRequest": { + "base": null, + "refs": { + } + }, + "DescribeApplicationAssociationsResult": { + "base": null, + "refs": { + } + }, + "DescribeApplicationsRequest": { + "base": null, + "refs": { + } + }, + "DescribeApplicationsResult": { + "base": null, + "refs": { + } + }, + "DescribeBundleAssociationsRequest": { + "base": null, + "refs": { + } + }, + "DescribeBundleAssociationsResult": { + "base": null, + "refs": { + } + }, "DescribeClientBrandingRequest": { "base": null, "refs": { @@ -811,6 +964,16 @@ "refs": { } }, + "DescribeImageAssociationsRequest": { + "base": null, + "refs": { + } + }, + "DescribeImageAssociationsResult": { + "base": null, + "refs": { + } + }, "DescribeIpGroupsRequest": { "base": null, "refs": { @@ -831,6 +994,16 @@ "refs": { } }, + "DescribeWorkspaceAssociationsRequest": { + "base": null, + "refs": { + } + }, + "DescribeWorkspaceAssociationsResult": { + "base": null, + "refs": { + } + }, "DescribeWorkspaceBundlesRequest": { "base": null, "refs": { @@ -981,6 +1154,16 @@ "refs": { } }, + "DisassociateWorkspaceApplicationRequest": { + "base": null, + "refs": { + } + }, + "DisassociateWorkspaceApplicationResult": { + "base": null, + "refs": { + } + }, "DnsIpAddresses": { "base": null, "refs": { @@ -994,7 +1177,7 @@ } }, "ErrorDetails": { - "base": "Provides in-depth details about the error. These details include the possible causes of the errors and troubleshooting information.
", + "base": "Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
", "refs": { "ErrorDetailsList$member": null } @@ -1002,7 +1185,7 @@ "ErrorDetailsList": { "base": null, "refs": { - "WorkspaceImage$ErrorDetails": "The details of the error returned for the image.
" + "WorkspaceImage$ErrorDetails": "Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
" } }, "ErrorType": { @@ -1029,6 +1212,7 @@ "ResourceAlreadyExistsException$message": null, "ResourceAssociatedException$message": null, "ResourceCreationFailedException$message": null, + "ResourceInUseException$message": null, "ResourceLimitExceededException$message": "The exception error message.
", "ResourceNotFoundException$message": "The resource could not be found.
", "ResourceUnavailableException$message": "The exception error message.
", @@ -1101,6 +1285,19 @@ "FailedTerminateWorkspaceRequests$member": null } }, + "ImageAssociatedResourceType": { + "base": null, + "refs": { + "ImageAssociatedResourceTypeList$member": null, + "ImageResourceAssociation$AssociatedResourceType": "The resource type of the associated resources.
" + } + }, + "ImageAssociatedResourceTypeList": { + "base": null, + "refs": { + "DescribeImageAssociationsRequest$AssociatedResourceTypes": "The resource types of the associated resource.
" + } + }, "ImagePermission": { "base": "Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
", "refs": { @@ -1113,6 +1310,18 @@ "DescribeWorkspaceImagePermissionsResult$ImagePermissions": "The identifiers of the Amazon Web Services accounts that the image has been shared with.
" } }, + "ImageResourceAssociation": { + "base": "Describes the association between an application and an image resource.
", + "refs": { + "ImageResourceAssociationList$member": null + } + }, + "ImageResourceAssociationList": { + "base": null, + "refs": { + "DescribeImageAssociationsResult$Associations": "List of information about the specified associations.
" + } + }, "ImageType": { "base": null, "refs": { @@ -1139,6 +1348,11 @@ "refs": { } }, + "IncompatibleApplicationsException": { + "base": "The specified application is not compatible with the resource.
", + "refs": { + } + }, "InvalidParameterValuesException": { "base": "One or more parameter values are not valid.
", "refs": { @@ -1259,6 +1473,8 @@ "Limit": { "base": null, "refs": { + "DescribeApplicationAssociationsRequest$MaxResults": "The maximum number of associations to return.
", + "DescribeApplicationsRequest$MaxResults": "The maximum number of applications to return.
", "DescribeConnectClientAddInsRequest$MaxResults": "The maximum number of items to return.
", "DescribeConnectionAliasPermissionsRequest$MaxResults": "The maximum number of results to return.
", "DescribeConnectionAliasesRequest$Limit": "The maximum number of connection aliases to return.
", @@ -1433,22 +1649,28 @@ "NonEmptyString": { "base": null, "refs": { + "ApplicationResourceAssociation$AssociatedResourceId": "The identifier of the associated resource.
", "AssociateConnectionAliasRequest$ResourceId": "The identifier of the directory to associate the connection alias with.
", + "BundleResourceAssociation$AssociatedResourceId": "The identifier of the associated resource.
", "ClientPropertiesResult$ResourceId": "The resource identifier, in the form of a directory ID.
", "ConnectionAliasAssociation$ResourceId": "The identifier of the directory associated with a connection alias.
", "CreateTagsRequest$ResourceId": "The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
", "DeleteTagsRequest$ResourceId": "The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
", "DescribeConnectionAliasesRequest$ResourceId": "The identifier of the directory associated with the connection alias.
", "DescribeTagsRequest$ResourceId": "The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
", + "ImageResourceAssociation$AssociatedResourceId": "The identifier of the associated resource.
", "ModifyClientPropertiesRequest$ResourceId": "The resource identifiers, in the form of directory IDs.
", "ResourceIdList$member": null, + "ResourceInUseException$ResourceId": "The ID of the resource that is in use.
", "ResourceNotFoundException$ResourceId": "The ID of the resource that could not be found.
", "ResourceUnavailableException$ResourceId": "The identifier of the resource that is not available.
", "RootStorage$Capacity": "The size of the root volume.
", "SamlProperties$RelayStateParameterName": "The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
", "TagKeyList$member": null, "UserStorage$Capacity": "The size of the user volume.
", - "WorkspaceBundle$Name": "The name of the bundle.
" + "WorkSpaceApplication$Name": "The name of the WorkSpace application.
", + "WorkspaceBundle$Name": "The name of the bundle.
", + "WorkspaceResourceAssociation$AssociatedResourceId": "The identifier of the associated resource.
" } }, "OperatingSystem": { @@ -1458,6 +1680,25 @@ "WorkspaceImage$OperatingSystem": "The operating system that the image is running.
" } }, + "OperatingSystemName": { + "base": null, + "refs": { + "OperatingSystemNameList$member": null, + "WorkspaceProperties$OperatingSystemName": "The name of the operating system.
" + } + }, + "OperatingSystemNameList": { + "base": null, + "refs": { + "DescribeApplicationsRequest$OperatingSystemNames": "The operating systems supported by the applications.
", + "WorkSpaceApplication$SupportedOperatingSystemNames": "The supported operating systems of the WorkSpace application.
" + } + }, + "OperatingSystemNotCompatibleException": { + "base": "The operating system of the WorkSpace is not compatible with the application.
", + "refs": { + } + }, "OperatingSystemType": { "base": null, "refs": { @@ -1479,6 +1720,10 @@ "refs": { "DescribeAccountModificationsRequest$NextToken": "If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", + "DescribeApplicationAssociationsRequest$NextToken": "If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", "DescribeConnectionAliasPermissionsRequest$NextToken": "If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
The resource identifier, in the form of directory IDs.
" } }, + "ResourceInUseException": { + "base": "The specified resource is currently in use.
", + "refs": { + } + }, "ResourceLimitExceededException": { "base": "Your resource limits have been exceeded.
", "refs": { @@ -1809,6 +2059,13 @@ "refs": { } }, + "String2048": { + "base": null, + "refs": { + "AssociationStateReason$ErrorMessage": "The error message of the association deployment failure.
", + "WorkSpaceApplication$Description": "The description of the WorkSpace application.
" + } + }, "SubnetId": { "base": null, "refs": { @@ -1903,13 +2160,22 @@ "base": null, "refs": { "AccountModification$StartTime": "The timestamp when the modification of the BYOL configuration was started.
", + "ApplicationResourceAssociation$Created": "The time the association was created.
", + "ApplicationResourceAssociation$LastUpdatedTime": "The time the association status was last updated.
", + "BundleResourceAssociation$Created": "The time the association is created.
", + "BundleResourceAssociation$LastUpdatedTime": "The time the association status was last updated.
", "CreateWorkspaceImageResult$Created": "The date when the image was created.
", + "ImageResourceAssociation$Created": "The time the association is created.
", + "ImageResourceAssociation$LastUpdatedTime": "The time the association status was last updated.
", "Snapshot$SnapshotTime": "The time when the snapshot was created.
", + "WorkSpaceApplication$Created": "The time the application is created.
", "WorkspaceBundle$LastUpdatedTime": "The last time that the bundle was updated.
", "WorkspaceBundle$CreationTime": "The time when the bundle was created.
", "WorkspaceConnectionStatus$ConnectionStateCheckTimestamp": "The timestamp of the connection status check.
", "WorkspaceConnectionStatus$LastKnownUserConnectionTimestamp": "The timestamp of the last known user connection.
", - "WorkspaceImage$Created": "The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
" + "WorkspaceImage$Created": "The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
", + "WorkspaceResourceAssociation$Created": "The time the association is created.
", + "WorkspaceResourceAssociation$LastUpdatedTime": "The time the association status was last updated.
" } }, "UnsupportedNetworkConfigurationException": { @@ -2015,6 +2281,74 @@ "WorkspaceRequest$VolumeEncryptionKey": "The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
" } }, + "WorkSpaceApplication": { + "base": "Describes the WorkSpace application.
", + "refs": { + "WorkSpaceApplicationList$member": null + } + }, + "WorkSpaceApplicationDeployment": { + "base": "Describes the WorkSpace application deployment.
", + "refs": { + "DeployWorkspaceApplicationsResult$Deployment": "The list of deployed associations and information about them.
" + } + }, + "WorkSpaceApplicationId": { + "base": null, + "refs": { + "ApplicationResourceAssociation$ApplicationId": "The identifier of the application.
", + "AssociateWorkspaceApplicationRequest$ApplicationId": "The identifier of the application.
", + "DescribeApplicationAssociationsRequest$ApplicationId": "The identifier of the specified application.
", + "DisassociateWorkspaceApplicationRequest$ApplicationId": "The identifier of the application.
", + "WorkSpaceApplication$ApplicationId": "The identifier of the application.
", + "WorkSpaceApplicationIdList$member": null + } + }, + "WorkSpaceApplicationIdList": { + "base": null, + "refs": { + "DescribeApplicationsRequest$ApplicationIds": "The identifiers of one or more applications.
" + } + }, + "WorkSpaceApplicationLicenseType": { + "base": null, + "refs": { + "DescribeApplicationsRequest$LicenseType": "The license availability for the applications.
", + "WorkSpaceApplication$LicenseType": "The license availability for the applications.
" + } + }, + "WorkSpaceApplicationList": { + "base": null, + "refs": { + "DescribeApplicationsResult$Applications": "List of information about the specified applications.
" + } + }, + "WorkSpaceApplicationOwner": { + "base": null, + "refs": { + "DescribeApplicationsRequest$Owner": "The owner of the applications.
", + "WorkSpaceApplication$Owner": "The owner of the WorkSpace application.
" + } + }, + "WorkSpaceApplicationState": { + "base": null, + "refs": { + "WorkSpaceApplication$State": "The status of WorkSpace application.
" + } + }, + "WorkSpaceAssociatedResourceType": { + "base": null, + "refs": { + "WorkSpaceAssociatedResourceTypeList$member": null, + "WorkspaceResourceAssociation$AssociatedResourceType": "The resource types of the associated resource.
" + } + }, + "WorkSpaceAssociatedResourceTypeList": { + "base": null, + "refs": { + "DescribeWorkspaceAssociationsRequest$AssociatedResourceTypes": "The resource types of the associated resources.
" + } + }, "Workspace": { "base": "Describes a WorkSpace.
", "refs": { @@ -2100,8 +2434,12 @@ "WorkspaceId": { "base": null, "refs": { + "AssociateWorkspaceApplicationRequest$WorkspaceId": "The identifier of the WorkSpace.
", "CreateWorkspaceImageRequest$WorkspaceId": "The identifier of the source WorkSpace
", + "DeployWorkspaceApplicationsRequest$WorkspaceId": "The identifier of the WorkSpace.
", + "DescribeWorkspaceAssociationsRequest$WorkspaceId": "The identifier of the WorkSpace.
", "DescribeWorkspaceSnapshotsRequest$WorkspaceId": "The identifier of the WorkSpace.
", + "DisassociateWorkspaceApplicationRequest$WorkspaceId": "The identifier of the WorkSpace.
", "FailedWorkspaceChangeRequest$WorkspaceId": "The identifier of the WorkSpace.
", "MigrateWorkspaceRequest$SourceWorkspaceId": "The identifier of the WorkSpace to migrate from.
", "MigrateWorkspaceResult$SourceWorkspaceId": "The original identifier of the WorkSpace that is being migrated.
", @@ -2119,7 +2457,8 @@ "TerminateRequest$WorkspaceId": "The identifier of the WorkSpace.
", "Workspace$WorkspaceId": "The identifier of the WorkSpace.
", "WorkspaceConnectionStatus$WorkspaceId": "The identifier of the WorkSpace.
", - "WorkspaceIdList$member": null + "WorkspaceIdList$member": null, + "WorkspaceResourceAssociation$WorkspaceId": "The identifier of the WorkSpace.
" } }, "WorkspaceIdList": { @@ -2168,8 +2507,10 @@ "CreateWorkspaceBundleRequest$ImageId": "The identifier of the image that is used to create the bundle.
", "CreateWorkspaceImageResult$ImageId": "The identifier of the new WorkSpace image.
", "DeleteWorkspaceImageRequest$ImageId": "The identifier of the image.
", + "DescribeImageAssociationsRequest$ImageId": "The identifier of the image.
", "DescribeWorkspaceImagePermissionsRequest$ImageId": "The identifier of the image.
", "DescribeWorkspaceImagePermissionsResult$ImageId": "The identifier of the image.
", + "ImageResourceAssociation$ImageId": "The identifier of the image.
", "ImportWorkspaceImageResult$ImageId": "The identifier of the WorkSpace image.
", "UpdateWorkspaceBundleRequest$ImageId": "The identifier of the image.
", "UpdateWorkspaceImagePermissionRequest$ImageId": "The identifier of the image.
", @@ -2249,6 +2590,21 @@ "CreateWorkspacesRequest$Workspaces": "The WorkSpaces to create. You can specify up to 25 WorkSpaces.
" } }, + "WorkspaceResourceAssociation": { + "base": "Describes the association between an application and a WorkSpace resource.
", + "refs": { + "AssociateWorkspaceApplicationResult$Association": "Information about the association between the specified WorkSpace and the specified application.
", + "DisassociateWorkspaceApplicationResult$Association": "Information about the targeted association.
", + "WorkspaceResourceAssociationList$member": null + } + }, + "WorkspaceResourceAssociationList": { + "base": null, + "refs": { + "DescribeWorkspaceAssociationsResult$Associations": "List of information about the specified associations.
", + "WorkSpaceApplicationDeployment$Associations": "The associations between the applications and the associated resources.
" + } + }, "WorkspaceState": { "base": null, "refs": { diff --git a/models/apis/workspaces/2015-04-08/paginators-1.json b/models/apis/workspaces/2015-04-08/paginators-1.json index cc7a0c68892..93b49cb1e0f 100644 --- a/models/apis/workspaces/2015-04-08/paginators-1.json +++ b/models/apis/workspaces/2015-04-08/paginators-1.json @@ -1,5 +1,15 @@ { "pagination": { + "DescribeApplicationAssociations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "DescribeApplications": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, "DescribeWorkspaceBundles": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index e05463012b1..b405235b338 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -2424,6 +2424,12 @@ "endpoints" : { "ap-northeast-1" : { }, "ap-southeast-1" : { }, + "bedrock-ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "bedrock.ap-northeast-1.amazonaws.com" + }, "bedrock-ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" @@ -2442,6 +2448,12 @@ }, "hostname" : "bedrock-fips.us-west-2.amazonaws.com" }, + "bedrock-runtime-ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "bedrock-runtime.ap-northeast-1.amazonaws.com" + }, "bedrock-runtime-ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" @@ -4590,6 +4602,9 @@ "ap-east-1" : { "hostname" : "datazone.ap-east-1.api.aws" }, + "ap-northeast-1" : { + "hostname" : "datazone.ap-northeast-1.api.aws" + }, "ap-northeast-2" : { "hostname" : "datazone.ap-northeast-2.api.aws" }, @@ -4602,21 +4617,43 @@ "ap-south-2" : { "hostname" : "datazone.ap-south-2.api.aws" }, + "ap-southeast-1" : { + "hostname" : "datazone.ap-southeast-1.api.aws" + }, + "ap-southeast-2" : { + "hostname" : "datazone.ap-southeast-2.api.aws" + }, "ap-southeast-3" : { "hostname" : "datazone.ap-southeast-3.api.aws" }, "ap-southeast-4" : { "hostname" : "datazone.ap-southeast-4.api.aws" }, + "ca-central-1" : { + "hostname" : "datazone.ca-central-1.api.aws", + "variants" : [ { + "hostname" : "datazone-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { + "hostname" : "datazone.eu-central-1.api.aws" + }, "eu-central-2" : { "hostname" : "datazone.eu-central-2.api.aws" }, + "eu-north-1" : { + "hostname" : "datazone.eu-north-1.api.aws" + }, "eu-south-1" : { "hostname" : "datazone.eu-south-1.api.aws" }, "eu-south-2" : { "hostname" : "datazone.eu-south-2.api.aws" }, + "eu-west-1" : { + "hostname" : "datazone.eu-west-1.api.aws" + }, "eu-west-2" : { "hostname" : "datazone.eu-west-2.api.aws" }, @@ -4632,8 +4669,32 @@ "me-south-1" : { "hostname" : "datazone.me-south-1.api.aws" }, + "sa-east-1" : { + "hostname" : "datazone.sa-east-1.api.aws" + }, + "us-east-1" : { + "hostname" : "datazone.us-east-1.api.aws", + "variants" : [ { + "hostname" : "datazone-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "hostname" : "datazone.us-east-2.api.aws", + "variants" : [ { + "hostname" : "datazone-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-1" : { "hostname" : "datazone.us-west-1.api.aws" + }, + "us-west-2" : { + "hostname" : "datazone.us-west-2.api.aws", + "variants" : [ { + "hostname" : "datazone-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] } } }, @@ -22734,6 +22795,26 @@ } } }, + "m2" : { + "endpoints" : { + "fips-us-gov-east-1" : { + "deprecated" : true + }, + "fips-us-gov-west-1" : { + "deprecated" : true + }, + "us-gov-east-1" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + } + } + }, "managedblockchain" : { "endpoints" : { "us-gov-west-1" : { } diff --git a/service/omics/api.go b/service/omics/api.go index e3fa2ed5334..0357a9e89b8 100644 --- a/service/omics/api.go +++ b/service/omics/api.go @@ -53,7 +53,6 @@ func (c *Omics) AbortMultipartReadSetUploadRequest(input *AbortMultipartReadSetU output = &AbortMultipartReadSetUploadOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -157,7 +156,6 @@ func (c *Omics) AcceptShareRequest(input *AcceptShareInput) (req *request.Reques output = &AcceptShareOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -257,7 +255,6 @@ func (c *Omics) BatchDeleteReadSetRequest(input *BatchDeleteReadSetInput) (req * output = &BatchDeleteReadSetOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -354,7 +351,6 @@ func (c *Omics) CancelAnnotationImportJobRequest(input *CancelAnnotationImportJo output = &CancelAnnotationImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -449,7 +445,6 @@ func (c *Omics) CancelRunRequest(input *CancelRunInput) (req *request.Request, o output = &CancelRunOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -553,7 +548,6 @@ func (c *Omics) CancelVariantImportJobRequest(input *CancelVariantImportJobInput output = &CancelVariantImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -648,7 +642,6 @@ func (c *Omics) CompleteMultipartReadSetUploadRequest(input *CompleteMultipartRe output = &CompleteMultipartReadSetUploadOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -751,7 +744,6 @@ func (c *Omics) CreateAnnotationStoreRequest(input *CreateAnnotationStoreInput) output = &CreateAnnotationStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -851,7 +843,6 @@ func (c *Omics) CreateAnnotationStoreVersionRequest(input *CreateAnnotationStore output = &CreateAnnotationStoreVersionOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -951,7 +942,6 @@ func (c *Omics) CreateMultipartReadSetUploadRequest(input *CreateMultipartReadSe output = &CreateMultipartReadSetUploadOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -1054,7 +1044,6 @@ func (c *Omics) CreateReferenceStoreRequest(input *CreateReferenceStoreInput) (r output = &CreateReferenceStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -1151,7 +1140,6 @@ func (c *Omics) CreateRunGroupRequest(input *CreateRunGroupInput) (req *request. output = &CreateRunGroupOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -1254,7 +1242,6 @@ func (c *Omics) CreateSequenceStoreRequest(input *CreateSequenceStoreInput) (req output = &CreateSequenceStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -1351,7 +1338,6 @@ func (c *Omics) CreateShareRequest(input *CreateShareInput) (req *request.Reques output = &CreateShareOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -1452,7 +1438,6 @@ func (c *Omics) CreateVariantStoreRequest(input *CreateVariantStoreInput) (req * output = &CreateVariantStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -1552,7 +1537,6 @@ func (c *Omics) CreateWorkflowRequest(input *CreateWorkflowInput) (req *request. output = &CreateWorkflowOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -1655,7 +1639,6 @@ func (c *Omics) DeleteAnnotationStoreRequest(input *DeleteAnnotationStoreInput) output = &DeleteAnnotationStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -1752,7 +1735,6 @@ func (c *Omics) DeleteAnnotationStoreVersionsRequest(input *DeleteAnnotationStor output = &DeleteAnnotationStoreVersionsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -1849,7 +1831,6 @@ func (c *Omics) DeleteReferenceRequest(input *DeleteReferenceInput) (req *reques output = &DeleteReferenceOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -1950,7 +1931,6 @@ func (c *Omics) DeleteReferenceStoreRequest(input *DeleteReferenceStoreInput) (r output = &DeleteReferenceStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -2051,7 +2031,6 @@ func (c *Omics) DeleteRunRequest(input *DeleteRunInput) (req *request.Request, o output = &DeleteRunOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -2155,7 +2134,6 @@ func (c *Omics) DeleteRunGroupRequest(input *DeleteRunGroupInput) (req *request. output = &DeleteRunGroupOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -2259,7 +2237,6 @@ func (c *Omics) DeleteSequenceStoreRequest(input *DeleteSequenceStoreInput) (req output = &DeleteSequenceStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -2360,7 +2337,6 @@ func (c *Omics) DeleteShareRequest(input *DeleteShareInput) (req *request.Reques output = &DeleteShareOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -2460,7 +2436,6 @@ func (c *Omics) DeleteVariantStoreRequest(input *DeleteVariantStoreInput) (req * output = &DeleteVariantStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -2557,7 +2532,6 @@ func (c *Omics) DeleteWorkflowRequest(input *DeleteWorkflowInput) (req *request. output = &DeleteWorkflowOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -2661,7 +2635,6 @@ func (c *Omics) GetAnnotationImportJobRequest(input *GetAnnotationImportJobInput output = &GetAnnotationImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -2755,7 +2728,6 @@ func (c *Omics) GetAnnotationStoreRequest(input *GetAnnotationStoreInput) (req * output = &GetAnnotationStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -2849,7 +2821,6 @@ func (c *Omics) GetAnnotationStoreVersionRequest(input *GetAnnotationStoreVersio output = &GetAnnotationStoreVersionOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -2943,7 +2914,6 @@ func (c *Omics) GetReadSetRequest(input *GetReadSetInput) (req *request.Request, output = &GetReadSetOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3046,7 +3016,6 @@ func (c *Omics) GetReadSetActivationJobRequest(input *GetReadSetActivationJobInp output = &GetReadSetActivationJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3143,7 +3112,6 @@ func (c *Omics) GetReadSetExportJobRequest(input *GetReadSetExportJobInput) (req output = &GetReadSetExportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3240,7 +3208,6 @@ func (c *Omics) GetReadSetImportJobRequest(input *GetReadSetImportJobInput) (req output = &GetReadSetImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3337,7 +3304,6 @@ func (c *Omics) GetReadSetMetadataRequest(input *GetReadSetMetadataInput) (req * output = &GetReadSetMetadataOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3434,7 +3400,6 @@ func (c *Omics) GetReferenceRequest(input *GetReferenceInput) (req *request.Requ output = &GetReferenceOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3534,7 +3499,6 @@ func (c *Omics) GetReferenceImportJobRequest(input *GetReferenceImportJobInput) output = &GetReferenceImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3631,7 +3595,6 @@ func (c *Omics) GetReferenceMetadataRequest(input *GetReferenceMetadataInput) (r output = &GetReferenceMetadataOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3728,7 +3691,6 @@ func (c *Omics) GetReferenceStoreRequest(input *GetReferenceStoreInput) (req *re output = &GetReferenceStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3825,7 +3787,6 @@ func (c *Omics) GetRunRequest(input *GetRunInput) (req *request.Request, output output = &GetRunOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -3928,7 +3889,6 @@ func (c *Omics) GetRunGroupRequest(input *GetRunGroupInput) (req *request.Reques output = &GetRunGroupOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -4031,7 +3991,6 @@ func (c *Omics) GetRunTaskRequest(input *GetRunTaskInput) (req *request.Request, output = &GetRunTaskOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -4134,7 +4093,6 @@ func (c *Omics) GetSequenceStoreRequest(input *GetSequenceStoreInput) (req *requ output = &GetSequenceStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -4231,7 +4189,6 @@ func (c *Omics) GetShareRequest(input *GetShareInput) (req *request.Request, out output = &GetShareOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -4331,7 +4288,6 @@ func (c *Omics) GetVariantImportJobRequest(input *GetVariantImportJobInput) (req output = &GetVariantImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -4425,7 +4381,6 @@ func (c *Omics) GetVariantStoreRequest(input *GetVariantStoreInput) (req *reques output = &GetVariantStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -4519,7 +4474,6 @@ func (c *Omics) GetWorkflowRequest(input *GetWorkflowInput) (req *request.Reques output = &GetWorkflowOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -4628,7 +4582,6 @@ func (c *Omics) ListAnnotationImportJobsRequest(input *ListAnnotationImportJobsI output = &ListAnnotationImportJobsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -4779,7 +4732,6 @@ func (c *Omics) ListAnnotationStoreVersionsRequest(input *ListAnnotationStoreVer output = &ListAnnotationStoreVersionsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -4930,7 +4882,6 @@ func (c *Omics) ListAnnotationStoresRequest(input *ListAnnotationStoresInput) (r output = &ListAnnotationStoresOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -5081,7 +5032,6 @@ func (c *Omics) ListMultipartReadSetUploadsRequest(input *ListMultipartReadSetUp output = &ListMultipartReadSetUploadsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -5241,7 +5191,6 @@ func (c *Omics) ListReadSetActivationJobsRequest(input *ListReadSetActivationJob output = &ListReadSetActivationJobsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -5395,7 +5344,6 @@ func (c *Omics) ListReadSetExportJobsRequest(input *ListReadSetExportJobsInput) output = &ListReadSetExportJobsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -5549,7 +5497,6 @@ func (c *Omics) ListReadSetImportJobsRequest(input *ListReadSetImportJobsInput) output = &ListReadSetImportJobsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -5703,7 +5650,6 @@ func (c *Omics) ListReadSetUploadPartsRequest(input *ListReadSetUploadPartsInput output = &ListReadSetUploadPartsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -5864,7 +5810,6 @@ func (c *Omics) ListReadSetsRequest(input *ListReadSetsInput) (req *request.Requ output = &ListReadSetsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -6018,7 +5963,6 @@ func (c *Omics) ListReferenceImportJobsRequest(input *ListReferenceImportJobsInp output = &ListReferenceImportJobsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -6172,7 +6116,6 @@ func (c *Omics) ListReferenceStoresRequest(input *ListReferenceStoresInput) (req output = &ListReferenceStoresOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -6323,7 +6266,6 @@ func (c *Omics) ListReferencesRequest(input *ListReferencesInput) (req *request. output = &ListReferencesOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -6477,7 +6419,6 @@ func (c *Omics) ListRunGroupsRequest(input *ListRunGroupsInput) (req *request.Re output = &ListRunGroupsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -6637,7 +6578,6 @@ func (c *Omics) ListRunTasksRequest(input *ListRunTasksInput) (req *request.Requ output = &ListRunTasksOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -6797,7 +6737,6 @@ func (c *Omics) ListRunsRequest(input *ListRunsInput) (req *request.Request, out output = &ListRunsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -6957,7 +6896,6 @@ func (c *Omics) ListSequenceStoresRequest(input *ListSequenceStoresInput) (req * output = &ListSequenceStoresOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -7108,7 +7046,6 @@ func (c *Omics) ListSharesRequest(input *ListSharesInput) (req *request.Request, output = &ListSharesOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -7259,7 +7196,6 @@ func (c *Omics) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req output = &ListTagsForResourceOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("tags-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -7368,7 +7304,6 @@ func (c *Omics) ListVariantImportJobsRequest(input *ListVariantImportJobsInput) output = &ListVariantImportJobsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -7519,7 +7454,6 @@ func (c *Omics) ListVariantStoresRequest(input *ListVariantStoresInput) (req *re output = &ListVariantStoresOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -7670,7 +7604,6 @@ func (c *Omics) ListWorkflowsRequest(input *ListWorkflowsInput) (req *request.Re output = &ListWorkflowsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -7824,7 +7757,6 @@ func (c *Omics) StartAnnotationImportJobRequest(input *StartAnnotationImportJobI output = &StartAnnotationImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -7921,7 +7853,6 @@ func (c *Omics) StartReadSetActivationJobRequest(input *StartReadSetActivationJo output = &StartReadSetActivationJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -8022,7 +7953,6 @@ func (c *Omics) StartReadSetExportJobRequest(input *StartReadSetExportJobInput) output = &StartReadSetExportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -8122,7 +8052,6 @@ func (c *Omics) StartReadSetImportJobRequest(input *StartReadSetImportJobInput) output = &StartReadSetImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -8222,7 +8151,6 @@ func (c *Omics) StartReferenceImportJobRequest(input *StartReferenceImportJobInp output = &StartReferenceImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("control-storage-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -8322,7 +8250,6 @@ func (c *Omics) StartRunRequest(input *StartRunInput) (req *request.Request, out output = &StartRunOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -8431,7 +8358,6 @@ func (c *Omics) StartVariantImportJobRequest(input *StartVariantImportJobInput) output = &StartVariantImportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -8528,7 +8454,6 @@ func (c *Omics) TagResourceRequest(input *TagResourceInput) (req *request.Reques output = &TagResourceOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("tags-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -8632,7 +8557,6 @@ func (c *Omics) UntagResourceRequest(input *UntagResourceInput) (req *request.Re output = &UntagResourceOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("tags-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -8736,7 +8660,6 @@ func (c *Omics) UpdateAnnotationStoreRequest(input *UpdateAnnotationStoreInput) output = &UpdateAnnotationStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -8830,7 +8753,6 @@ func (c *Omics) UpdateAnnotationStoreVersionRequest(input *UpdateAnnotationStore output = &UpdateAnnotationStoreVersionOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -8924,7 +8846,6 @@ func (c *Omics) UpdateRunGroupRequest(input *UpdateRunGroupInput) (req *request. output = &UpdateRunGroupOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -9028,7 +8949,6 @@ func (c *Omics) UpdateVariantStoreRequest(input *UpdateVariantStoreInput) (req * output = &UpdateVariantStoreOutput{} req = c.newRequest(op, input, output) - req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("analytics-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) return @@ -9122,7 +9042,6 @@ func (c *Omics) UpdateWorkflowRequest(input *UpdateWorkflowInput) (req *request. output = &UpdateWorkflowOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("workflows-", nil)) req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) @@ -13406,6 +13325,56 @@ func (s DeleteWorkflowOutput) GoString() string { return s.String() } +// The entity tag (ETag) is a hash of the object representing its semantic content. +type ETag struct { + _ struct{} `type:"structure"` + + // The algorithm used to calculate the read set’s ETag(s). + Algorithm *string `locationName:"algorithm" type:"string" enum:"ETagAlgorithm"` + + // The ETag hash calculated on Source1 of the read set. + Source1 *string `locationName:"source1" type:"string"` + + // The ETag hash calculated on Source2 of the read set. + Source2 *string `locationName:"source2" 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 ETag) 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 ETag) GoString() string { + return s.String() +} + +// SetAlgorithm sets the Algorithm field's value. +func (s *ETag) SetAlgorithm(v string) *ETag { + s.Algorithm = &v + return s +} + +// SetSource1 sets the Source1 field's value. +func (s *ETag) SetSource1(v string) *ETag { + s.Source1 = &v + return s +} + +// SetSource2 sets the Source2 field's value. +func (s *ETag) SetSource2(v string) *ETag { + s.Source2 = &v + return s +} + // A read set. type ExportReadSet struct { _ struct{} `type:"structure"` @@ -15159,6 +15128,10 @@ type GetReadSetMetadataOutput struct { // The read set's description. Description *string `locationName:"description" min:"1" type:"string"` + // The entity tag (ETag) is a hash of the object meant to represent its semantic + // content. + Etag *ETag `locationName:"etag" type:"structure"` + // The read set's file type. // // FileType is a required field @@ -15244,6 +15217,12 @@ func (s *GetReadSetMetadataOutput) SetDescription(v string) *GetReadSetMetadataO return s } +// SetEtag sets the Etag field's value. +func (s *GetReadSetMetadataOutput) SetEtag(v *ETag) *GetReadSetMetadataOutput { + s.Etag = v + return s +} + // SetFileType sets the FileType field's value. func (s *GetReadSetMetadataOutput) SetFileType(v string) *GetReadSetMetadataOutput { s.FileType = &v @@ -21391,6 +21370,9 @@ type ReadSetListItem struct { // The read set's description. Description *string `locationName:"description" min:"1" type:"string"` + // The entity tag (ETag) is a hash of the object representing its semantic content. + Etag *ETag `locationName:"etag" type:"structure"` + // The read set's file type. // // FileType is a required field @@ -21473,6 +21455,12 @@ func (s *ReadSetListItem) SetDescription(v string) *ReadSetListItem { return s } +// SetEtag sets the Etag field's value. +func (s *ReadSetListItem) SetEtag(v *ETag) *ReadSetListItem { + s.Etag = v + return s +} + // SetFileType sets the FileType field's value. func (s *ReadSetListItem) SetFileType(v string) *ReadSetListItem { s.FileType = &v @@ -26711,6 +26699,26 @@ func CreationType_Values() []string { } } +const ( + // ETagAlgorithmFastqMd5up is a ETagAlgorithm enum value + ETagAlgorithmFastqMd5up = "FASTQ_MD5up" + + // ETagAlgorithmBamMd5up is a ETagAlgorithm enum value + ETagAlgorithmBamMd5up = "BAM_MD5up" + + // ETagAlgorithmCramMd5up is a ETagAlgorithm enum value + ETagAlgorithmCramMd5up = "CRAM_MD5up" +) + +// ETagAlgorithm_Values returns all elements of the ETagAlgorithm enum +func ETagAlgorithm_Values() []string { + return []string{ + ETagAlgorithmFastqMd5up, + ETagAlgorithmBamMd5up, + ETagAlgorithmCramMd5up, + } +} + const ( // EncryptionTypeKms is a EncryptionType enum value EncryptionTypeKms = "KMS" diff --git a/service/rds/api.go b/service/rds/api.go index 32179862406..88056cbd3bc 100644 --- a/service/rds/api.go +++ b/service/rds/api.go @@ -2153,8 +2153,8 @@ func (c *RDS) CreateDBInstanceReadReplicaRequest(input *CreateDBInstanceReadRepl // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica) // in the Amazon RDS User Guide. // -// Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation -// to create a DB instance for an Aurora DB cluster. +// Amazon Aurora doesn't support this operation. To create a DB instance for +// an Aurora DB cluster, use the CreateDBInstance operation. // // All read replica DB instances are created with backups disabled. All other // attributes (including DB security groups and DB parameter groups) are inherited @@ -3850,15 +3850,14 @@ func (c *RDS) DeleteDBInstanceRequest(input *DeleteDBInstanceInput) (req *reques // DeleteDBInstance API operation for Amazon Relational Database Service. // -// The DeleteDBInstance action deletes a previously provisioned DB instance. -// When you delete a DB instance, all automated backups for that instance are -// deleted and can't be recovered. Manual DB snapshots of the DB instance to -// be deleted by DeleteDBInstance are not deleted. +// Deletes a previously provisioned DB instance. When you delete a DB instance, +// all automated backups for that instance are deleted and can't be recovered. +// However, manual DB snapshots of the DB instance aren't deleted. // -// If you request a final DB snapshot the status of the Amazon RDS DB instance -// is deleting until the DB snapshot is created. The API action DescribeDBInstance -// is used to monitor the status of this operation. The action can't be canceled -// or reverted once submitted. +// If you request a final DB snapshot, the status of the Amazon RDS DB instance +// is deleting until the DB snapshot is created. This operation can't be canceled +// or reverted after it begins. To monitor the status of this operation, use +// DescribeDBInstance. // // When a DB instance is in a failure state and has a status of failed, incompatible-restore, // or incompatible-network, you can only delete it when you skip creation of @@ -3871,11 +3870,16 @@ func (c *RDS) DeleteDBInstanceRequest(input *DeleteDBInstanceInput) (req *reques // // - The DB instance is the only instance in the DB cluster. // -// To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster -// API action to promote the DB cluster so it's no longer a read replica. After -// the promotion completes, then call the DeleteDBInstance API action to delete +// To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster +// operation to promote the DB cluster so that it's no longer a read replica. +// After the promotion completes, use the DeleteDBInstance operation to delete // the final instance in the DB cluster. // +// For RDS Custom DB instances, deleting the DB instance permanently deletes +// the EC2 instance and the associated EBS volumes. Make sure that you don't +// terminate or delete these resources before you delete the DB instance. Otherwise, +// deleting the DB instance and creation of the final snapshot might fail. +// // 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. @@ -6378,7 +6382,7 @@ func (c *RDS) DescribeDBEngineVersionsRequest(input *DescribeDBEngineVersionsInp // DescribeDBEngineVersions API operation for Amazon Relational Database Service. // -// Returns a list of the available DB engines. +// Describes the properties of specific versions of DB engines. // // 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 @@ -16498,7 +16502,7 @@ type ApplyPendingMaintenanceActionInput struct { // The pending maintenance action to apply to this resource. // - // Valid values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation + // Valid Values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation // // ApplyAction is a required field ApplyAction *string `type:"string" required:"true"` @@ -16506,7 +16510,7 @@ type ApplyPendingMaintenanceActionInput struct { // A value that specifies the type of opt-in request, or undoes an opt-in request. // An opt-in request of type immediate can't be undone. // - // Valid values: + // Valid Values: // // * immediate - Apply the maintenance action immediately. // @@ -16863,16 +16867,14 @@ type BacktrackDBClusterInput struct { // DBClusterIdentifier is a required field DBClusterIdentifier *string `type:"string" required:"true"` - // A value that indicates whether to force the DB cluster to backtrack when - // binary logging is enabled. Otherwise, an error occurs when binary logging - // is enabled. + // Specifies whether to force the DB cluster to backtrack when binary logging + // is enabled. Otherwise, an error occurs when binary logging is enabled. Force *bool `type:"boolean"` - // A value that indicates whether to backtrack the DB cluster to the earliest - // possible backtrack time when BacktrackTo is set to a timestamp earlier than - // the earliest backtrack time. When this parameter is disabled and BacktrackTo - // is set to a timestamp earlier than the earliest backtrack time, an error - // occurs. + // Specifies whether to backtrack the DB cluster to the earliest possible backtrack + // time when BacktrackTo is set to a timestamp earlier than the earliest backtrack + // time. When this parameter is disabled and BacktrackTo is set to a timestamp + // earlier than the earliest backtrack time, an error occurs. UseEarliestTimeOnPointInTimeUnavailable *bool `type:"boolean"` } @@ -17287,11 +17289,13 @@ func (s *CancelExportTaskInput) SetExportTaskIdentifier(v string) *CancelExportT // Contains the details of a snapshot or cluster export to Amazon S3. // -// This data type is used as a response element in the DescribeExportTasks action. +// This data type is used as a response element in the DescribeExportTasks operation. type CancelExportTaskOutput struct { _ struct{} `type:"structure"` - // The data exported from the snapshot or cluster. Valid values are the following: + // The data exported from the snapshot or cluster. + // + // Valid Values: // // * database - Export all the data from a specified database. // @@ -17327,14 +17331,14 @@ type CancelExportTaskOutput struct { // The progress of the snapshot or cluster export task as a percentage. PercentProgress *int64 `type:"integer"` - // The Amazon S3 bucket that the snapshot or cluster is exported to. + // The Amazon S3 bucket where the snapshot or cluster is exported to. S3Bucket *string `type:"string"` // The Amazon S3 bucket prefix that is the file name and path of the exported // data. S3Prefix *string `type:"string"` - // The time that the snapshot was created. + // The time when the snapshot was created. SnapshotTime *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon @@ -17359,10 +17363,10 @@ type CancelExportTaskOutput struct { // * STARTING Status *string `type:"string"` - // The time that the snapshot or cluster export task ended. + // The time when the snapshot or cluster export task ended. TaskEndTime *time.Time `type:"timestamp"` - // The time that the snapshot or cluster export task started. + // The time when the snapshot or cluster export task started. TaskStartTime *time.Time `type:"timestamp"` // The total amount of data exported, in gigabytes. @@ -17505,7 +17509,7 @@ type Certificate struct { // The type of the certificate. CertificateType *string `type:"string"` - // Whether there is an override for the default certificate identifier. + // Indicates whether there is an override for the default certificate identifier. CustomerOverride *bool `type:"boolean"` // If there is an override for the default certificate identifier, when the @@ -17751,8 +17755,8 @@ type ClusterPendingModifiedValues struct { // The database engine version. EngineVersion *string `type:"string"` - // A value that indicates whether mapping of Amazon Web Services Identity and - // Access Management (IAM) accounts to database accounts is enabled. + // Indicates whether mapping of Amazon Web Services Identity and Access Management + // (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` // The Provisioned IOPS (I/O operations per second) value. This setting is only @@ -17848,12 +17852,15 @@ type ConnectionPoolConfiguration struct { _ struct{} `type:"structure"` // The number of seconds for a proxy to wait for a connection to become available - // in the connection pool. Only applies when the proxy has opened its maximum - // number of connections and all connections are busy with client sessions. + // in the connection pool. This setting only applies when the proxy has opened + // its maximum number of connections and all connections are busy with client + // sessions. For an unlimited wait time, specify 0. // // Default: 120 // - // Constraints: between 1 and 3600, or 0 representing unlimited + // Constraints: + // + // * Must be between 0 and 3600. ConnectionBorrowTimeout *int64 `type:"integer"` // One or more SQL statements for the proxy to run when opening each new database @@ -17874,13 +17881,15 @@ type ConnectionPoolConfiguration struct { // // Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines // - // Constraints: Must be between 1 and 100. + // Constraints: + // + // * Must be between 1 and 100. MaxConnectionsPercent *int64 `type:"integer"` - // Controls how actively the proxy closes idle database connections in the connection - // pool. The value is expressed as a percentage of the max_connections setting - // for the RDS DB instance or Aurora DB cluster used by the target group. With - // a high value, the proxy leaves a high percentage of idle database connections + // A value that controls how actively the proxy closes idle database connections + // in the connection pool. The value is expressed as a percentage of the max_connections + // setting for the RDS DB instance or Aurora DB cluster used by the target group. + // With a high value, the proxy leaves a high percentage of idle database connections // open. A low value causes the proxy to close more idle connections and return // them to the database. // @@ -17892,7 +17901,9 @@ type ConnectionPoolConfiguration struct { // Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default // is 50. // - // Constraints: Must be between 0 and the value of MaxConnectionsPercent. + // Constraints: + // + // * Must be between 0 and the value of MaxConnectionsPercent. MaxIdleConnectionsPercent *int64 `type:"integer"` // Each item in the list represents a class of SQL operations that normally @@ -18180,8 +18191,8 @@ func (s *CopyDBClusterParameterGroupOutput) SetDBClusterParameterGroup(v *DBClus type CopyDBClusterSnapshotInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to copy all tags from the source DB cluster - // snapshot to the target DB cluster snapshot. By default, tags are not copied. + // Specifies whether to copy all tags from the source DB cluster snapshot to + // the target DB cluster snapshot. By default, tags are not copied. CopyTags *bool `type:"boolean"` // DestinationRegion is used for presigning the request to a given region. @@ -18558,14 +18569,14 @@ func (s *CopyDBParameterGroupOutput) SetDBParameterGroup(v *DBParameterGroup) *C type CopyDBSnapshotInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to copy the DB option group associated with - // the source DB snapshot to the target Amazon Web Services account and associate - // with the target DB snapshot. The associated option group can be copied only - // with cross-account snapshot copy calls. + // Specifies whether to copy the DB option group associated with the source + // DB snapshot to the target Amazon Web Services account and associate with + // the target DB snapshot. The associated option group can be copied only with + // cross-account snapshot copy calls. CopyOptionGroup *bool `type:"boolean"` - // A value that indicates whether to copy all tags from the source DB snapshot - // to the target DB snapshot. By default, tags aren't copied. + // Specifies whether to copy all tags from the source DB snapshot to the target + // DB snapshot. By default, tags aren't copied. CopyTags *bool `type:"boolean"` // DestinationRegion is used for presigning the request to a given region. @@ -19475,31 +19486,30 @@ type CreateCustomDBEngineVersionOutput struct { // of the CreateDBInstance action. SupportedTimezones []*Timezone `locationNameList:"Timezone" type:"list"` - // A value that indicates whether the engine version supports Babelfish for - // Aurora PostgreSQL. + // Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. SupportsBabelfish *bool `type:"boolean"` - // A value that indicates whether the engine version supports rotating the server - // certificate without rebooting the DB instance. + // Indicates whether the engine version supports rotating the server certificate + // without rebooting the DB instance. SupportsCertificateRotationWithoutRestart *bool `type:"boolean"` - // A value that indicates whether you can use Aurora global databases with a - // specific DB engine version. + // Indicates whether you can use Aurora global databases with a specific DB + // engine version. SupportsGlobalDatabases *bool `type:"boolean"` - // A value that indicates whether the DB engine version supports forwarding - // write operations from reader DB instances to the writer DB instance in the - // DB cluster. By default, write operations aren't allowed on reader DB instances. + // Indicates whether the DB engine version supports forwarding write operations + // from reader DB instances to the writer DB instance in the DB cluster. By + // default, write operations aren't allowed on reader DB instances. // // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool `type:"boolean"` - // A value that indicates whether the engine version supports exporting the - // log types specified by ExportableLogTypes to CloudWatch Logs. + // Indicates whether the engine version supports exporting the log types specified + // by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs *bool `type:"boolean"` - // A value that indicates whether you can use Aurora parallel query with a specific - // DB engine version. + // Indicates whether you can use Aurora parallel query with a specific DB engine + // version. SupportsParallelQuery *bool `type:"boolean"` // Indicates whether the database engine version supports read replicas. @@ -22025,7 +22035,9 @@ type CreateDBInstanceInput struct { // // * Can't be specified if ManageMasterUserPassword is turned on. // - // * Can include any printable ASCII character except "/", """, or "@". + // * Can include any printable ASCII character except "/", """, or "@". For + // RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) + // character. // // Length Constraints: // @@ -22805,12 +22817,12 @@ type CreateDBInstanceReadReplicaInput struct { // growth. AllocatedStorage *int64 `type:"integer"` - // A value that indicates whether minor engine upgrades are applied automatically - // to the read replica during the maintenance window. + // Specifies whether to automatically apply minor engine upgrades to the read + // replica during the maintenance window. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. // - // Default: Inherits from the source DB instance + // Default: Inherits the value from the source DB instance. AutoMinorVersionUpgrade *bool `type:"boolean"` // The Availability Zone (AZ) where the read replica will be created. @@ -22821,8 +22833,8 @@ type CreateDBInstanceReadReplicaInput struct { // Example: us-east-1d AvailabilityZone *string `type:"string"` - // A value that indicates whether to copy all tags from the read replica to - // snapshots of the read replica. By default, tags are not copied. + // Specifies whether to copy all tags from the read replica to snapshots of + // the read replica. By default, tags aren't copied. CopyTagsToSnapshot *bool `type:"boolean"` // The instance profile associated with the underlying Amazon EC2 instance of @@ -22840,7 +22852,7 @@ type CreateDBInstanceReadReplicaInput struct { // and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) // in the Amazon RDS User Guide. // - // This setting is required for RDS Custom. + // This setting is required for RDS Custom DB instances. CustomIamInstanceProfile *string `type:"string"` // The compute and memory capacity of the read replica, for example db.m4.large. @@ -22849,7 +22861,7 @@ type CreateDBInstanceReadReplicaInput struct { // availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. // - // Default: Inherits from the source DB instance. + // Default: Inherits the value from the source DB instance. DBInstanceClass *string `type:"string"` // The DB instance identifier of the read replica. This identifier is the unique @@ -22861,36 +22873,38 @@ type CreateDBInstanceReadReplicaInput struct { // The name of the DB parameter group to associate with this DB instance. // - // If you do not specify a value for DBParameterGroupName, then Amazon RDS uses - // the DBParameterGroup of source DB instance for a same Region read replica, + // If you don't specify a value for DBParameterGroupName, then Amazon RDS uses + // the DBParameterGroup of the source DB instance for a same Region read replica, // or the default DBParameterGroup for the specified DB engine for a cross-Region // read replica. // // Specifying a parameter group for this operation is only supported for MySQL - // and Oracle DB instances. It isn't supported for RDS Custom. + // DB instances for cross-Region read replicas and for Oracle DB instances. + // It isn't supported for MySQL DB instances for same Region read replicas or + // for RDS Custom. // // Constraints: // // * Must be 1 to 255 letters, numbers, or hyphens. // - // * First character must be a letter + // * First character must be a letter. // - // * Can't end with a hyphen or contain two consecutive hyphens + // * Can't end with a hyphen or contain two consecutive hyphens. DBParameterGroupName *string `type:"string"` - // Specifies a DB subnet group for the DB instance. The new DB instance is created - // in the VPC associated with the DB subnet group. If no DB subnet group is - // specified, then the new DB instance isn't created in a VPC. + // A DB subnet group for the DB instance. The new DB instance is created in + // the VPC associated with the DB subnet group. If no DB subnet group is specified, + // then the new DB instance isn't created in a VPC. // // Constraints: // - // * If supplied, must match the name of an existing DBSubnetGroup. + // * If supplied, must match the name of an existing DB subnet group. // // * The specified DB subnet group must be in the same Amazon Web Services // Region in which the operation is running. // // * All read replicas in one Amazon Web Services Region that are created - // from the same source DB instance must either:> Specify DB subnet groups + // from the same source DB instance must either: Specify DB subnet groups // from the same VPC. All these read replicas are created in the same VPC. // Not specify a DB subnet group. All these read replicas are created outside // of any VPC. @@ -22898,8 +22912,8 @@ type CreateDBInstanceReadReplicaInput struct { // Example: mydbsubnetgroup DBSubnetGroupName *string `type:"string"` - // A value that indicates whether the DB instance has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, + // Specifies whether to enable deletion protection for the DB instance. The + // database can't be deleted when deletion protection is enabled. By default, // deletion protection isn't enabled. For more information, see Deleting a DB // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` @@ -22914,7 +22928,7 @@ type CreateDBInstanceReadReplicaInput struct { // For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. Domain *string `type:"string"` // The ARN for the Secrets Manager secret with the credentials for the user @@ -22944,10 +22958,9 @@ type CreateDBInstanceReadReplicaInput struct { // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *string `type:"string"` - // The name of the IAM role to be used when making API calls to the Directory - // Service. + // The name of the IAM role to use when making API calls to the Directory Service. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. DomainIAMRoleName *string `type:"string"` // The Active Directory organizational unit for your DB instance to join. @@ -22966,11 +22979,11 @@ type CreateDBInstanceReadReplicaInput struct { // see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. EnableCloudwatchLogsExports []*string `type:"list"` - // A value that indicates whether to enable a customer-owned IP address (CoIP) - // for an RDS on Outposts read replica. + // Specifies whether to enable a customer-owned IP address (CoIP) for an RDS + // on Outposts read replica. // // A CoIP provides local or external connectivity to resources in your Outpost // subnets through your on-premises network. For some use cases, a CoIP can @@ -22985,28 +22998,27 @@ type CreateDBInstanceReadReplicaInput struct { // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool `type:"boolean"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. + // Specifies whether to enable mapping of Amazon Web Services Identity and Access + // Management (IAM) accounts to database accounts. By default, mapping isn't + // enabled. // // For more information about IAM database authentication, see IAM Database // Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to enable Performance Insights for the read - // replica. + // Specifies whether to enable Performance Insights for the read replica. // // For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. EnablePerformanceInsights *bool `type:"boolean"` - // The amount of Provisioned IOPS (input/output operations per second) to be - // initially allocated for the DB instance. + // The amount of Provisioned IOPS (input/output operations per second) to initially + // allocate for the DB instance. Iops *int64 `type:"integer"` // The Amazon Web Services KMS key identifier for an encrypted read replica. @@ -23042,15 +23054,17 @@ type CreateDBInstanceReadReplicaInput struct { MaxAllocatedStorage *int64 `type:"integer"` // The interval, in seconds, between points when Enhanced Monitoring metrics - // are collected for the read replica. To disable collecting Enhanced Monitoring + // are collected for the read replica. To disable collection of Enhanced Monitoring // metrics, specify 0. The default is 0. // - // If MonitoringRoleArn is specified, then you must also set MonitoringInterval - // to a value other than 0. + // If MonitoringRoleArn is specified, then you must set MonitoringInterval to + // a value other than 0. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. // // Valid Values: 0, 1, 5, 10, 15, 30, 60 + // + // Default: 0 MonitoringInterval *int64 `type:"integer"` // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics @@ -23062,22 +23076,22 @@ type CreateDBInstanceReadReplicaInput struct { // If MonitoringInterval is set to a value other than 0, then you must supply // a MonitoringRoleArn value. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. MonitoringRoleArn *string `type:"string"` - // A value that indicates whether the read replica is in a Multi-AZ deployment. + // Specifies whether the read replica is in a Multi-AZ deployment. // // You can create a read replica as a Multi-AZ DB instance. RDS creates a standby // of your replica in another Availability Zone for failover support for the // replica. Creating your read replica as a Multi-AZ DB instance is independent // of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. MultiAZ *bool `type:"boolean"` // The network type of the DB instance. // - // Valid values: + // Valid Values: // // * IPV4 // @@ -23091,12 +23105,12 @@ type CreateDBInstanceReadReplicaInput struct { // in the Amazon RDS User Guide. NetworkType *string `type:"string"` - // The option group the DB instance is associated with. If omitted, the option - // group associated with the source instance or cluster is used. + // The option group to associate the DB instance with. If not specified, RDS + // uses the option group associated with the source DB instance or cluster. // // For SQL Server, you must use the option group associated with the source. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. OptionGroupName *string `type:"string"` // The Amazon Web Services KMS key identifier for encryption of Performance @@ -23110,39 +23124,33 @@ type CreateDBInstanceReadReplicaInput struct { // Web Services account. Your Amazon Web Services account has a different default // KMS key for each Amazon Web Services Region. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. PerformanceInsightsKMSKeyId *string `type:"string"` - // The number of days to retain Performance Insights data. The default is 7 - // days. The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of months from 1-23 - // - // * 731 + // The number of days to retain Performance Insights data. // - // For example, the following values are valid: + // This setting doesn't apply to RDS Custom DB instances. // - // * 93 (3 months * 31) + // Valid Values: // - // * 341 (11 months * 31) + // * 7 // - // * 589 (19 months * 31) + // * month * 31, where month is a number of months from 1-23. Examples: 93 + // (3 months * 31), 341 (11 months * 31), 589 (19 months * 31) // // * 731 // - // If you specify a retention period such as 94, which isn't a valid value, - // RDS issues an error. + // Default: 7 days // - // This setting doesn't apply to RDS Custom. + // If you specify a retention period that isn't valid, such as 94, Amazon RDS + // returns an error. PerformanceInsightsRetentionPeriod *int64 `type:"integer"` // The port number that the DB instance uses for connections. // - // Default: Inherits from the source DB instance - // // Valid Values: 1150-65535 + // + // Default: Inherits the value from the source DB instance. Port *int64 `type:"integer"` // When you are creating a read replica from one Amazon Web Services GovCloud @@ -23208,16 +23216,16 @@ type CreateDBInstanceReadReplicaInput struct { // SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server // doesn't support cross-Region read replicas. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. PreSignedUrl *string `type:"string"` // The number of CPU cores and the number of threads per core for the DB instance // class of the DB instance. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that indicates whether the DB instance is publicly accessible. + // Specifies whether the DB instance is publicly accessible. // // When the DB cluster is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB cluster's @@ -23309,31 +23317,31 @@ type CreateDBInstanceReadReplicaInput struct { // Specifies the storage throughput value for the read replica. // - // This setting doesn't apply to RDS Custom or Amazon Aurora. + // This setting doesn't apply to RDS Custom or Amazon Aurora DB instances. StorageThroughput *int64 `type:"integer"` - // Specifies the storage type to be associated with the read replica. - // - // Valid values: gp2 | gp3 | io1 | standard + // The storage type to associate with the read replica. // // If you specify io1 or gp3, you must also include a value for the Iops parameter. // - // Default: io1 if the Iops parameter is specified, otherwise gp2 + // Valid Values: gp2 | gp3 | io1 | standard + // + // Default: io1 if the Iops parameter is specified. Otherwise, gp2. StorageType *string `type:"string"` // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) // in the Amazon RDS User Guide. Tags []*Tag `locationNameList:"Tag" type:"list"` - // A value that indicates whether the DB instance class of the DB instance uses - // its default processor features. + // Specifies whether the DB instance class of the DB instance uses its default + // processor features. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. UseDefaultProcessorFeatures *bool `type:"boolean"` // A list of Amazon EC2 VPC security groups to associate with the read replica. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. // // Default: The default EC2 VPC security group for the DB subnet group's VPC. VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"` @@ -23859,9 +23867,9 @@ type CreateDBProxyEndpointInput struct { // in the Amazon RDS User Guide. Tags []*Tag `locationNameList:"Tag" type:"list"` - // A value that indicates whether the DB proxy endpoint can be used for read/write - // or read-only operations. The default is READ_WRITE. The only role that proxies - // for RDS for Microsoft SQL Server support is READ_WRITE. + // The role of the DB proxy endpoint. The role determines whether the endpoint + // can be used for read/write or only read operations. The default is READ_WRITE. + // The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE. TargetRole *string `type:"string" enum:"DBProxyEndpointTargetRole"` // The VPC security group IDs for the DB proxy endpoint that you create. You @@ -24005,9 +24013,9 @@ type CreateDBProxyInput struct { // DBProxyName is a required field DBProxyName *string `type:"string" required:"true"` - // Whether the proxy includes detailed information about SQL statements in its - // logs. This information helps you to debug issues involving SQL behavior or - // the performance and scalability of the proxy connections. The debug information + // Specifies whether the proxy includes detailed information about SQL statements + // in its logs. This information helps you to debug issues involving SQL behavior + // or the performance and scalability of the proxy connections. The debug information // includes the text of SQL statements that you submit through the proxy. Thus, // only enable this setting when needed for debugging, and only when you have // security measures in place to safeguard any sensitive information that appears @@ -24029,9 +24037,9 @@ type CreateDBProxyInput struct { // connection timeout limit for the associated database. IdleClientTimeout *int64 `type:"integer"` - // A Boolean parameter that specifies whether Transport Layer Security (TLS) - // encryption is required for connections to the proxy. By enabling this setting, - // you can enforce encrypted TLS connections to the proxy. + // Specifies whether Transport Layer Security (TLS) encryption is required for + // connections to the proxy. By enabling this setting, you can enforce encrypted + // TLS connections to the proxy. RequireTLS *bool `type:"boolean"` // The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access @@ -24552,9 +24560,8 @@ func (s *CreateDBSubnetGroupOutput) SetDBSubnetGroup(v *DBSubnetGroup) *CreateDB type CreateEventSubscriptionInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to activate the subscription. If the event - // notification subscription isn't activated, the subscription is created but - // not active. + // Specifies whether to activate the subscription. If the event notification + // subscription isn't activated, the subscription is created but not active. Enabled *bool `type:"boolean"` // A list of event categories for a particular source type (SourceType) that @@ -24607,7 +24614,7 @@ type CreateEventSubscriptionInput struct { // to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't // specified, all events are returned. // - // Valid values: db-instance | db-cluster | db-parameter-group | db-security-group + // Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group // | db-snapshot | db-cluster-snapshot | db-proxy SourceType *string `type:"string"` @@ -25273,7 +25280,7 @@ type DBCluster struct { // The version of the database engine. EngineVersion *string `type:"string"` - // Specifies whether write forwarding is enabled for a secondary cluster in + // Indicates whether write forwarding is enabled for a secondary cluster in // an Aurora global database. Because write forwarding takes time to enable, // check the value of GlobalWriteForwardingStatus to confirm that the request // has completed before using the write forwarding feature for this cluster. @@ -25322,7 +25329,7 @@ type DBCluster struct { // The latest time to which a database can be restored with point-in-time restore. LatestRestorableTime *time.Time `type:"timestamp"` - // Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, + // Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, // not enabled, requested, or is in the process of enabling it. LocalWriteForwardingStatus *string `type:"string" enum:"LocalWriteForwardingStatus"` @@ -25996,8 +26003,8 @@ type DBClusterAutomatedBackup struct { // The version of the database engine for the automated backup. EngineVersion *string `type:"string"` - // True if mapping of Amazon Web Services Identity and Access Management (IAM) - // accounts to database accounts is enabled, and otherwise false. + // Indicates whether mapping of Amazon Web Services Identity and Access Management + // (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` // The IOPS (I/O operations per second) value for the automated backup. @@ -26035,7 +26042,7 @@ type DBClusterAutomatedBackup struct { // * retained - Automated backups for deleted clusters. Status *string `type:"string"` - // Specifies whether the source DB cluster is encrypted. + // Indicates whether the source DB cluster is encrypted. StorageEncrypted *bool `type:"boolean"` // The storage type associated with the DB cluster. @@ -26354,8 +26361,8 @@ type DBClusterMember struct { // Specifies the instance identifier for this member of the DB cluster. DBInstanceIdentifier *string `type:"string"` - // Value that is true if the cluster member is the primary instance for the - // DB cluster and false otherwise. + // Indicates whether the cluster member is the primary DB instance for the DB + // cluster. IsClusterWriter *bool `type:"boolean"` // A value that specifies the order in which an Aurora Replica is promoted to @@ -26624,45 +26631,44 @@ func (s *DBClusterRole) SetStatus(v string) *DBClusterRole { type DBClusterSnapshot struct { _ struct{} `type:"structure"` - // Specifies the allocated storage size in gibibytes (GiB). + // The allocated storage size of the DB cluster snapshot in gibibytes (GiB). AllocatedStorage *int64 `type:"integer"` - // Provides the list of Availability Zones (AZs) where instances in the DB cluster - // snapshot can be restored. + // The list of Availability Zones (AZs) where instances in the DB cluster snapshot + // can be restored. AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"` - // Specifies the time when the DB cluster was created, in Universal Coordinated - // Time (UTC). + // The time when the DB cluster was created, in Universal Coordinated Time (UTC). ClusterCreateTime *time.Time `type:"timestamp"` - // Specifies the DB cluster identifier of the DB cluster that this DB cluster - // snapshot was created from. + // The DB cluster identifier of the DB cluster that this DB cluster snapshot + // was created from. DBClusterIdentifier *string `type:"string"` - // Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot. + // The Amazon Resource Name (ARN) for the DB cluster snapshot. DBClusterSnapshotArn *string `type:"string"` - // Specifies the identifier for the DB cluster snapshot. + // The identifier for the DB cluster snapshot. DBClusterSnapshotIdentifier *string `type:"string"` // Reserved for future use. DBSystemId *string `type:"string"` - // Specifies the resource ID of the DB cluster that this DB cluster snapshot - // was created from. + // The resource ID of the DB cluster that this DB cluster snapshot was created + // from. DbClusterResourceId *string `type:"string"` - // Specifies the name of the database engine for this DB cluster snapshot. + // The name of the database engine for this DB cluster snapshot. Engine *string `type:"string"` - // Provides the engine mode of the database engine for this DB cluster snapshot. + // The engine mode of the database engine for this DB cluster snapshot. EngineMode *string `type:"string"` - // Provides the version of the database engine for this DB cluster snapshot. + // The version of the database engine for this DB cluster snapshot. EngineVersion *string `type:"string"` - // True if mapping of Amazon Web Services Identity and Access Management (IAM) - // accounts to database accounts is enabled, and otherwise false. + // Indicates whether mapping of Amazon Web Services Identity and Access Management + // (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` // If StorageEncrypted is true, the Amazon Web Services KMS key identifier for @@ -26672,24 +26678,22 @@ type DBClusterSnapshot struct { // ARN, or alias name for the KMS key. KmsKeyId *string `type:"string"` - // Provides the license model information for this DB cluster snapshot. + // The license model information for this DB cluster snapshot. LicenseModel *string `type:"string"` - // Provides the master username for this DB cluster snapshot. + // The master username for this DB cluster snapshot. MasterUsername *string `type:"string"` - // Specifies the percentage of the estimated data that has been transferred. + // The percentage of the estimated data that has been transferred. PercentProgress *int64 `type:"integer"` - // Specifies the port that the DB cluster was listening on at the time of the - // snapshot. + // The port that the DB cluster was listening on at the time of the snapshot. Port *int64 `type:"integer"` - // Provides the time when the snapshot was taken, in Universal Coordinated Time - // (UTC). + // The time when the snapshot was taken, in Universal Coordinated Time (UTC). SnapshotCreateTime *time.Time `type:"timestamp"` - // Provides the type of the DB cluster snapshot. + // The type of the DB cluster snapshot. SnapshotType *string `type:"string"` // If the DB cluster snapshot was copied from a source DB cluster snapshot, @@ -26697,8 +26701,7 @@ type DBClusterSnapshot struct { // a null value. SourceDBClusterSnapshotArn *string `type:"string"` - // Specifies the status of this DB cluster snapshot. Valid statuses are the - // following: + // The status of this DB cluster snapshot. Valid statuses are the following: // // * available // @@ -26707,7 +26710,7 @@ type DBClusterSnapshot struct { // * creating Status *string `type:"string"` - // Specifies whether the DB cluster snapshot is encrypted. + // Indicates whether the DB cluster snapshot is encrypted. StorageEncrypted *bool `type:"boolean"` // The storage type associated with the DB cluster snapshot. @@ -26719,7 +26722,7 @@ type DBClusterSnapshot struct { // in the Amazon RDS User Guide. TagList []*Tag `locationNameList:"Tag" type:"list"` - // Provides the VPC ID associated with the DB cluster snapshot. + // The VPC ID associated with the DB cluster snapshot. VpcId *string `type:"string"` } @@ -27101,31 +27104,30 @@ type DBEngineVersion struct { // of the CreateDBInstance action. SupportedTimezones []*Timezone `locationNameList:"Timezone" type:"list"` - // A value that indicates whether the engine version supports Babelfish for - // Aurora PostgreSQL. + // Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. SupportsBabelfish *bool `type:"boolean"` - // A value that indicates whether the engine version supports rotating the server - // certificate without rebooting the DB instance. + // Indicates whether the engine version supports rotating the server certificate + // without rebooting the DB instance. SupportsCertificateRotationWithoutRestart *bool `type:"boolean"` - // A value that indicates whether you can use Aurora global databases with a - // specific DB engine version. + // Indicates whether you can use Aurora global databases with a specific DB + // engine version. SupportsGlobalDatabases *bool `type:"boolean"` - // A value that indicates whether the DB engine version supports forwarding - // write operations from reader DB instances to the writer DB instance in the - // DB cluster. By default, write operations aren't allowed on reader DB instances. + // Indicates whether the DB engine version supports forwarding write operations + // from reader DB instances to the writer DB instance in the DB cluster. By + // default, write operations aren't allowed on reader DB instances. // // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool `type:"boolean"` - // A value that indicates whether the engine version supports exporting the - // log types specified by ExportableLogTypes to CloudWatch Logs. + // Indicates whether the engine version supports exporting the log types specified + // by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs *bool `type:"boolean"` - // A value that indicates whether you can use Aurora parallel query with a specific - // DB engine version. + // Indicates whether you can use Aurora parallel query with a specific DB engine + // version. SupportsParallelQuery *bool `type:"boolean"` // Indicates whether the database engine version supports read replicas. @@ -28286,7 +28288,7 @@ func (s *DBInstance) SetVpcSecurityGroups(v []*VpcSecurityGroupMembership) *DBIn type DBInstanceAutomatedBackup struct { _ struct{} `type:"structure"` - // Specifies the allocated storage size in gibibytes (GiB). + // The allocated storage size for the the automated backup in gibibytes (GiB). AllocatedStorage *int64 `type:"integer"` // The Availability Zone that the automated backup was created in. For information @@ -28301,7 +28303,7 @@ type DBInstanceAutomatedBackup struct { // The retention period for the automated backups. BackupRetentionPeriod *int64 `type:"integer"` - // Specifies where automated backups are stored: Amazon Web Services Outposts + // The location where automated backups are stored: Amazon Web Services Outposts // or the Amazon Web Services Region. BackupTarget *string `type:"string"` @@ -28323,7 +28325,7 @@ type DBInstanceAutomatedBackup struct { // is unique to an Amazon Web Services Region. DbiResourceId *string `type:"string"` - // Specifies whether the automated backup is encrypted. + // Indicates whether the automated backup is encrypted. Encrypted *bool `type:"boolean"` // The name of the database engine for this automated backup. @@ -28336,7 +28338,7 @@ type DBInstanceAutomatedBackup struct { // accounts to database accounts is enabled, and otherwise false. IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` - // Provides the date and time that the DB instance was created. + // The date and time when the DB instance was created. InstanceCreateTime *time.Time `type:"timestamp"` // The IOPS (I/O operations per second) value for the automated backup. @@ -28348,7 +28350,7 @@ type DBInstanceAutomatedBackup struct { // ARN, or alias name for the KMS key. KmsKeyId *string `type:"string"` - // License model information for the automated backup. + // The license model information for the automated backup. LicenseModel *string `type:"string"` // The master user name of an automated backup. @@ -28368,10 +28370,10 @@ type DBInstanceAutomatedBackup struct { // The Amazon Web Services Region associated with the automated backup. Region *string `type:"string"` - // Earliest and latest time an instance can be restored to. + // The earliest and latest time a DB instance can be restored to. RestoreWindow *RestoreWindow `type:"structure"` - // Provides a list of status information for an automated backup: + // A list of status information for an automated backup: // // * active - Automated backups for current instances. // @@ -28381,10 +28383,10 @@ type DBInstanceAutomatedBackup struct { // snapshot to be available. Status *string `type:"string"` - // Specifies the storage throughput for the automated backup. + // The storage throughput for the automated backup. StorageThroughput *int64 `type:"integer"` - // Specifies the storage type associated with the automated backup. + // The storage type associated with the automated backup. StorageType *string `type:"string"` // The ARN from the key store with which the automated backup is associated @@ -28396,7 +28398,7 @@ type DBInstanceAutomatedBackup struct { // that were created with a time zone specified. Timezone *string `type:"string"` - // Provides the VPC ID associated with the DB instance. + // The VPC ID associated with the DB instance. VpcId *string `type:"string"` } @@ -28626,8 +28628,8 @@ func (s *DBInstanceAutomatedBackupsReplication) SetDBInstanceAutomatedBackupsArn return s } -// Describes an Amazon Web Services Identity and Access Management (IAM) role -// that is associated with a DB instance. +// Information about an Amazon Web Services Identity and Access Management (IAM) +// role that is associated with a DB instance. type DBInstanceRole struct { _ struct{} `type:"structure"` @@ -28640,8 +28642,8 @@ type DBInstanceRole struct { // DB instance. RoleArn *string `type:"string"` - // Describes the state of association between the IAM role and the DB instance. - // The Status property returns one of the following values: + // Information about the state of association between the IAM role and the DB + // instance. The Status property returns one of the following values: // // * ACTIVE - the IAM role ARN is associated with the DB instance and can // be used to access other Amazon Web Services services on your behalf. @@ -28698,12 +28700,12 @@ type DBInstanceStatusInfo struct { // isn't in an error state, this value is blank. Message *string `type:"string"` - // Boolean value that is true if the instance is operating normally, or false + // A Boolean value that is true if the instance is operating normally, or false // if the instance is in an error state. Normal *bool `type:"boolean"` - // Status of the DB instance. For a StatusType of read replica, the values can - // be replicating, replication stop point set, replication stop point reached, + // The status of the DB instance. For a StatusType of read replica, the values + // can be replicating, replication stop point set, replication stop point reached, // error, stopped, or terminated. Status *string `type:"string"` @@ -28925,9 +28927,9 @@ type DBProxy struct { // Region. DBProxyName *string `type:"string"` - // Whether the proxy includes detailed information about SQL statements in its - // logs. This information helps you to debug issues involving SQL behavior or - // the performance and scalability of the proxy connections. The debug information + // Indicates whether the proxy includes detailed information about SQL statements + // in its logs. This information helps you to debug issues involving SQL behavior + // or the performance and scalability of the proxy connections. The debug information // includes the text of SQL statements that you submit through the proxy. Thus, // only enable this setting when needed for debugging, and only when you have // security measures in place to safeguard any sensitive information that appears @@ -29119,10 +29121,10 @@ type DBProxyEndpoint struct { // endpoint value in the connection string for a database client application. Endpoint *string `type:"string"` - // A value that indicates whether this endpoint is the default endpoint for - // the associated DB proxy. Default DB proxy endpoints always have read/write - // capability. Other endpoints that you associate with the DB proxy can be either - // read/write or read-only. + // Indicates whether this endpoint is the default endpoint for the associated + // DB proxy. Default DB proxy endpoints always have read/write capability. Other + // endpoints that you associate with the DB proxy can be either read/write or + // read-only. IsDefault *bool `type:"boolean"` // The current status of this DB proxy endpoint. A status of available means @@ -29354,9 +29356,9 @@ type DBProxyTargetGroup struct { // The identifier for the RDS proxy associated with this target group. DBProxyName *string `type:"string"` - // Whether this target group is the first one used for connection requests by - // the associated proxy. Because each proxy is currently associated with a single - // target group, currently this setting is always true. + // Indicates whether this target group is the first one used for connection + // requests by the associated proxy. Because each proxy is currently associated + // with a single target group, currently this setting is always true. IsDefault *bool `type:"boolean"` // The current status of this target group. A status of available means the @@ -29614,7 +29616,7 @@ type DBSnapshot struct { // is unique to an Amazon Web Services Region. DbiResourceId *string `type:"string"` - // Specifies whether the DB snapshot is encrypted. + // Indicates whether the DB snapshot is encrypted. Encrypted *bool `type:"boolean"` // Specifies the name of the database engine. @@ -29623,8 +29625,8 @@ type DBSnapshot struct { // Specifies the version of the database engine. EngineVersion *string `type:"string"` - // True if mapping of Amazon Web Services Identity and Access Management (IAM) - // accounts to database accounts is enabled, and otherwise false. + // Indicates whether mapping of Amazon Web Services Identity and Access Management + // (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` // Specifies the time in Coordinated Universal Time (UTC) when the DB instance, @@ -30425,31 +30427,30 @@ type DeleteCustomDBEngineVersionOutput struct { // of the CreateDBInstance action. SupportedTimezones []*Timezone `locationNameList:"Timezone" type:"list"` - // A value that indicates whether the engine version supports Babelfish for - // Aurora PostgreSQL. + // Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. SupportsBabelfish *bool `type:"boolean"` - // A value that indicates whether the engine version supports rotating the server - // certificate without rebooting the DB instance. + // Indicates whether the engine version supports rotating the server certificate + // without rebooting the DB instance. SupportsCertificateRotationWithoutRestart *bool `type:"boolean"` - // A value that indicates whether you can use Aurora global databases with a - // specific DB engine version. + // Indicates whether you can use Aurora global databases with a specific DB + // engine version. SupportsGlobalDatabases *bool `type:"boolean"` - // A value that indicates whether the DB engine version supports forwarding - // write operations from reader DB instances to the writer DB instance in the - // DB cluster. By default, write operations aren't allowed on reader DB instances. + // Indicates whether the DB engine version supports forwarding write operations + // from reader DB instances to the writer DB instance in the DB cluster. By + // default, write operations aren't allowed on reader DB instances. // // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool `type:"boolean"` - // A value that indicates whether the engine version supports exporting the - // log types specified by ExportableLogTypes to CloudWatch Logs. + // Indicates whether the engine version supports exporting the log types specified + // by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs *bool `type:"boolean"` - // A value that indicates whether you can use Aurora parallel query with a specific - // DB engine version. + // Indicates whether you can use Aurora parallel query with a specific DB engine + // version. SupportsParallelQuery *bool `type:"boolean"` // Indicates whether the database engine version supports read replicas. @@ -30948,9 +30949,9 @@ type DeleteDBClusterInput struct { // DBClusterIdentifier is a required field DBClusterIdentifier *string `type:"string" required:"true"` - // A value that indicates whether to remove automated backups immediately after - // the DB cluster is deleted. This parameter isn't case-sensitive. The default - // is to remove automated backups immediately after the DB cluster is deleted. + // Specifies whether to remove automated backups immediately after the DB cluster + // is deleted. This parameter isn't case-sensitive. The default is to remove + // automated backups immediately after the DB cluster is deleted. DeleteAutomatedBackups *bool `type:"boolean"` // The DB cluster snapshot identifier of the new DB cluster snapshot created @@ -30968,11 +30969,11 @@ type DeleteDBClusterInput struct { // * Can't end with a hyphen or contain two consecutive hyphens FinalDBSnapshotIdentifier *string `type:"string"` - // A value that indicates whether to skip the creation of a final DB cluster - // snapshot before the DB cluster is deleted. If skip is specified, no DB cluster - // snapshot is created. If skip isn't specified, a DB cluster snapshot is created - // before the DB cluster is deleted. By default, skip isn't specified, and the - // DB cluster snapshot is created. By default, this parameter is disabled. + // Specifies whether to skip the creation of a final DB cluster snapshot before + // the DB cluster is deleted. If skip is specified, no DB cluster snapshot is + // created. If skip isn't specified, a DB cluster snapshot is created before + // the DB cluster is deleted. By default, skip isn't specified, and the DB cluster + // snapshot is created. By default, this parameter is disabled. // // You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot // is disabled. @@ -31332,9 +31333,9 @@ type DeleteDBInstanceInput struct { // DBInstanceIdentifier is a required field DBInstanceIdentifier *string `type:"string" required:"true"` - // A value that indicates whether to remove automated backups immediately after - // the DB instance is deleted. This parameter isn't case-sensitive. The default - // is to remove automated backups immediately after the DB instance is deleted. + // Specifies whether to remove automated backups immediately after the DB instance + // is deleted. This parameter isn't case-sensitive. The default is to remove + // automated backups immediately after the DB instance is deleted. DeleteAutomatedBackups *bool `type:"boolean"` // The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot @@ -31356,11 +31357,11 @@ type DeleteDBInstanceInput struct { // * Can't be specified when deleting a read replica. FinalDBSnapshotIdentifier *string `type:"string"` - // A value that indicates whether to skip the creation of a final DB snapshot - // before deleting the instance. If you enable this parameter, RDS doesn't create - // a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot - // before the DB instance is deleted. By default, skip isn't enabled, and the - // DB snapshot is created. + // Specifies whether to skip the creation of a final DB snapshot before deleting + // the instance. If you enable this parameter, RDS doesn't create a DB snapshot. + // If you don't enable this parameter, RDS creates a DB snapshot before the + // DB instance is deleted. By default, skip isn't enabled, and the DB snapshot + // is created. // // If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier // parameter. @@ -33254,8 +33255,15 @@ type DescribeDBClusterParametersInput struct { // Constraints: Minimum 20, maximum 100. MaxRecords *int64 `type:"integer"` - // A value that indicates to return only parameters for a specific source. Parameter - // sources can be engine, service, or customer. + // A specific source to return parameters for. + // + // Valid Values: + // + // * customer + // + // * engine + // + // * service Source *string `type:"string"` } @@ -33497,18 +33505,18 @@ type DescribeDBClusterSnapshotsInput struct { // * engine - Accepts names of database engines. Filters []*Filter `locationNameList:"Filter" type:"list"` - // A value that indicates whether to include manual DB cluster snapshots that - // are public and can be copied or restored by any Amazon Web Services account. - // By default, the public snapshots are not included. + // Specifies whether to include manual DB cluster snapshots that are public + // and can be copied or restored by any Amazon Web Services account. By default, + // the public snapshots are not included. // // You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute // API action. IncludePublic *bool `type:"boolean"` - // A value that indicates whether to include shared manual DB cluster snapshots - // from other Amazon Web Services accounts that this Amazon Web Services account - // has been given permission to copy or restore. By default, these snapshots - // are not included. + // Specifies whether to include shared manual DB cluster snapshots from other + // Amazon Web Services accounts that this Amazon Web Services account has been + // given permission to copy or restore. By default, these snapshots are not + // included. // // You can give an Amazon Web Services account permission to restore a manual // DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute @@ -33863,14 +33871,14 @@ type DescribeDBEngineVersionsInput struct { // // Constraints: // - // * If supplied, must match an existing DBParameterGroupFamily. + // * If supplied, must match an existing DB parameter group family. DBParameterGroupFamily *string `type:"string"` - // A value that indicates whether only the default version of the specified - // engine or engine and major version combination is returned. + // Specifies whether to return only the default version of the specified engine + // or the engine and major version combination. DefaultOnly *bool `type:"boolean"` - // The database engine to return. + // The database engine to return version details for. // // Valid Values: // @@ -33903,7 +33911,7 @@ type DescribeDBEngineVersionsInput struct { // * sqlserver-web Engine *string `type:"string"` - // The database engine version to return. + // A specific database engine version to return details for. // // Example: 5.1.49 EngineVersion *string `type:"string"` @@ -33932,30 +33940,28 @@ type DescribeDBEngineVersionsInput struct { // are the following: available deprecated Filters []*Filter `locationNameList:"Filter" type:"list"` - // A value that indicates whether to include engine versions that aren't available - // in the list. The default is to list only available engine versions. + // Specifies whether to also list the engine versions that aren't available. + // The default is to list only available engine versions. IncludeAll *bool `type:"boolean"` - // A value that indicates whether to list the supported character sets for each - // engine version. + // Specifies whether to list the supported character sets for each engine version. // // If this parameter is enabled and the requested engine supports the CharacterSetName // parameter for CreateDBInstance, the response includes a list of supported // character sets for each engine version. // // For RDS Custom, the default is not to list supported character sets. If you - // set ListSupportedCharacterSets to true, RDS Custom returns no results. + // enable this parameter, RDS Custom returns no results. ListSupportedCharacterSets *bool `type:"boolean"` - // A value that indicates whether to list the supported time zones for each - // engine version. + // Specifies whether to list the supported time zones for each engine version. // // If this parameter is enabled and the requested engine supports the TimeZone // parameter for CreateDBInstance, the response includes a list of supported // time zones for each engine version. // - // For RDS Custom, the default is not to list supported time zones. If you set - // ListSupportedTimezones to true, RDS Custom returns no results. + // For RDS Custom, the default is not to list supported time zones. If you enable + // this parameter, RDS Custom returns no results. ListSupportedTimezones *bool `type:"boolean"` // An optional pagination token provided by a previous request. If this parameter @@ -35766,9 +35772,9 @@ type DescribeDBSnapshotsInput struct { // * engine - Accepts names of database engines. Filters []*Filter `locationNameList:"Filter" type:"list"` - // A value that indicates whether to include manual DB cluster snapshots that - // are public and can be copied or restored by any Amazon Web Services account. - // By default, the public snapshots are not included. + // Specifies whether to include manual DB cluster snapshots that are public + // and can be copied or restored by any Amazon Web Services account. By default, + // the public snapshots are not included. // // You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute // API. @@ -35776,10 +35782,10 @@ type DescribeDBSnapshotsInput struct { // This setting doesn't apply to RDS Custom. IncludePublic *bool `type:"boolean"` - // A value that indicates whether to include shared manual DB cluster snapshots - // from other Amazon Web Services accounts that this Amazon Web Services account - // has been given permission to copy or restore. By default, these snapshots - // are not included. + // Specifies whether to include shared manual DB cluster snapshots from other + // Amazon Web Services accounts that this Amazon Web Services account has been + // given permission to copy or restore. By default, these snapshots are not + // included. // // You can give an Amazon Web Services account permission to restore a manual // DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute @@ -36450,7 +36456,7 @@ type DescribeEventCategoriesInput struct { // The type of source that is generating the events. For RDS Proxy events, specify // db-proxy. // - // Valid values: db-instance | db-cluster | db-parameter-group | db-security-group + // Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group // | db-snapshot | db-cluster-snapshot | db-proxy SourceType *string `type:"string"` } @@ -37599,8 +37605,8 @@ type DescribeOrderableDBInstanceOptionsInput struct { // Constraints: Minimum 20, maximum 10000. MaxRecords *int64 `type:"integer"` - // A value that indicates whether to show only VPC or non-VPC offerings. RDS - // Custom supports only VPC offerings. + // Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports + // only VPC offerings. // // RDS Custom supports only VPC offerings. If you describe non-VPC offerings // for RDS Custom, the output shows VPC offerings. @@ -37924,8 +37930,7 @@ type DescribeReservedDBInstancesInput struct { // Constraints: Minimum 20, maximum 100. MaxRecords *int64 `type:"integer"` - // A value that indicates whether to show only those reservations that support - // Multi-AZ. + // Specifies whether to show only those reservations that support Multi-AZ. MultiAZ *bool `type:"boolean"` // The offering type filter value. Specify this parameter to show only the available @@ -38081,8 +38086,7 @@ type DescribeReservedDBInstancesOfferingsInput struct { // Constraints: Minimum 20, maximum 100. MaxRecords *int64 `type:"integer"` - // A value that indicates whether to show only those reservations that support - // Multi-AZ. + // Specifies whether to show only those reservations that support Multi-AZ. MultiAZ *bool `type:"boolean"` // The offering type filter value. Specify this parameter to show only the available @@ -38740,7 +38744,7 @@ func (s *DownloadDBLogFilePortionInput) SetNumberOfLines(v int64) *DownloadDBLog type DownloadDBLogFilePortionOutput struct { _ struct{} `type:"structure"` - // Boolean value that if true, indicates there is more data to be downloaded. + // A Boolean value that, if true, indicates there is more data to be downloaded. AdditionalDataPending *bool `type:"boolean"` // Entries from the specified log file. @@ -39216,11 +39220,13 @@ func (s *EventSubscription) SetSubscriptionCreationTime(v string) *EventSubscrip // Contains the details of a snapshot or cluster export to Amazon S3. // -// This data type is used as a response element in the DescribeExportTasks action. +// This data type is used as a response element in the DescribeExportTasks operation. type ExportTask struct { _ struct{} `type:"structure"` - // The data exported from the snapshot or cluster. Valid values are the following: + // The data exported from the snapshot or cluster. + // + // Valid Values: // // * database - Export all the data from a specified database. // @@ -39256,14 +39262,14 @@ type ExportTask struct { // The progress of the snapshot or cluster export task as a percentage. PercentProgress *int64 `type:"integer"` - // The Amazon S3 bucket that the snapshot or cluster is exported to. + // The Amazon S3 bucket where the snapshot or cluster is exported to. S3Bucket *string `type:"string"` // The Amazon S3 bucket prefix that is the file name and path of the exported // data. S3Prefix *string `type:"string"` - // The time that the snapshot was created. + // The time when the snapshot was created. SnapshotTime *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon @@ -39288,10 +39294,10 @@ type ExportTask struct { // * STARTING Status *string `type:"string"` - // The time that the snapshot or cluster export task ended. + // The time when the snapshot or cluster export task ended. TaskEndTime *time.Time `type:"timestamp"` - // The time that the snapshot or cluster export task started. + // The time when the snapshot or cluster export task started. TaskStartTime *time.Time `type:"timestamp"` // The total amount of data exported, in gigabytes. @@ -39418,11 +39424,12 @@ func (s *ExportTask) SetWarningMessage(v string) *ExportTask { type FailoverDBClusterInput struct { _ struct{} `type:"structure"` - // A DB cluster identifier to force a failover for. This parameter isn't case-sensitive. + // The identifier of the DB cluster to force a failover for. This parameter + // isn't case-sensitive. // // Constraints: // - // * Must match the identifier of an existing DBCluster. + // * Must match the identifier of an existing DB cluster. // // DBClusterIdentifier is a required field DBClusterIdentifier *string `type:"string" required:"true"` @@ -39957,11 +39964,10 @@ type GlobalClusterMember struct { // The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster. DBClusterArn *string `type:"string"` - // Specifies whether a secondary cluster in the global cluster has write forwarding - // enabled, not enabled, or is in the process of enabling it. + // The status of write forwarding for a secondary cluster in the global cluster. GlobalWriteForwardingStatus *string `type:"string" enum:"WriteForwardingStatus"` - // Specifies whether the Aurora DB cluster is the primary cluster (that is, + // Indicates whether the Aurora DB cluster is the primary cluster (that is, // has read-write capability) for the global cluster with which it is associated. IsWriter *bool `type:"boolean"` @@ -40026,11 +40032,11 @@ func (s *GlobalClusterMember) SetSynchronizationStatus(v string) *GlobalClusterM type IPRange struct { _ struct{} `type:"structure"` - // Specifies the IP range. + // The IP range. CIDRIP *string `type:"string"` - // Specifies the status of the IP range. Status can be "authorizing", "authorized", - // "revoking", and "revoked". + // The status of the IP range. Status can be "authorizing", "authorized", "revoking", + // and "revoked". Status *string `type:"string"` } @@ -40411,8 +40417,8 @@ type ModifyCertificatesInput struct { // or the DescribeCertificates API operation. CertificateIdentifier *string `type:"string"` - // A value that indicates whether to remove the override for the default certificate. - // If the override is removed, the default certificate is the system default. + // Specifies whether to remove the override for the default certificate. If + // the override is removed, the default certificate is the system default. RemoveCustomerOverride *bool `type:"boolean"` } @@ -40866,31 +40872,30 @@ type ModifyCustomDBEngineVersionOutput struct { // of the CreateDBInstance action. SupportedTimezones []*Timezone `locationNameList:"Timezone" type:"list"` - // A value that indicates whether the engine version supports Babelfish for - // Aurora PostgreSQL. + // Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. SupportsBabelfish *bool `type:"boolean"` - // A value that indicates whether the engine version supports rotating the server - // certificate without rebooting the DB instance. + // Indicates whether the engine version supports rotating the server certificate + // without rebooting the DB instance. SupportsCertificateRotationWithoutRestart *bool `type:"boolean"` - // A value that indicates whether you can use Aurora global databases with a - // specific DB engine version. + // Indicates whether you can use Aurora global databases with a specific DB + // engine version. SupportsGlobalDatabases *bool `type:"boolean"` - // A value that indicates whether the DB engine version supports forwarding - // write operations from reader DB instances to the writer DB instance in the - // DB cluster. By default, write operations aren't allowed on reader DB instances. + // Indicates whether the DB engine version supports forwarding write operations + // from reader DB instances to the writer DB instance in the DB cluster. By + // default, write operations aren't allowed on reader DB instances. // // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool `type:"boolean"` - // A value that indicates whether the engine version supports exporting the - // log types specified by ExportableLogTypes to CloudWatch Logs. + // Indicates whether the engine version supports exporting the log types specified + // by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs *bool `type:"boolean"` - // A value that indicates whether you can use Aurora parallel query with a specific - // DB engine version. + // Indicates whether you can use Aurora parallel query with a specific DB engine + // version. SupportsParallelQuery *bool `type:"boolean"` // Indicates whether the database engine version supports read replicas. @@ -44563,7 +44568,7 @@ func (s *ModifyDBSubnetGroupOutput) SetDBSubnetGroup(v *DBSubnetGroup) *ModifyDB type ModifyEventSubscriptionInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to activate the subscription. + // Specifies whether to activate the subscription. Enabled *bool `type:"boolean"` // A list of event categories for a source type (SourceType) that you want to @@ -44582,7 +44587,7 @@ type ModifyEventSubscriptionInput struct { // to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't // specified, all events are returned. // - // Valid values: db-instance | db-cluster | db-parameter-group | db-security-group + // Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group // | db-snapshot | db-cluster-snapshot | db-proxy SourceType *string `type:"string"` @@ -44824,9 +44829,8 @@ func (s *ModifyGlobalClusterOutput) SetGlobalCluster(v *GlobalCluster) *ModifyGl type ModifyOptionGroupInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to apply the change immediately or during - // the next maintenance window for each instance associated with the option - // group. + // Specifies whether to apply the change immediately or during the next maintenance + // window for each instance associated with the option group. ApplyImmediately *bool `type:"boolean"` // The name of the option group to be modified. @@ -44941,7 +44945,7 @@ func (s *ModifyOptionGroupOutput) SetOptionGroup(v *OptionGroup) *ModifyOptionGr return s } -// Option details. +// The details of an option. type Option struct { _ struct{} `type:"structure"` @@ -44961,10 +44965,10 @@ type Option struct { // The version of the option. OptionVersion *string `type:"string"` - // Indicate if this option is permanent. + // Indicates whether this option is permanent. Permanent *bool `type:"boolean"` - // Indicate if this option is persistent. + // Indicates whether this option is persistent. Persistent *bool `type:"boolean"` // If required, the port configured for this option to use. @@ -45314,7 +45318,7 @@ func (s *OptionGroupMembership) SetStatus(v string) *OptionGroupMembership { type OptionGroupOption struct { _ struct{} `type:"structure"` - // Specifies whether the option can be copied across Amazon Web Services accounts. + // Indicates whether the option can be copied across Amazon Web Services accounts. CopyableCrossAccount *bool `type:"boolean"` // If the option requires a port, specifies the default port for the option. @@ -45358,7 +45362,7 @@ type OptionGroupOption struct { // group. Persistent *bool `type:"boolean"` - // Specifies whether the option requires a port. + // Indicates whether the option requires a port. PortRequired *bool `type:"boolean"` // If true, you must enable the Auto Minor Version Upgrade setting for your @@ -45510,12 +45514,12 @@ type OptionGroupOptionSetting struct { // The default value for the option group option. DefaultValue *string `type:"string"` - // Boolean value where true indicates that this option group option can be changed - // from the default value. + // Indicates whether this option group option can be changed from the default + // value. IsModifiable *bool `type:"boolean"` - // Boolean value where true indicates that a value must be specified for this - // option setting of the option group option. + // Indicates whether a value must be specified for this option setting of the + // option group option. IsRequired *bool `type:"boolean"` // The minimum DB engine version required for the corresponding allowed value @@ -45617,11 +45621,10 @@ type OptionSetting struct { // The description of the option setting. Description *string `type:"string"` - // Indicates if the option setting is part of a collection. + // Indicates whether the option setting is part of a collection. IsCollection *bool `type:"boolean"` - // A Boolean value that, when true, indicates the option setting can be modified - // from the default. + // Indicates whether the option setting can be modified from the default. IsModifiable *bool `type:"boolean"` // The name of the option that has settings that you can set. @@ -45708,7 +45711,7 @@ func (s *OptionSetting) SetValue(v string) *OptionSetting { type OptionVersion struct { _ struct{} `type:"structure"` - // True if the version is the default version of the option, and otherwise false. + // Indicates whether the version is the default version of the option. IsDefault *bool `type:"boolean"` // The version of the option. @@ -45807,7 +45810,7 @@ type OrderableDBInstanceOption struct { // Indicates whether a DB instance is Multi-AZ capable. MultiAZCapable *bool `type:"boolean"` - // Whether a DB instance supports RDS on Outposts. + // Indicates whether a DB instance supports RDS on Outposts. // // For more information about RDS on Outposts, see Amazon RDS on Amazon Web // Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) @@ -45817,7 +45820,7 @@ type OrderableDBInstanceOption struct { // Indicates whether a DB instance can have a read replica. ReadReplicaCapable *bool `type:"boolean"` - // Indicates the storage type for a DB instance. + // The storage type for a DB instance. StorageType *string `type:"string"` // The list of supported modes for Database Activity Streams. Aurora PostgreSQL @@ -45838,7 +45841,7 @@ type OrderableDBInstanceOption struct { // in the Amazon RDS User Guide. SupportedNetworkTypes []*string `type:"list"` - // Whether DB instances can be configured as a Multi-AZ DB cluster. + // Indicates whether DB instances can be configured as a Multi-AZ DB cluster. // // For more information on Multi-AZ DB clusters, see Multi-AZ deployments with // two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) @@ -45849,8 +45852,8 @@ type OrderableDBInstanceOption struct { // from 1 to 60 seconds. SupportsEnhancedMonitoring *bool `type:"boolean"` - // A value that indicates whether you can use Aurora global databases with a - // specific combination of other DB engine attributes. + // Indicates whether you can use Aurora global databases with a specific combination + // of other DB engine attributes. SupportsGlobalDatabases *bool `type:"boolean"` // Indicates whether a DB instance supports IAM database authentication. @@ -45859,14 +45862,14 @@ type OrderableDBInstanceOption struct { // Indicates whether a DB instance supports provisioned IOPS. SupportsIops *bool `type:"boolean"` - // Whether a DB instance supports Kerberos Authentication. + // Indicates whether a DB instance supports Kerberos Authentication. SupportsKerberosAuthentication *bool `type:"boolean"` - // True if a DB instance supports Performance Insights, otherwise false. + // Indicates whether a DB instance supports Performance Insights. SupportsPerformanceInsights *bool `type:"boolean"` - // Whether Amazon RDS can automatically scale storage for DB instances that - // use the specified DB instance class. + // Indicates whether Amazon RDS can automatically scale storage for DB instances + // that use the specified DB instance class. SupportsStorageAutoscaling *bool `type:"boolean"` // Indicates whether a DB instance supports encrypted storage. @@ -46174,13 +46177,13 @@ type Parameter struct { // The earliest engine version to which the parameter can apply. MinimumEngineVersion *string `type:"string"` - // Specifies the name of the parameter. + // The name of the parameter. ParameterName *string `type:"string"` - // Specifies the value of the parameter. + // The value of the parameter. ParameterValue *string `type:"string"` - // Indicates the source of the parameter value. + // The source of the parameter value. Source *string `type:"string"` // The valid DB engine modes. @@ -46444,8 +46447,8 @@ type PendingModifiedValues struct { // The database engine version. EngineVersion *string `type:"string"` - // Whether mapping of Amazon Web Services Identity and Access Management (IAM) - // accounts to database accounts is enabled. + // Indicates whether mapping of Amazon Web Services Identity and Access Management + // (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` // The Provisioned IOPS value for the DB instance. @@ -46459,8 +46462,7 @@ type PendingModifiedValues struct { // The master credentials for the DB instance. MasterUserPassword *string `type:"string"` - // A value that indicates that the Single-AZ DB instance will change to a Multi-AZ - // deployment. + // Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment. MultiAZ *bool `type:"boolean"` // A list of the log types whose configuration is still pending. In other words, @@ -47217,8 +47219,7 @@ type RebootDBInstanceInput struct { // DBInstanceIdentifier is a required field DBInstanceIdentifier *string `type:"string" required:"true"` - // A value that indicates whether the reboot is conducted through a Multi-AZ - // failover. + // Specifies whether the reboot is conducted through a Multi-AZ failover. // // Constraint: You can't enable force failover if the instance isn't configured // for Multi-AZ. @@ -47919,7 +47920,7 @@ type ReservedDBInstance struct { // to a reserved DB instance. LeaseId *string `type:"string"` - // Indicates if the reservation applies to Multi-AZ deployments. + // Indicates whether the reservation applies to Multi-AZ deployments. MultiAZ *bool `type:"boolean"` // The offering type of this reserved DB instance. @@ -48081,7 +48082,7 @@ type ReservedDBInstancesOffering struct { // The fixed price charged for this offering. FixedPrice *float64 `type:"double"` - // Indicates if the offering applies to Multi-AZ deployments. + // Indicates whether the offering applies to Multi-AZ deployments. MultiAZ *bool `type:"boolean"` // The offering type. @@ -48191,9 +48192,9 @@ type ResetDBClusterParameterGroupInput struct { // is enabled. Parameters []*Parameter `locationNameList:"Parameter" type:"list"` - // A value that indicates whether to reset all parameters in the DB cluster - // parameter group to their default values. You can't use this parameter if - // there is a list of parameter names specified for the Parameters parameter. + // Specifies whether to reset all parameters in the DB cluster parameter group + // to their default values. You can't use this parameter if there is a list + // of parameter names specified for the Parameters parameter. ResetAllParameters *bool `type:"boolean"` } @@ -48284,9 +48285,9 @@ type ResetDBParameterGroupInput struct { // Valid Values (for Apply method): pending-reboot Parameters []*Parameter `locationNameList:"Parameter" type:"list"` - // A value that indicates whether to reset all parameters in the DB parameter - // group to default values. By default, all parameters in the DB parameter group - // are reset to default values. + // Specifies whether to reset all parameters in the DB parameter group to default + // values. By default, all parameters in the DB parameter group are reset to + // default values. ResetAllParameters *bool `type:"boolean"` } @@ -48415,8 +48416,8 @@ type RestoreDBClusterFromS3Input struct { // with the specified CharacterSet. CharacterSetName *string `type:"string"` - // A value that indicates whether to copy all tags from the restored DB cluster - // to snapshots of the restored DB cluster. The default is not to copy them. + // Specifies whether to copy all tags from the restored DB cluster to snapshots + // of the restored DB cluster. The default is not to copy them. CopyTagsToSnapshot *bool `type:"boolean"` // The name of the DB cluster to create from the source data in the Amazon S3 @@ -48454,9 +48455,9 @@ type RestoreDBClusterFromS3Input struct { // The database name for the restored DB cluster. DatabaseName *string `type:"string"` - // A value that indicates whether the DB cluster has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. + // Specifies whether to enable deletion protection for the DB cluster. The database + // can't be deleted when deletion protection is enabled. By default, deletion + // protection isn't enabled. DeletionProtection *bool `type:"boolean"` // Specify the Active Directory directory ID to restore the DB cluster in. The @@ -48484,9 +48485,9 @@ type RestoreDBClusterFromS3Input struct { // in the Amazon Aurora User Guide. EnableCloudwatchLogsExports []*string `type:"list"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. + // Specifies whether to enable mapping of Amazon Web Services Identity and Access + // Management (IAM) accounts to database accounts. By default, mapping isn't + // enabled. // // For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. @@ -48524,8 +48525,8 @@ type RestoreDBClusterFromS3Input struct { // Services Region. KmsKeyId *string `type:"string"` - // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. + // Specifies whether to manage the master user password with Amazon Web Services + // Secrets Manager. // // For more information, see Password management with Amazon Web Services Secrets // Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) @@ -48584,7 +48585,7 @@ type RestoreDBClusterFromS3Input struct { // The network type of the DB cluster. // - // Valid values: + // Valid Values: // // * IPV4 // @@ -48674,7 +48675,7 @@ type RestoreDBClusterFromS3Input struct { // The identifier for the database engine that was backed up to create the files // stored in the Amazon S3 bucket. // - // Valid values: mysql + // Valid Values: mysql // // SourceEngine is a required field SourceEngine *string `type:"string" required:"true"` @@ -48688,12 +48689,12 @@ type RestoreDBClusterFromS3Input struct { // SourceEngineVersion is a required field SourceEngineVersion *string `type:"string" required:"true"` - // A value that indicates whether the restored DB cluster is encrypted. + // Specifies whether the restored DB cluster is encrypted. StorageEncrypted *bool `type:"boolean"` // Specifies the storage type to be associated with the DB cluster. // - // Valid values: aurora, aurora-iopt1 + // Valid Values: aurora, aurora-iopt1 // // Default: aurora // @@ -49045,8 +49046,8 @@ type RestoreDBClusterFromSnapshotInput struct { // Valid for: Aurora DB clusters only BacktrackWindow *int64 `type:"long"` - // A value that indicates whether to copy all tags from the restored DB cluster - // to snapshots of the restored DB cluster. The default is not to copy them. + // Specifies whether to copy all tags from the restored DB cluster to snapshots + // of the restored DB cluster. The default is not to copy them. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters CopyTagsToSnapshot *bool `type:"boolean"` @@ -49112,15 +49113,15 @@ type RestoreDBClusterFromSnapshotInput struct { // Valid for: Aurora DB clusters and Multi-AZ DB clusters DatabaseName *string `type:"string"` - // A value that indicates whether the DB cluster has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. + // Specifies whether to enable deletion protection for the DB cluster. The database + // can't be deleted when deletion protection is enabled. By default, deletion + // protection isn't enabled. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters DeletionProtection *bool `type:"boolean"` - // Specify the Active Directory directory ID to restore the DB cluster in. The - // domain must be created prior to this operation. Currently, only MySQL, Microsoft + // The Active Directory directory ID to restore the DB cluster in. The domain + // must be created prior to this operation. Currently, only MySQL, Microsoft // SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active // Directory Domain. // @@ -49130,8 +49131,8 @@ type RestoreDBClusterFromSnapshotInput struct { // Valid for: Aurora DB clusters only Domain *string `type:"string"` - // Specify the name of the IAM role to be used when making API calls to the - // Directory Service. + // The name of the IAM role to be used when making API calls to the Directory + // Service. // // Valid for: Aurora DB clusters only DomainIAMRoleName *string `type:"string"` @@ -49166,9 +49167,9 @@ type RestoreDBClusterFromSnapshotInput struct { // Valid for: Aurora DB clusters and Multi-AZ DB clusters EnableCloudwatchLogsExports []*string `type:"list"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. + // Specifies whether to enable mapping of Amazon Web Services Identity and Access + // Management (IAM) accounts to database accounts. By default, mapping isn't + // enabled. // // For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. @@ -49276,7 +49277,7 @@ type RestoreDBClusterFromSnapshotInput struct { // The network type of the DB cluster. // - // Valid values: + // Valid Values: // // * IPV4 // @@ -49306,7 +49307,7 @@ type RestoreDBClusterFromSnapshotInput struct { // Valid for: Aurora DB clusters and Multi-AZ DB clusters Port *int64 `type:"integer"` - // A value that indicates whether the DB cluster is publicly accessible. + // Specifies whether the DB cluster is publicly accessible. // // When the DB cluster is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB cluster's @@ -49374,7 +49375,7 @@ type RestoreDBClusterFromSnapshotInput struct { // When specified for a Multi-AZ DB cluster, a value for the Iops parameter // is required. // - // Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB + // Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB // clusters) // // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) @@ -49662,8 +49663,8 @@ type RestoreDBClusterToPointInTimeInput struct { // Valid for: Aurora MySQL DB clusters only BacktrackWindow *int64 `type:"long"` - // A value that indicates whether to copy all tags from the restored DB cluster - // to snapshots of the restored DB cluster. The default is not to copy them. + // Specifies whether to copy all tags from the restored DB cluster to snapshots + // of the restored DB cluster. The default is not to copy them. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters CopyTagsToSnapshot *bool `type:"boolean"` @@ -49723,15 +49724,15 @@ type RestoreDBClusterToPointInTimeInput struct { // Valid for: Aurora DB clusters and Multi-AZ DB clusters DBSubnetGroupName *string `type:"string"` - // A value that indicates whether the DB cluster has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. + // Specifies whether to enable deletion protection for the DB cluster. The database + // can't be deleted when deletion protection is enabled. By default, deletion + // protection isn't enabled. // // Valid for: Aurora DB clusters and Multi-AZ DB clusters DeletionProtection *bool `type:"boolean"` - // Specify the Active Directory directory ID to restore the DB cluster in. The - // domain must be created prior to this operation. + // The Active Directory directory ID to restore the DB cluster in. The domain + // must be created prior to this operation. // // For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication // to authenticate users that connect to the DB cluster. For more information, @@ -49741,8 +49742,8 @@ type RestoreDBClusterToPointInTimeInput struct { // Valid for: Aurora DB clusters only Domain *string `type:"string"` - // Specify the name of the IAM role to be used when making API calls to the - // Directory Service. + // The name of the IAM role to be used when making API calls to the Directory + // Service. // // Valid for: Aurora DB clusters only DomainIAMRoleName *string `type:"string"` @@ -49777,9 +49778,9 @@ type RestoreDBClusterToPointInTimeInput struct { // Valid for: Aurora DB clusters and Multi-AZ DB clusters EnableCloudwatchLogsExports []*string `type:"list"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. + // Specifies whether to enable mapping of Amazon Web Services Identity and Access + // Management (IAM) accounts to database accounts. By default, mapping isn't + // enabled. // // For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. @@ -49839,7 +49840,7 @@ type RestoreDBClusterToPointInTimeInput struct { // The network type of the DB cluster. // - // Valid values: + // Valid Values: // // * IPV4 // @@ -49869,7 +49870,7 @@ type RestoreDBClusterToPointInTimeInput struct { // Valid for: Aurora DB clusters and Multi-AZ DB clusters Port *int64 `type:"integer"` - // A value that indicates whether the DB cluster is publicly accessible. + // Specifies whether the DB cluster is publicly accessible. // // When the DB cluster is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB cluster's @@ -49968,7 +49969,7 @@ type RestoreDBClusterToPointInTimeInput struct { // When specified for a Multi-AZ DB cluster, a value for the Iops parameter // is required. // - // Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB + // Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB // clusters) // // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) @@ -49980,8 +49981,8 @@ type RestoreDBClusterToPointInTimeInput struct { // in the Amazon RDS User Guide. Tags []*Tag `locationNameList:"Tag" type:"list"` - // A value that indicates whether to restore the DB cluster to the latest restorable - // backup time. By default, the DB cluster isn't restored to the latest restorable + // Specifies whether to restore the DB cluster to the latest restorable backup + // time. By default, the DB cluster isn't restored to the latest restorable // backup time. // // Constraints: Can't be specified if RestoreToTime parameter is provided. @@ -50253,8 +50254,8 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // growth. AllocatedStorage *int64 `type:"integer"` - // A value that indicates whether minor version upgrades are applied automatically - // to the DB instance during the maintenance window. + // Specifies whether to automatically apply minor version upgrades to the DB + // instance during the maintenance window. // // If you restore an RDS Custom DB instance, you must disable this parameter. AutoMinorVersionUpgrade *bool `type:"boolean"` @@ -50280,8 +50281,8 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // in the Amazon RDS User Guide. BackupTarget *string `type:"string"` - // A value that indicates whether to copy all tags from the restored DB instance - // to snapshots of the DB instance. + // Specifies whether to copy all tags from the restored DB instance to snapshots + // of the DB instance. // // In most cases, tags aren't copied by default. However, when you restore a // DB instance from a DB snapshot, RDS checks whether you specify new tags. @@ -50405,8 +50406,8 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // Example: mydbsubnetgroup DBSubnetGroupName *string `type:"string"` - // A value that indicates whether the DB instance has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, + // Specifies whether to enable deletion protection for the DB instance. The + // database can't be deleted when deletion protection is enabled. By default, // deletion protection isn't enabled. For more information, see Deleting a DB // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` @@ -50427,6 +50428,8 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // // Constraints: // + // * Can't be longer than 64 characters. + // // Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string `type:"string"` @@ -50475,8 +50478,8 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // This setting doesn't apply to RDS Custom. EnableCloudwatchLogsExports []*string `type:"list"` - // A value that indicates whether to enable a customer-owned IP address (CoIP) - // for an RDS on Outposts DB instance. + // Specifies whether to enable a customer-owned IP address (CoIP) for an RDS + // on Outposts DB instance. // // A CoIP provides local or external connectivity to resources in your Outpost // subnets through your on-premises network. For some use cases, a CoIP can @@ -50493,9 +50496,8 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool `type:"boolean"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // is disabled. + // Specifies whether to enable mapping of Amazon Web Services Identity and Access + // Management (IAM) accounts to database accounts. By default, mapping is disabled. // // For more information about IAM database authentication, see IAM Database // Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) @@ -50558,10 +50560,10 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // // Default: Same as source. // - // Valid values: license-included | bring-your-own-license | general-public-license + // Valid Values: license-included | bring-your-own-license | general-public-license LicenseModel *string `type:"string"` - // A value that indicates whether the DB instance is a Multi-AZ deployment. + // Specifies whether the DB instance is a Multi-AZ deployment. // // This setting doesn't apply to RDS Custom. // @@ -50571,7 +50573,7 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // The network type of the DB instance. // - // Valid values: + // Valid Values: // // * IPV4 // @@ -50607,7 +50609,7 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // This setting doesn't apply to RDS Custom. ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that indicates whether the DB instance is publicly accessible. + // Specifies whether the DB instance is publicly accessible. // // When the DB instance is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB instance's @@ -50629,7 +50631,7 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // Specifies the storage type to be associated with the DB instance. // - // Valid values: gp2 | gp3 | io1 | standard + // Valid Values: gp2 | gp3 | io1 | standard // // If you specify io1 or gp3, you must also include a value for the Iops parameter. // @@ -50651,8 +50653,8 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // This setting doesn't apply to RDS Custom. TdeCredentialPassword *string `type:"string"` - // A value that indicates whether the DB instance class of the DB instance uses - // its default processor features. + // Specifies whether the DB instance class of the DB instance uses its default + // processor features. // // This setting doesn't apply to RDS Custom. UseDefaultProcessorFeatures *bool `type:"boolean"` @@ -50975,9 +50977,9 @@ type RestoreDBInstanceFromS3Input struct { // growth. AllocatedStorage *int64 `type:"integer"` - // A value that indicates whether minor engine upgrades are applied automatically - // to the DB instance during the maintenance window. By default, minor engine - // upgrades are not applied automatically. + // Specifies whether to automatically apply minor engine upgrades to the DB + // instance during the maintenance window. By default, minor engine upgrades + // are not applied automatically. AutoMinorVersionUpgrade *bool `type:"boolean"` // The Availability Zone that the DB instance is created in. For information @@ -51000,8 +51002,8 @@ type RestoreDBInstanceFromS3Input struct { // CreateDBInstance. BackupRetentionPeriod *int64 `type:"integer"` - // A value that indicates whether to copy all tags from the DB instance to snapshots - // of the DB instance. By default, tags are not copied. + // Specifies whether to copy all tags from the DB instance to snapshots of the + // DB instance. By default, tags are not copied. CopyTagsToSnapshot *bool `type:"boolean"` // The compute and memory capacity of the DB instance, for example db.m4.large. @@ -51052,8 +51054,8 @@ type RestoreDBInstanceFromS3Input struct { // Example: mydbsubnetgroup DBSubnetGroupName *string `type:"string"` - // A value that indicates whether the DB instance has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, + // Specifies whether to enable deletion protection for the DB instance. The + // database can't be deleted when deletion protection is enabled. By default, // deletion protection isn't enabled. For more information, see Deleting a DB // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` @@ -51064,17 +51066,16 @@ type RestoreDBInstanceFromS3Input struct { // in the Amazon RDS User Guide. EnableCloudwatchLogsExports []*string `type:"list"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. + // Specifies whether to enable mapping of Amazon Web Services Identity and Access + // Management (IAM) accounts to database accounts. By default, mapping isn't + // enabled. // // For more information about IAM database authentication, see IAM Database // Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to enable Performance Insights for the DB - // instance. + // Specifies whether to enable Performance Insights for the DB instance. // // For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. @@ -51114,8 +51115,8 @@ type RestoreDBInstanceFromS3Input struct { // The license model for this DB instance. Use general-public-license. LicenseModel *string `type:"string"` - // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. + // Specifies whether to manage the master user password with Amazon Web Services + // Secrets Manager. // // For more information, see Password management with Amazon Web Services Secrets // Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) @@ -51215,14 +51216,13 @@ type RestoreDBInstanceFromS3Input struct { // a MonitoringRoleArn value. MonitoringRoleArn *string `type:"string"` - // A value that indicates whether the DB instance is a Multi-AZ deployment. - // If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone - // parameter. + // Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance + // is a Multi-AZ deployment, you can't set the AvailabilityZone parameter. MultiAZ *bool `type:"boolean"` // The network type of the DB instance. // - // Valid values: + // Valid Values: // // * IPV4 // @@ -51322,7 +51322,7 @@ type RestoreDBInstanceFromS3Input struct { // class of the DB instance. ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that indicates whether the DB instance is publicly accessible. + // Specifies whether the DB instance is publicly accessible. // // When the DB instance is publicly accessible, its Domain Name System (DNS) // endpoint resolves to the private IP address from within the DB instance's @@ -51367,7 +51367,7 @@ type RestoreDBInstanceFromS3Input struct { // SourceEngineVersion is a required field SourceEngineVersion *string `type:"string" required:"true"` - // A value that indicates whether the new DB instance is encrypted or not. + // Specifies whether the new DB instance is encrypted or not. StorageEncrypted *bool `type:"boolean"` // Specifies the storage throughput value for the DB instance. @@ -51377,7 +51377,7 @@ type RestoreDBInstanceFromS3Input struct { // Specifies the storage type to be associated with the DB instance. // - // Valid values: gp2 | gp3 | io1 | standard + // Valid Values: gp2 | gp3 | io1 | standard // // If you specify io1 or gp3, you must also include a value for the Iops parameter. // @@ -51389,8 +51389,8 @@ type RestoreDBInstanceFromS3Input struct { // in the Amazon RDS User Guide. Tags []*Tag `locationNameList:"Tag" type:"list"` - // A value that indicates whether the DB instance class of the DB instance uses - // its default processor features. + // Specifies whether the DB instance class of the DB instance uses its default + // processor features. UseDefaultProcessorFeatures *bool `type:"boolean"` // A list of VPC security groups to associate with this DB instance. @@ -52179,8 +52179,8 @@ type RestoreDBInstanceToPointInTimeInput struct { // This setting doesn't apply to RDS Custom. TdeCredentialPassword *string `type:"string"` - // A value that indicates whether the DB instance class of the DB instance uses - // its default processor features. + // Specifies whether the DB instance class of the DB instance uses its default + // processor features. // // This setting doesn't apply to RDS Custom. UseDefaultProcessorFeatures *bool `type:"boolean"` @@ -52698,9 +52698,9 @@ func (s *RevokeDBSecurityGroupIngressOutput) SetDBSecurityGroup(v *DBSecurityGro type ScalingConfiguration struct { _ struct{} `type:"structure"` - // A value that indicates whether to allow or disallow automatic pause for an - // Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused - // only when it's idle (it has no connections). + // Indicates whether to allow or disallow automatic pause for an Aurora DB cluster + // in serverless DB engine mode. A DB cluster can be paused only when it's idle + // (it has no connections). // // If a DB cluster is paused for more than seven days, the DB cluster might // be backed up with a snapshot. In this case, the DB cluster is restored when @@ -52820,8 +52820,8 @@ func (s *ScalingConfiguration) SetTimeoutAction(v string) *ScalingConfiguration type ScalingConfigurationInfo struct { _ struct{} `type:"structure"` - // A value that indicates whether automatic pause is allowed for the Aurora - // DB cluster in serverless DB engine mode. + // Indicates whether automatic pause is allowed for the Aurora DB cluster in + // serverless DB engine mode. // // When the value is set to false for an Aurora Serverless v1 DB cluster, the // DB cluster automatically resumes. @@ -53018,8 +53018,8 @@ type SourceRegion struct { // The status of the source Amazon Web Services Region. Status *string `type:"string"` - // Whether the source Amazon Web Services Region supports replicating automated - // backups to the current Amazon Web Services Region. + // Indicates whether the source Amazon Web Services Region supports replicating + // automated backups to the current Amazon Web Services Region. SupportsDBInstanceAutomatedBackupsReplication *bool `type:"boolean"` } @@ -53573,8 +53573,10 @@ func (s *StartDBInstanceOutput) SetDBInstance(v *DBInstance) *StartDBInstanceOut type StartExportTaskInput struct { _ struct{} `type:"structure"` - // The data to be exported from the snapshot or cluster. If this parameter is - // not provided, all of the data is exported. Valid values are the following: + // The data to be exported from the snapshot or cluster. If this parameter isn't + // provided, all of the data is exported. + // + // Valid Values: // // * database - Export all the data from a specified database. // @@ -53754,11 +53756,13 @@ func (s *StartExportTaskInput) SetSourceArn(v string) *StartExportTaskInput { // Contains the details of a snapshot or cluster export to Amazon S3. // -// This data type is used as a response element in the DescribeExportTasks action. +// This data type is used as a response element in the DescribeExportTasks operation. type StartExportTaskOutput struct { _ struct{} `type:"structure"` - // The data exported from the snapshot or cluster. Valid values are the following: + // The data exported from the snapshot or cluster. + // + // Valid Values: // // * database - Export all the data from a specified database. // @@ -53794,14 +53798,14 @@ type StartExportTaskOutput struct { // The progress of the snapshot or cluster export task as a percentage. PercentProgress *int64 `type:"integer"` - // The Amazon S3 bucket that the snapshot or cluster is exported to. + // The Amazon S3 bucket where the snapshot or cluster is exported to. S3Bucket *string `type:"string"` // The Amazon S3 bucket prefix that is the file name and path of the exported // data. S3Prefix *string `type:"string"` - // The time that the snapshot was created. + // The time when the snapshot was created. SnapshotTime *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon @@ -53826,10 +53830,10 @@ type StartExportTaskOutput struct { // * STARTING Status *string `type:"string"` - // The time that the snapshot or cluster export task ended. + // The time when the snapshot or cluster export task ended. TaskEndTime *time.Time `type:"timestamp"` - // The time that the snapshot or cluster export task started. + // The time when the snapshot or cluster export task started. TaskStartTime *time.Time `type:"timestamp"` // The total amount of data exported, in gigabytes. @@ -54913,8 +54917,8 @@ func (s *Timezone) SetTimezoneName(v string) *Timezone { type UpgradeTarget struct { _ struct{} `type:"structure"` - // A value that indicates whether the target version is applied to any source - // DB instances that have AutoMinorVersionUpgrade set to true. + // Indicates whether the target version is applied to any source DB instances + // that have AutoMinorVersionUpgrade set to true. AutoUpgrade *bool `type:"boolean"` // The version of the database engine that a DB instance can be upgraded to. @@ -54926,30 +54930,30 @@ type UpgradeTarget struct { // The version number of the upgrade target database engine. EngineVersion *string `type:"string"` - // A value that indicates whether upgrading to the target version requires upgrading - // the major version of the database engine. + // Indicates whether upgrading to the target version requires upgrading the + // major version of the database engine. IsMajorVersionUpgrade *bool `type:"boolean"` // A list of the supported DB engine modes for the target engine version. SupportedEngineModes []*string `type:"list"` - // A value that indicates whether you can use Babelfish for Aurora PostgreSQL - // with the target engine version. + // Indicates whether you can use Babelfish for Aurora PostgreSQL with the target + // engine version. SupportsBabelfish *bool `type:"boolean"` - // A value that indicates whether you can use Aurora global databases with the - // target engine version. + // Indicates whether you can use Aurora global databases with the target engine + // version. SupportsGlobalDatabases *bool `type:"boolean"` - // A value that indicates whether the target engine version supports forwarding - // write operations from reader DB instances to the writer DB instance in the - // DB cluster. By default, write operations aren't allowed on reader DB instances. + // Indicates whether the target engine version supports forwarding write operations + // from reader DB instances to the writer DB instance in the DB cluster. By + // default, write operations aren't allowed on reader DB instances. // // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool `type:"boolean"` - // A value that indicates whether you can use Aurora parallel query with the - // target engine version. + // Indicates whether you can use Aurora parallel query with the target engine + // version. SupportsParallelQuery *bool `type:"boolean"` } @@ -55047,9 +55051,10 @@ type UserAuthConfig struct { // log in as a specific database user. Description *string `type:"string"` - // Whether to require or disallow Amazon Web Services Identity and Access Management - // (IAM) authentication for connections to the proxy. The ENABLED value is valid - // only for proxies with RDS for Microsoft SQL Server. + // A value that indicates whether to require or disallow Amazon Web Services + // Identity and Access Management (IAM) authentication for connections to the + // proxy. The ENABLED value is valid only for proxies with RDS for Microsoft + // SQL Server. IAMAuth *string `type:"string" enum:"IAMAuthMode"` // The Amazon Resource Name (ARN) representing the secret that the proxy uses @@ -55270,8 +55275,8 @@ type ValidStorageOptions struct { // The valid storage types for your DB instance. For example: gp2, gp3, io1. StorageType *string `type:"string"` - // Whether or not Amazon RDS can automatically scale storage for DB instances - // that use the new instance class. + // Indicates whether or not Amazon RDS can automatically scale storage for DB + // instances that use the new instance class. SupportsStorageAutoscaling *bool `type:"boolean"` } diff --git a/service/route53/api.go b/service/route53/api.go index 55c72ad6864..c7e98c2c3d7 100644 --- a/service/route53/api.go +++ b/service/route53/api.go @@ -474,8 +474,8 @@ func (c *Route53) ChangeResourceRecordSetsRequest(input *ChangeResourceRecordSet // - DELETE: Deletes an existing resource record set that has the specified // values. // -// - UPSERT: If a resource set exists Route 53 updates it with the values -// in the request. +// - UPSERT: If a resource set doesn't exist, Route 53 creates it. If a resource +// set exists Route 53 updates it with the values in the request. // // # Syntaxes for Creating, Updating, and Deleting Resource Record Sets // @@ -1728,6 +1728,13 @@ func (c *Route53) CreateTrafficPolicyInstanceRequest(input *CreateTrafficPolicyI // responds to DNS queries for the domain or subdomain name by using the resource // record sets that CreateTrafficPolicyInstance created. // +// After you submit an CreateTrafficPolicyInstance request, there's a brief +// delay while Amazon Route 53 creates the resource record sets that are specified +// in the traffic policy definition. Use GetTrafficPolicyInstance with the id +// of new traffic policy instance to confirm that the CreateTrafficPolicyInstance +// request completed successfully. For more information, see the State response +// element. +// // 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. @@ -4780,10 +4787,10 @@ func (c *Route53) GetTrafficPolicyInstanceRequest(input *GetTrafficPolicyInstanc // // Gets information about a specified traffic policy instance. // -// After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance -// request, there's a brief delay while Amazon Route 53 creates the resource -// record sets that are specified in the traffic policy definition. For more -// information, see the State response element. +// Use GetTrafficPolicyInstance with the id of new traffic policy instance to +// confirm that the CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance +// request completed successfully. For more information, see the State response +// element. // // In the Route 53 console, traffic policy instances are known as policy records. // @@ -7505,6 +7512,12 @@ func (c *Route53) UpdateTrafficPolicyInstanceRequest(input *UpdateTrafficPolicyI // UpdateTrafficPolicyInstance API operation for Amazon Route 53. // +// After you submit a UpdateTrafficPolicyInstance request, there's a brief delay +// while Route 53 creates the resource record sets that are specified in the +// traffic policy definition. Use GetTrafficPolicyInstance with the id of updated +// traffic policy instance confirm that the UpdateTrafficPolicyInstance request +// completed successfully. For more information, see the State response element. +// // Updates the resource record sets in a specified hosted zone that were created // based on the settings in a specified traffic policy version. // @@ -9453,6 +9466,10 @@ type CreateHealthCheckInput struct { // but settings identical to an existing health check, Route 53 creates the // health check. // + // Route 53 does not store the CallerReference for a deleted health check indefinitely. + // The CallerReference for a deleted health check will be deleted after a number + // of days. + // // CallerReference is a required field CallerReference *string `min:"1" type:"string" required:"true"` @@ -12045,6 +12062,8 @@ type GeoLocation struct { // // Amazon Route 53 uses the two-letter country codes that are specified in ISO // standard 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + // + // Route 53 also supports the contry code UA forr Ukraine. CountryCode *string `min:"1" type:"string"` // For geolocation resource record sets, the two-letter code for a state of @@ -12577,6 +12596,8 @@ type GetGeoLocationInput struct { // Amazon Route 53 uses the two-letter country codes that are specified in ISO // standard 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + // + // Route 53 also supports the contry code UA forr Ukraine. CountryCode *string `location:"querystring" locationName:"countrycode" min:"1" type:"string"` // The code for the subdivision, such as a particular state within the United @@ -15579,8 +15600,8 @@ type ListHealthChecksInput struct { // The maximum number of health checks that you want ListHealthChecks to return // in response to the current request. Amazon Route 53 returns a maximum of - // 100 items. If you set MaxItems to a value greater than 100, Route 53 returns - // only the first 100 health checks. + // 1000 items. If you set MaxItems to a value greater than 1000, Route 53 returns + // only the first 1000 health checks. MaxItems *string `location:"querystring" locationName:"maxitems" type:"string"` } @@ -16040,6 +16061,9 @@ type ListHostedZonesInput struct { // the ID of that reusable delegation set. DelegationSetId *string `location:"querystring" locationName:"delegationsetid" type:"string"` + // (Optional) Specifies if the hosted zone is private. + HostedZoneType *string `location:"querystring" locationName:"hostedzonetype" type:"string" enum:"HostedZoneType"` + // If the value of IsTruncated in the previous response was true, you have more // hosted zones. To get more hosted zones, submit another ListHostedZones request. // @@ -16083,6 +16107,12 @@ func (s *ListHostedZonesInput) SetDelegationSetId(v string) *ListHostedZonesInpu return s } +// SetHostedZoneType sets the HostedZoneType field's value. +func (s *ListHostedZonesInput) SetHostedZoneType(v string) *ListHostedZonesInput { + s.HostedZoneType = &v + return s +} + // SetMarker sets the Marker field's value. func (s *ListHostedZonesInput) SetMarker(v string) *ListHostedZonesInput { s.Marker = &v @@ -20603,6 +20633,18 @@ func HostedZoneLimitType_Values() []string { } } +const ( + // HostedZoneTypePrivateHostedZone is a HostedZoneType enum value + HostedZoneTypePrivateHostedZone = "PrivateHostedZone" +) + +// HostedZoneType_Values returns all elements of the HostedZoneType enum +func HostedZoneType_Values() []string { + return []string{ + HostedZoneTypePrivateHostedZone, + } +} + const ( // InsufficientDataHealthStatusHealthy is a InsufficientDataHealthStatus enum value InsufficientDataHealthStatusHealthy = "Healthy" diff --git a/service/securityhub/api.go b/service/securityhub/api.go index d14806da75c..3dd868084c2 100644 --- a/service/securityhub/api.go +++ b/service/securityhub/api.go @@ -16281,6 +16281,518 @@ func (s *AwsCorsConfiguration) SetMaxAge(v int64) *AwsCorsConfiguration { return s } +// Provides details about an Database Migration Service (DMS) endpoint. An endpoint +// provides connection, data store type, and location information about your +// data store. +type AwsDmsEndpointDetails struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the SSL certificate that encrypts connections + // between the DMS endpoint and the replication instance. + CertificateArn *string `type:"string"` + + // The name of the endpoint database. + DatabaseName *string `type:"string"` + + // The Amazon Resource Name (ARN) of the endpoint. + EndpointArn *string `type:"string"` + + // The database endpoint identifier. + EndpointIdentifier *string `type:"string"` + + // The type of endpoint. Valid values are source and target. + EndpointType *string `type:"string"` + + // The type of engine for the endpoint, depending on the EndpointType value. + EngineName *string `type:"string"` + + // A value that can be used for cross-account validation. + ExternalId *string `type:"string"` + + // Additional attributes associated with the connection. + ExtraConnectionAttributes *string `type:"string"` + + // An DMS key identifier that is used to encrypt the connection parameters for + // the endpoint. If you don't specify a value for the KmsKeyId parameter, then + // DMS uses your default encryption key. KMS creates the default encryption + // key for your Amazon Web Services account. Your Amazon Web Services account + // has a different default encryption key for each Amazon Web Services Region. + KmsKeyId *string `type:"string"` + + // The port used to access the endpoint. + Port *int64 `type:"integer"` + + // The name of the server where the endpoint database resides. + ServerName *string `type:"string"` + + // The SSL mode used to connect to the endpoint. The default is none. + SslMode *string `type:"string"` + + // The user name to be used to log in to the endpoint database. + Username *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 AwsDmsEndpointDetails) 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 AwsDmsEndpointDetails) GoString() string { + return s.String() +} + +// SetCertificateArn sets the CertificateArn field's value. +func (s *AwsDmsEndpointDetails) SetCertificateArn(v string) *AwsDmsEndpointDetails { + s.CertificateArn = &v + return s +} + +// SetDatabaseName sets the DatabaseName field's value. +func (s *AwsDmsEndpointDetails) SetDatabaseName(v string) *AwsDmsEndpointDetails { + s.DatabaseName = &v + return s +} + +// SetEndpointArn sets the EndpointArn field's value. +func (s *AwsDmsEndpointDetails) SetEndpointArn(v string) *AwsDmsEndpointDetails { + s.EndpointArn = &v + return s +} + +// SetEndpointIdentifier sets the EndpointIdentifier field's value. +func (s *AwsDmsEndpointDetails) SetEndpointIdentifier(v string) *AwsDmsEndpointDetails { + s.EndpointIdentifier = &v + return s +} + +// SetEndpointType sets the EndpointType field's value. +func (s *AwsDmsEndpointDetails) SetEndpointType(v string) *AwsDmsEndpointDetails { + s.EndpointType = &v + return s +} + +// SetEngineName sets the EngineName field's value. +func (s *AwsDmsEndpointDetails) SetEngineName(v string) *AwsDmsEndpointDetails { + s.EngineName = &v + return s +} + +// SetExternalId sets the ExternalId field's value. +func (s *AwsDmsEndpointDetails) SetExternalId(v string) *AwsDmsEndpointDetails { + s.ExternalId = &v + return s +} + +// SetExtraConnectionAttributes sets the ExtraConnectionAttributes field's value. +func (s *AwsDmsEndpointDetails) SetExtraConnectionAttributes(v string) *AwsDmsEndpointDetails { + s.ExtraConnectionAttributes = &v + return s +} + +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *AwsDmsEndpointDetails) SetKmsKeyId(v string) *AwsDmsEndpointDetails { + s.KmsKeyId = &v + return s +} + +// SetPort sets the Port field's value. +func (s *AwsDmsEndpointDetails) SetPort(v int64) *AwsDmsEndpointDetails { + s.Port = &v + return s +} + +// SetServerName sets the ServerName field's value. +func (s *AwsDmsEndpointDetails) SetServerName(v string) *AwsDmsEndpointDetails { + s.ServerName = &v + return s +} + +// SetSslMode sets the SslMode field's value. +func (s *AwsDmsEndpointDetails) SetSslMode(v string) *AwsDmsEndpointDetails { + s.SslMode = &v + return s +} + +// SetUsername sets the Username field's value. +func (s *AwsDmsEndpointDetails) SetUsername(v string) *AwsDmsEndpointDetails { + s.Username = &v + return s +} + +// Provides details about an Database Migration Service (DMS) replication instance. +// DMS uses a replication instance to connect to your source data store, read +// the source data, and format the data for consumption by the target data store. +type AwsDmsReplicationInstanceDetails struct { + _ struct{} `type:"structure"` + + // The amount of storage (in gigabytes) that is allocated for the replication + // instance. + AllocatedStorage *int64 `type:"integer"` + + // Indicates whether minor engine upgrades are applied automatically to the + // replication instance during the maintenance window. + AutoMinorVersionUpgrade *bool `type:"boolean"` + + // The Availability Zone that the replication instance is created in. The default + // value is a random, system-chosen Availability Zone in the endpoint's Amazon + // Web Services Region, such as us-east-1d. + AvailabilityZone *string `type:"string"` + + // The engine version number of the replication instance. If an engine version + // number is not specified when a replication instance is created, the default + // is the latest engine version available. + EngineVersion *string `type:"string"` + + // An KMS key identifier that is used to encrypt the data on the replication + // instance. If you don't specify a value for the KmsKeyId parameter, DMS uses + // your default encryption key. KMS creates the default encryption key for your + // Amazon Web Services account. Your Amazon Web Services account has a different + // default encryption key for each Amazon Web Services Region. + KmsKeyId *string `type:"string"` + + // Specifies whether the replication instance is deployed across multiple Availability + // Zones (AZs). You can't set the AvailabilityZone parameter if the MultiAZ + // parameter is set to true. + MultiAZ *bool `type:"boolean"` + + // The maintenance window times for the replication instance. Upgrades to the + // replication instance are performed during this time. + PreferredMaintenanceWindow *string `type:"string"` + + // Specifies the accessibility options for the replication instance. A value + // of true represents an instance with a public IP address. A value of false + // represents an instance with a private IP address. The default value is true. + PubliclyAccessible *bool `type:"boolean"` + + // The compute and memory capacity of the replication instance as defined for + // the specified replication instance class. + ReplicationInstanceClass *string `type:"string"` + + // The replication instance identifier. + ReplicationInstanceIdentifier *string `type:"string"` + + // The subnet group for the replication instance. + ReplicationSubnetGroup *AwsDmsReplicationInstanceReplicationSubnetGroupDetails `type:"structure"` + + // The virtual private cloud (VPC) security group for the replication instance. + VpcSecurityGroups []*AwsDmsReplicationInstanceVpcSecurityGroupsDetails `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 AwsDmsReplicationInstanceDetails) 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 AwsDmsReplicationInstanceDetails) GoString() string { + return s.String() +} + +// SetAllocatedStorage sets the AllocatedStorage field's value. +func (s *AwsDmsReplicationInstanceDetails) SetAllocatedStorage(v int64) *AwsDmsReplicationInstanceDetails { + s.AllocatedStorage = &v + return s +} + +// SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value. +func (s *AwsDmsReplicationInstanceDetails) SetAutoMinorVersionUpgrade(v bool) *AwsDmsReplicationInstanceDetails { + s.AutoMinorVersionUpgrade = &v + return s +} + +// SetAvailabilityZone sets the AvailabilityZone field's value. +func (s *AwsDmsReplicationInstanceDetails) SetAvailabilityZone(v string) *AwsDmsReplicationInstanceDetails { + s.AvailabilityZone = &v + return s +} + +// SetEngineVersion sets the EngineVersion field's value. +func (s *AwsDmsReplicationInstanceDetails) SetEngineVersion(v string) *AwsDmsReplicationInstanceDetails { + s.EngineVersion = &v + return s +} + +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *AwsDmsReplicationInstanceDetails) SetKmsKeyId(v string) *AwsDmsReplicationInstanceDetails { + s.KmsKeyId = &v + return s +} + +// SetMultiAZ sets the MultiAZ field's value. +func (s *AwsDmsReplicationInstanceDetails) SetMultiAZ(v bool) *AwsDmsReplicationInstanceDetails { + s.MultiAZ = &v + return s +} + +// SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value. +func (s *AwsDmsReplicationInstanceDetails) SetPreferredMaintenanceWindow(v string) *AwsDmsReplicationInstanceDetails { + s.PreferredMaintenanceWindow = &v + return s +} + +// SetPubliclyAccessible sets the PubliclyAccessible field's value. +func (s *AwsDmsReplicationInstanceDetails) SetPubliclyAccessible(v bool) *AwsDmsReplicationInstanceDetails { + s.PubliclyAccessible = &v + return s +} + +// SetReplicationInstanceClass sets the ReplicationInstanceClass field's value. +func (s *AwsDmsReplicationInstanceDetails) SetReplicationInstanceClass(v string) *AwsDmsReplicationInstanceDetails { + s.ReplicationInstanceClass = &v + return s +} + +// SetReplicationInstanceIdentifier sets the ReplicationInstanceIdentifier field's value. +func (s *AwsDmsReplicationInstanceDetails) SetReplicationInstanceIdentifier(v string) *AwsDmsReplicationInstanceDetails { + s.ReplicationInstanceIdentifier = &v + return s +} + +// SetReplicationSubnetGroup sets the ReplicationSubnetGroup field's value. +func (s *AwsDmsReplicationInstanceDetails) SetReplicationSubnetGroup(v *AwsDmsReplicationInstanceReplicationSubnetGroupDetails) *AwsDmsReplicationInstanceDetails { + s.ReplicationSubnetGroup = v + return s +} + +// SetVpcSecurityGroups sets the VpcSecurityGroups field's value. +func (s *AwsDmsReplicationInstanceDetails) SetVpcSecurityGroups(v []*AwsDmsReplicationInstanceVpcSecurityGroupsDetails) *AwsDmsReplicationInstanceDetails { + s.VpcSecurityGroups = v + return s +} + +// Provides details about the replication subnet group. +type AwsDmsReplicationInstanceReplicationSubnetGroupDetails struct { + _ struct{} `type:"structure"` + + // The identifier of the replication subnet group. + ReplicationSubnetGroupIdentifier *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 AwsDmsReplicationInstanceReplicationSubnetGroupDetails) 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 AwsDmsReplicationInstanceReplicationSubnetGroupDetails) GoString() string { + return s.String() +} + +// SetReplicationSubnetGroupIdentifier sets the ReplicationSubnetGroupIdentifier field's value. +func (s *AwsDmsReplicationInstanceReplicationSubnetGroupDetails) SetReplicationSubnetGroupIdentifier(v string) *AwsDmsReplicationInstanceReplicationSubnetGroupDetails { + s.ReplicationSubnetGroupIdentifier = &v + return s +} + +// Provides details about the virtual private cloud (VPC) security group that’s +// associated with the replication instance. +type AwsDmsReplicationInstanceVpcSecurityGroupsDetails struct { + _ struct{} `type:"structure"` + + // The identifier of the VPC security group that’s associated with the replication + // instance. + VpcSecurityGroupId *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 AwsDmsReplicationInstanceVpcSecurityGroupsDetails) 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 AwsDmsReplicationInstanceVpcSecurityGroupsDetails) GoString() string { + return s.String() +} + +// SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value. +func (s *AwsDmsReplicationInstanceVpcSecurityGroupsDetails) SetVpcSecurityGroupId(v string) *AwsDmsReplicationInstanceVpcSecurityGroupsDetails { + s.VpcSecurityGroupId = &v + return s +} + +// Provides details about an Database Migration Service (DMS) replication task. +// A replication task moves a set of data from the source endpoint to the target +// endpoint. +type AwsDmsReplicationTaskDetails struct { + _ struct{} `type:"structure"` + + // Indicates when you want a change data capture (CDC) operation to start. CCdcStartPosition + // or CCdcStartTime specifies when you want a CDC operation to start. Only a + // value for one of these fields is included. + CdcStartPosition *string `type:"string"` + + // Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime + // specifies when you want a CDC operation to start. Only a value for one of + // these fields is included. + CdcStartTime *string `type:"string"` + + // Indicates when you want a CDC operation to stop. The value can be either + // server time or commit time. + CdcStopPosition *string `type:"string"` + + // The identifier of the replication task. + Id *string `type:"string"` + + // The migration type. + MigrationType *string `type:"string"` + + // The Amazon Resource Name (ARN) of a replication instance. + ReplicationInstanceArn *string `type:"string"` + + // The user-defined replication task identifier or name. + ReplicationTaskIdentifier *string `type:"string"` + + // The settings for the replication task. + ReplicationTaskSettings *string `type:"string"` + + // A display name for the resource identifier at the end of the EndpointArn + // response parameter. If you don't specify a ResourceIdentifier value, DMS + // generates a default identifier value for the end of EndpointArn. + ResourceIdentifier *string `type:"string"` + + // The ARN of the source endpoint. + SourceEndpointArn *string `type:"string"` + + // The table mappings for the replication task, in JSON format. + TableMappings *string `type:"string"` + + // The ARN of the target endpoint. + TargetEndpointArn *string `type:"string"` + + // Supplemental information that the task requires to migrate the data for certain + // source and target endpoints. + TaskData *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 AwsDmsReplicationTaskDetails) 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 AwsDmsReplicationTaskDetails) GoString() string { + return s.String() +} + +// SetCdcStartPosition sets the CdcStartPosition field's value. +func (s *AwsDmsReplicationTaskDetails) SetCdcStartPosition(v string) *AwsDmsReplicationTaskDetails { + s.CdcStartPosition = &v + return s +} + +// SetCdcStartTime sets the CdcStartTime field's value. +func (s *AwsDmsReplicationTaskDetails) SetCdcStartTime(v string) *AwsDmsReplicationTaskDetails { + s.CdcStartTime = &v + return s +} + +// SetCdcStopPosition sets the CdcStopPosition field's value. +func (s *AwsDmsReplicationTaskDetails) SetCdcStopPosition(v string) *AwsDmsReplicationTaskDetails { + s.CdcStopPosition = &v + return s +} + +// SetId sets the Id field's value. +func (s *AwsDmsReplicationTaskDetails) SetId(v string) *AwsDmsReplicationTaskDetails { + s.Id = &v + return s +} + +// SetMigrationType sets the MigrationType field's value. +func (s *AwsDmsReplicationTaskDetails) SetMigrationType(v string) *AwsDmsReplicationTaskDetails { + s.MigrationType = &v + return s +} + +// SetReplicationInstanceArn sets the ReplicationInstanceArn field's value. +func (s *AwsDmsReplicationTaskDetails) SetReplicationInstanceArn(v string) *AwsDmsReplicationTaskDetails { + s.ReplicationInstanceArn = &v + return s +} + +// SetReplicationTaskIdentifier sets the ReplicationTaskIdentifier field's value. +func (s *AwsDmsReplicationTaskDetails) SetReplicationTaskIdentifier(v string) *AwsDmsReplicationTaskDetails { + s.ReplicationTaskIdentifier = &v + return s +} + +// SetReplicationTaskSettings sets the ReplicationTaskSettings field's value. +func (s *AwsDmsReplicationTaskDetails) SetReplicationTaskSettings(v string) *AwsDmsReplicationTaskDetails { + s.ReplicationTaskSettings = &v + return s +} + +// SetResourceIdentifier sets the ResourceIdentifier field's value. +func (s *AwsDmsReplicationTaskDetails) SetResourceIdentifier(v string) *AwsDmsReplicationTaskDetails { + s.ResourceIdentifier = &v + return s +} + +// SetSourceEndpointArn sets the SourceEndpointArn field's value. +func (s *AwsDmsReplicationTaskDetails) SetSourceEndpointArn(v string) *AwsDmsReplicationTaskDetails { + s.SourceEndpointArn = &v + return s +} + +// SetTableMappings sets the TableMappings field's value. +func (s *AwsDmsReplicationTaskDetails) SetTableMappings(v string) *AwsDmsReplicationTaskDetails { + s.TableMappings = &v + return s +} + +// SetTargetEndpointArn sets the TargetEndpointArn field's value. +func (s *AwsDmsReplicationTaskDetails) SetTargetEndpointArn(v string) *AwsDmsReplicationTaskDetails { + s.TargetEndpointArn = &v + return s +} + +// SetTaskData sets the TaskData field's value. +func (s *AwsDmsReplicationTaskDetails) SetTaskData(v string) *AwsDmsReplicationTaskDetails { + s.TaskData = &v + return s +} + // Contains a definition of an attribute for the table. type AwsDynamoDbTableAttributeDefinition struct { _ struct{} `type:"structure"` @@ -25296,6 +25808,9 @@ type AwsEcsTaskDefinitionDetails struct { // The task launch types that the task definition was validated against. RequiresCompatibilities []*string `type:"list"` + // The status of the task definition. + Status *string `type:"string"` + // The short name or ARN of the IAM role that grants containers in the task // permission to call Amazon Web Services API operations on your behalf. TaskRoleArn *string `type:"string"` @@ -25394,6 +25909,12 @@ func (s *AwsEcsTaskDefinitionDetails) SetRequiresCompatibilities(v []*string) *A return s } +// SetStatus sets the Status field's value. +func (s *AwsEcsTaskDefinitionDetails) SetStatus(v string) *AwsEcsTaskDefinitionDetails { + s.Status = &v + return s +} + // SetTaskRoleArn sets the TaskRoleArn field's value. func (s *AwsEcsTaskDefinitionDetails) SetTaskRoleArn(v string) *AwsEcsTaskDefinitionDetails { s.TaskRoleArn = &v @@ -28683,6 +29204,399 @@ func (s *AwsEventSchemasRegistryDetails) SetRegistryName(v string) *AwsEventSche return s } +// Provides details about an Amazon EventBridge global endpoint. The endpoint +// can improve your application’s availability by making it Regional-fault +// tolerant. +type AwsEventsEndpointDetails struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the endpoint. + Arn *string `type:"string"` + + // A description of the endpoint. + Description *string `type:"string"` + + // The URL subdomain of the endpoint. For example, if EndpointUrl is https://abcde.veo.endpoints.event.amazonaws.com, + // then the EndpointId is abcde.veo. + EndpointId *string `type:"string"` + + // The URL of the endpoint. + EndpointUrl *string `type:"string"` + + // The event buses being used by the endpoint. + EventBuses []*AwsEventsEndpointEventBusesDetails `type:"list"` + + // The name of the endpoint. + Name *string `type:"string"` + + // Whether event replication was enabled or disabled for this endpoint. The + // default state is ENABLED, which means you must supply a RoleArn. If you don't + // have a RoleArn or you don't want event replication enabled, set the state + // to DISABLED. + ReplicationConfig *AwsEventsEndpointReplicationConfigDetails `type:"structure"` + + // The ARN of the role used by event replication for the endpoint. + RoleArn *string `type:"string"` + + // The routing configuration of the endpoint. + RoutingConfig *AwsEventsEndpointRoutingConfigDetails `type:"structure"` + + // The current state of the endpoint. + State *string `type:"string"` + + // The reason the endpoint is in its current state. + StateReason *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 AwsEventsEndpointDetails) 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 AwsEventsEndpointDetails) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *AwsEventsEndpointDetails) SetArn(v string) *AwsEventsEndpointDetails { + s.Arn = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *AwsEventsEndpointDetails) SetDescription(v string) *AwsEventsEndpointDetails { + s.Description = &v + return s +} + +// SetEndpointId sets the EndpointId field's value. +func (s *AwsEventsEndpointDetails) SetEndpointId(v string) *AwsEventsEndpointDetails { + s.EndpointId = &v + return s +} + +// SetEndpointUrl sets the EndpointUrl field's value. +func (s *AwsEventsEndpointDetails) SetEndpointUrl(v string) *AwsEventsEndpointDetails { + s.EndpointUrl = &v + return s +} + +// SetEventBuses sets the EventBuses field's value. +func (s *AwsEventsEndpointDetails) SetEventBuses(v []*AwsEventsEndpointEventBusesDetails) *AwsEventsEndpointDetails { + s.EventBuses = v + return s +} + +// SetName sets the Name field's value. +func (s *AwsEventsEndpointDetails) SetName(v string) *AwsEventsEndpointDetails { + s.Name = &v + return s +} + +// SetReplicationConfig sets the ReplicationConfig field's value. +func (s *AwsEventsEndpointDetails) SetReplicationConfig(v *AwsEventsEndpointReplicationConfigDetails) *AwsEventsEndpointDetails { + s.ReplicationConfig = v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *AwsEventsEndpointDetails) SetRoleArn(v string) *AwsEventsEndpointDetails { + s.RoleArn = &v + return s +} + +// SetRoutingConfig sets the RoutingConfig field's value. +func (s *AwsEventsEndpointDetails) SetRoutingConfig(v *AwsEventsEndpointRoutingConfigDetails) *AwsEventsEndpointDetails { + s.RoutingConfig = v + return s +} + +// SetState sets the State field's value. +func (s *AwsEventsEndpointDetails) SetState(v string) *AwsEventsEndpointDetails { + s.State = &v + return s +} + +// SetStateReason sets the StateReason field's value. +func (s *AwsEventsEndpointDetails) SetStateReason(v string) *AwsEventsEndpointDetails { + s.StateReason = &v + return s +} + +// Provides details about the Amazon EventBridge event buses that the endpoint +// is associated with. +type AwsEventsEndpointEventBusesDetails struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the event bus that the endpoint is associated + // with. + EventBusArn *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 AwsEventsEndpointEventBusesDetails) 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 AwsEventsEndpointEventBusesDetails) GoString() string { + return s.String() +} + +// SetEventBusArn sets the EventBusArn field's value. +func (s *AwsEventsEndpointEventBusesDetails) SetEventBusArn(v string) *AwsEventsEndpointEventBusesDetails { + s.EventBusArn = &v + return s +} + +// Indicates whether replication is enabled or disabled for the endpoint. If +// enabled, the endpoint can replicate all events to a secondary Amazon Web +// Services Region. +type AwsEventsEndpointReplicationConfigDetails struct { + _ struct{} `type:"structure"` + + // The state of event replication. + State *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 AwsEventsEndpointReplicationConfigDetails) 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 AwsEventsEndpointReplicationConfigDetails) GoString() string { + return s.String() +} + +// SetState sets the State field's value. +func (s *AwsEventsEndpointReplicationConfigDetails) SetState(v string) *AwsEventsEndpointReplicationConfigDetails { + s.State = &v + return s +} + +// Provides details about the routing configuration of the endpoint. +type AwsEventsEndpointRoutingConfigDetails struct { + _ struct{} `type:"structure"` + + // The failover configuration for an endpoint. This includes what triggers failover + // and what happens when it's triggered. + FailoverConfig *AwsEventsEndpointRoutingConfigFailoverConfigDetails `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 AwsEventsEndpointRoutingConfigDetails) 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 AwsEventsEndpointRoutingConfigDetails) GoString() string { + return s.String() +} + +// SetFailoverConfig sets the FailoverConfig field's value. +func (s *AwsEventsEndpointRoutingConfigDetails) SetFailoverConfig(v *AwsEventsEndpointRoutingConfigFailoverConfigDetails) *AwsEventsEndpointRoutingConfigDetails { + s.FailoverConfig = v + return s +} + +// The failover configuration for an endpoint. This includes what triggers failover +// and what happens when it's triggered. +type AwsEventsEndpointRoutingConfigFailoverConfigDetails struct { + _ struct{} `type:"structure"` + + // The main Region of the endpoint. + Primary *AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails `type:"structure"` + + // The Region that events are routed to when failover is triggered or event + // replication is enabled. + Secondary *AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails `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 AwsEventsEndpointRoutingConfigFailoverConfigDetails) 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 AwsEventsEndpointRoutingConfigFailoverConfigDetails) GoString() string { + return s.String() +} + +// SetPrimary sets the Primary field's value. +func (s *AwsEventsEndpointRoutingConfigFailoverConfigDetails) SetPrimary(v *AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) *AwsEventsEndpointRoutingConfigFailoverConfigDetails { + s.Primary = v + return s +} + +// SetSecondary sets the Secondary field's value. +func (s *AwsEventsEndpointRoutingConfigFailoverConfigDetails) SetSecondary(v *AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) *AwsEventsEndpointRoutingConfigFailoverConfigDetails { + s.Secondary = v + return s +} + +// Provides details about the primary Amazon Web Services Region of the endpoint. +type AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the health check used by the endpoint to + // determine whether failover is triggered. + HealthCheck *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 AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) 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 AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) GoString() string { + return s.String() +} + +// SetHealthCheck sets the HealthCheck field's value. +func (s *AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails) SetHealthCheck(v string) *AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails { + s.HealthCheck = &v + return s +} + +// The Amazon Web Services Region that events are routed to when failover is +// triggered or event replication is enabled. +type AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails struct { + _ struct{} `type:"structure"` + + // Defines the secondary Region. + Route *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 AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) 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 AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) GoString() string { + return s.String() +} + +// SetRoute sets the Route field's value. +func (s *AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails) SetRoute(v string) *AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails { + s.Route = &v + return s +} + +// Provides details about Amazon EventBridge event bus. An event bus is a router +// that receives events and delivers them to zero or more destinations, or targets. +// This can be a custom event bus which you can use to receive events from your +// custom applications and services, or it can be a partner event bus which +// can be matched to a partner event source. +type AwsEventsEventbusDetails struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the account permitted to write events to + // the current account. + Arn *string `type:"string"` + + // The name of the event bus. + Name *string `type:"string"` + + // The policy that enables the external account to send events to your account. + Policy *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 AwsEventsEventbusDetails) 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 AwsEventsEventbusDetails) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *AwsEventsEventbusDetails) SetArn(v string) *AwsEventsEventbusDetails { + s.Arn = &v + return s +} + +// SetName sets the Name field's value. +func (s *AwsEventsEventbusDetails) SetName(v string) *AwsEventsEventbusDetails { + s.Name = &v + return s +} + +// SetPolicy sets the Policy field's value. +func (s *AwsEventsEventbusDetails) SetPolicy(v string) *AwsEventsEventbusDetails { + s.Policy = &v + return s +} + // An object that contains information on the status of CloudTrail as a data // source for the detector. type AwsGuardDutyDetectorDataSourcesCloudTrailDetails struct { @@ -31204,6 +32118,460 @@ func (s *AwsMountPoint) SetSourceVolume(v string) *AwsMountPoint { return s } +// Provides details about different modes of client authentication. +type AwsMskClusterClusterInfoClientAuthenticationDetails struct { + _ struct{} `type:"structure"` + + // Provides details for client authentication using SASL. + Sasl *AwsMskClusterClusterInfoClientAuthenticationSaslDetails `type:"structure"` + + // Provides details for client authentication using TLS. + Tls *AwsMskClusterClusterInfoClientAuthenticationTlsDetails `type:"structure"` + + // Provides details for allowing no client authentication. + Unauthenticated *AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails `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 AwsMskClusterClusterInfoClientAuthenticationDetails) 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 AwsMskClusterClusterInfoClientAuthenticationDetails) GoString() string { + return s.String() +} + +// SetSasl sets the Sasl field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationDetails) SetSasl(v *AwsMskClusterClusterInfoClientAuthenticationSaslDetails) *AwsMskClusterClusterInfoClientAuthenticationDetails { + s.Sasl = v + return s +} + +// SetTls sets the Tls field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationDetails) SetTls(v *AwsMskClusterClusterInfoClientAuthenticationTlsDetails) *AwsMskClusterClusterInfoClientAuthenticationDetails { + s.Tls = v + return s +} + +// SetUnauthenticated sets the Unauthenticated field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationDetails) SetUnauthenticated(v *AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) *AwsMskClusterClusterInfoClientAuthenticationDetails { + s.Unauthenticated = v + return s +} + +// Provides details for client authentication using SASL. +type AwsMskClusterClusterInfoClientAuthenticationSaslDetails struct { + _ struct{} `type:"structure"` + + // Provides details for SASL client authentication using IAM. + Iam *AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails `type:"structure"` + + // Details for SASL client authentication using SCRAM. + Scram *AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails `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 AwsMskClusterClusterInfoClientAuthenticationSaslDetails) 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 AwsMskClusterClusterInfoClientAuthenticationSaslDetails) GoString() string { + return s.String() +} + +// SetIam sets the Iam field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationSaslDetails) SetIam(v *AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) *AwsMskClusterClusterInfoClientAuthenticationSaslDetails { + s.Iam = v + return s +} + +// SetScram sets the Scram field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationSaslDetails) SetScram(v *AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) *AwsMskClusterClusterInfoClientAuthenticationSaslDetails { + s.Scram = v + return s +} + +// Details for SASL/IAM client authentication. +type AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails struct { + _ struct{} `type:"structure"` + + // Indicates whether SASL/IAM authentication is enabled or not. + Enabled *bool `type:"boolean"` +} + +// 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 AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) 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 AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) GoString() string { + return s.String() +} + +// SetEnabled sets the Enabled field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails) SetEnabled(v bool) *AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails { + s.Enabled = &v + return s +} + +// Details for SASL/SCRAM client authentication. +type AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails struct { + _ struct{} `type:"structure"` + + // Indicates whether SASL/SCRAM authentication is enabled or not. + Enabled *bool `type:"boolean"` +} + +// 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 AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) 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 AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) GoString() string { + return s.String() +} + +// SetEnabled sets the Enabled field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails) SetEnabled(v bool) *AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails { + s.Enabled = &v + return s +} + +// Provides details for client authentication using TLS. +type AwsMskClusterClusterInfoClientAuthenticationTlsDetails struct { + _ struct{} `type:"structure"` + + // List of Amazon Web Services Private CA Amazon Resource Names (ARNs). Amazon + // Web Services Private CA enables creation of private certificate authority + // (CA) hierarchies, including root and subordinate CAs, without the investment + // and maintenance costs of operating an on-premises CA. + CertificateAuthorityArnList []*string `type:"list"` + + // Indicates whether TLS authentication is enabled or not. + Enabled *bool `type:"boolean"` +} + +// 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 AwsMskClusterClusterInfoClientAuthenticationTlsDetails) 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 AwsMskClusterClusterInfoClientAuthenticationTlsDetails) GoString() string { + return s.String() +} + +// SetCertificateAuthorityArnList sets the CertificateAuthorityArnList field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationTlsDetails) SetCertificateAuthorityArnList(v []*string) *AwsMskClusterClusterInfoClientAuthenticationTlsDetails { + s.CertificateAuthorityArnList = v + return s +} + +// SetEnabled sets the Enabled field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationTlsDetails) SetEnabled(v bool) *AwsMskClusterClusterInfoClientAuthenticationTlsDetails { + s.Enabled = &v + return s +} + +// Provides details for allowing no client authentication. +type AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails struct { + _ struct{} `type:"structure"` + + // Indicates whether unauthenticated is allowed or not. + Enabled *bool `type:"boolean"` +} + +// 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 AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) 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 AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) GoString() string { + return s.String() +} + +// SetEnabled sets the Enabled field's value. +func (s *AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails) SetEnabled(v bool) *AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails { + s.Enabled = &v + return s +} + +// Provide details about an Amazon MSK cluster. +type AwsMskClusterClusterInfoDetails struct { + _ struct{} `type:"structure"` + + // Provides information for different modes of client authentication. + ClientAuthentication *AwsMskClusterClusterInfoClientAuthenticationDetails `type:"structure"` + + // The name of the cluster. + ClusterName *string `type:"string"` + + // The current version of the MSK cluster. + CurrentVersion *string `type:"string"` + + // Includes encryption-related information, such as the KMS key used for encrypting + // data at rest and whether you want Amazon MSK to encrypt your data in transit. + EncryptionInfo *AwsMskClusterClusterInfoEncryptionInfoDetails `type:"structure"` + + // The number of broker nodes in the cluster. + NumberOfBrokerNodes *int64 `type:"integer"` +} + +// 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 AwsMskClusterClusterInfoDetails) 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 AwsMskClusterClusterInfoDetails) GoString() string { + return s.String() +} + +// SetClientAuthentication sets the ClientAuthentication field's value. +func (s *AwsMskClusterClusterInfoDetails) SetClientAuthentication(v *AwsMskClusterClusterInfoClientAuthenticationDetails) *AwsMskClusterClusterInfoDetails { + s.ClientAuthentication = v + return s +} + +// SetClusterName sets the ClusterName field's value. +func (s *AwsMskClusterClusterInfoDetails) SetClusterName(v string) *AwsMskClusterClusterInfoDetails { + s.ClusterName = &v + return s +} + +// SetCurrentVersion sets the CurrentVersion field's value. +func (s *AwsMskClusterClusterInfoDetails) SetCurrentVersion(v string) *AwsMskClusterClusterInfoDetails { + s.CurrentVersion = &v + return s +} + +// SetEncryptionInfo sets the EncryptionInfo field's value. +func (s *AwsMskClusterClusterInfoDetails) SetEncryptionInfo(v *AwsMskClusterClusterInfoEncryptionInfoDetails) *AwsMskClusterClusterInfoDetails { + s.EncryptionInfo = v + return s +} + +// SetNumberOfBrokerNodes sets the NumberOfBrokerNodes field's value. +func (s *AwsMskClusterClusterInfoDetails) SetNumberOfBrokerNodes(v int64) *AwsMskClusterClusterInfoDetails { + s.NumberOfBrokerNodes = &v + return s +} + +// Includes encryption-related information, such as the KMS key used for encrypting +// data at rest and whether you want MSK to encrypt your data in transit. +type AwsMskClusterClusterInfoEncryptionInfoDetails struct { + _ struct{} `type:"structure"` + + // The data-volume encryption details. You can't update encryption at rest settings + // for existing clusters. + EncryptionAtRest *AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails `type:"structure"` + + // The settings for encrypting data in transit. + EncryptionInTransit *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails `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 AwsMskClusterClusterInfoEncryptionInfoDetails) 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 AwsMskClusterClusterInfoEncryptionInfoDetails) GoString() string { + return s.String() +} + +// SetEncryptionAtRest sets the EncryptionAtRest field's value. +func (s *AwsMskClusterClusterInfoEncryptionInfoDetails) SetEncryptionAtRest(v *AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) *AwsMskClusterClusterInfoEncryptionInfoDetails { + s.EncryptionAtRest = v + return s +} + +// SetEncryptionInTransit sets the EncryptionInTransit field's value. +func (s *AwsMskClusterClusterInfoEncryptionInfoDetails) SetEncryptionInTransit(v *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) *AwsMskClusterClusterInfoEncryptionInfoDetails { + s.EncryptionInTransit = v + return s +} + +// The data-volume encryption details. You can't update encryption at rest settings +// for existing clusters. +type AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest. + // If you don't specify a KMS key, MSK creates one for you and uses it. + DataVolumeKMSKeyId *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 AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) 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 AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) GoString() string { + return s.String() +} + +// SetDataVolumeKMSKeyId sets the DataVolumeKMSKeyId field's value. +func (s *AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails) SetDataVolumeKMSKeyId(v string) *AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails { + s.DataVolumeKMSKeyId = &v + return s +} + +// The settings for encrypting data in transit. +type AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails struct { + _ struct{} `type:"structure"` + + // Indicates the encryption setting for data in transit between clients and + // brokers. + ClientBroker *string `type:"string"` + + // When set to true, it indicates that data communication among the broker nodes + // of the cluster is encrypted. When set to false, the communication happens + // in plain text. The default value is true. + InCluster *bool `type:"boolean"` +} + +// 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 AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) 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 AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) GoString() string { + return s.String() +} + +// SetClientBroker sets the ClientBroker field's value. +func (s *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) SetClientBroker(v string) *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails { + s.ClientBroker = &v + return s +} + +// SetInCluster sets the InCluster field's value. +func (s *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails) SetInCluster(v bool) *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails { + s.InCluster = &v + return s +} + +// Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon +// MSK) cluster. +type AwsMskClusterDetails struct { + _ struct{} `type:"structure"` + + // Provides information about a cluster. + ClusterInfo *AwsMskClusterClusterInfoDetails `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 AwsMskClusterDetails) 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 AwsMskClusterDetails) GoString() string { + return s.String() +} + +// SetClusterInfo sets the ClusterInfo field's value. +func (s *AwsMskClusterDetails) SetClusterInfo(v *AwsMskClusterClusterInfoDetails) *AwsMskClusterDetails { + s.ClusterInfo = v + return s +} + // Details about an Network Firewall firewall. type AwsNetworkFirewallFirewallDetails struct { _ struct{} `type:"structure"` @@ -32388,6 +33756,9 @@ type AwsRdsDbClusterDetails struct { // A list of the IAM roles that are associated with the DB cluster. AssociatedRoles []*AwsRdsDbClusterAssociatedRole `type:"list"` + // Indicates if minor version upgrades are automatically applied to the cluster. + AutoMinorVersionUpgrade *bool `type:"boolean"` + // A list of Availability Zones (AZs) where instances in the DB cluster can // be created. AvailabilityZones []*string `type:"list"` @@ -32569,6 +33940,12 @@ func (s *AwsRdsDbClusterDetails) SetAssociatedRoles(v []*AwsRdsDbClusterAssociat return s } +// SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value. +func (s *AwsRdsDbClusterDetails) SetAutoMinorVersionUpgrade(v bool) *AwsRdsDbClusterDetails { + s.AutoMinorVersionUpgrade = &v + return s +} + // SetAvailabilityZones sets the AvailabilityZones field's value. func (s *AwsRdsDbClusterDetails) SetAvailabilityZones(v []*string) *AwsRdsDbClusterDetails { s.AvailabilityZones = v @@ -36490,6 +37867,232 @@ func (s *AwsRedshiftClusterVpcSecurityGroup) SetVpcSecurityGroupId(v string) *Aw return s } +// An object that contains an optional comment about your Amazon Route 53 hosted +// zone. +type AwsRoute53HostedZoneConfigDetails struct { + _ struct{} `type:"structure"` + + // Any comments that you include about the hosted zone. + Comment *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 AwsRoute53HostedZoneConfigDetails) 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 AwsRoute53HostedZoneConfigDetails) GoString() string { + return s.String() +} + +// SetComment sets the Comment field's value. +func (s *AwsRoute53HostedZoneConfigDetails) SetComment(v string) *AwsRoute53HostedZoneConfigDetails { + s.Comment = &v + return s +} + +// Provides details about a specified Amazon Route 53 hosted zone, including +// the four name servers assigned to the hosted zone. A hosted zone represents +// a collection of records that can be managed together, belonging to a single +// parent domain name. +type AwsRoute53HostedZoneDetails struct { + _ struct{} `type:"structure"` + + // An object that contains information about the specified hosted zone. + HostedZone *AwsRoute53HostedZoneObjectDetails `type:"structure"` + + // An object that contains a list of the authoritative name servers for a hosted + // zone or for a reusable delegation set. + NameServers []*string `type:"list"` + + // An array that contains one QueryLoggingConfig element for each DNS query + // logging configuration that is associated with the current Amazon Web Services + // account. + QueryLoggingConfig *AwsRoute53QueryLoggingConfigDetails `type:"structure"` + + // An object that contains information about the Amazon Virtual Private Clouds + // (Amazon VPCs) that are associated with the specified hosted zone. + Vpcs []*AwsRoute53HostedZoneVpcDetails `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 AwsRoute53HostedZoneDetails) 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 AwsRoute53HostedZoneDetails) GoString() string { + return s.String() +} + +// SetHostedZone sets the HostedZone field's value. +func (s *AwsRoute53HostedZoneDetails) SetHostedZone(v *AwsRoute53HostedZoneObjectDetails) *AwsRoute53HostedZoneDetails { + s.HostedZone = v + return s +} + +// SetNameServers sets the NameServers field's value. +func (s *AwsRoute53HostedZoneDetails) SetNameServers(v []*string) *AwsRoute53HostedZoneDetails { + s.NameServers = v + return s +} + +// SetQueryLoggingConfig sets the QueryLoggingConfig field's value. +func (s *AwsRoute53HostedZoneDetails) SetQueryLoggingConfig(v *AwsRoute53QueryLoggingConfigDetails) *AwsRoute53HostedZoneDetails { + s.QueryLoggingConfig = v + return s +} + +// SetVpcs sets the Vpcs field's value. +func (s *AwsRoute53HostedZoneDetails) SetVpcs(v []*AwsRoute53HostedZoneVpcDetails) *AwsRoute53HostedZoneDetails { + s.Vpcs = v + return s +} + +// An object that contains information about an Amazon Route 53 hosted zone. +type AwsRoute53HostedZoneObjectDetails struct { + _ struct{} `type:"structure"` + + // An object that includes the Comment element. + Config *AwsRoute53HostedZoneConfigDetails `type:"structure"` + + // The ID that Route 53 assigns to the hosted zone when you create it. + Id *string `type:"string"` + + // The name of the domain. For public hosted zones, this is the name that you + // have registered with your DNS registrar. + Name *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 AwsRoute53HostedZoneObjectDetails) 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 AwsRoute53HostedZoneObjectDetails) GoString() string { + return s.String() +} + +// SetConfig sets the Config field's value. +func (s *AwsRoute53HostedZoneObjectDetails) SetConfig(v *AwsRoute53HostedZoneConfigDetails) *AwsRoute53HostedZoneObjectDetails { + s.Config = v + return s +} + +// SetId sets the Id field's value. +func (s *AwsRoute53HostedZoneObjectDetails) SetId(v string) *AwsRoute53HostedZoneObjectDetails { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *AwsRoute53HostedZoneObjectDetails) SetName(v string) *AwsRoute53HostedZoneObjectDetails { + s.Name = &v + return s +} + +// For private hosted zones, this is a complex type that contains information +// about an Amazon VPC. +type AwsRoute53HostedZoneVpcDetails struct { + _ struct{} `type:"structure"` + + // The identifier of an Amazon VPC. + Id *string `type:"string"` + + // The Amazon Web Services Region that an Amazon VPC was created in. + Region *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 AwsRoute53HostedZoneVpcDetails) 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 AwsRoute53HostedZoneVpcDetails) GoString() string { + return s.String() +} + +// SetId sets the Id field's value. +func (s *AwsRoute53HostedZoneVpcDetails) SetId(v string) *AwsRoute53HostedZoneVpcDetails { + s.Id = &v + return s +} + +// SetRegion sets the Region field's value. +func (s *AwsRoute53HostedZoneVpcDetails) SetRegion(v string) *AwsRoute53HostedZoneVpcDetails { + s.Region = &v + return s +} + +// Provides details about a specified Amazon Route 53 configuration for DNS +// query logging. +type AwsRoute53QueryLoggingConfigDetails struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that + // Route 53 is publishing logs to. + CloudWatchLogsLogGroupArn *CloudWatchLogsLogGroupArnConfigDetails `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 AwsRoute53QueryLoggingConfigDetails) 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 AwsRoute53QueryLoggingConfigDetails) GoString() string { + return s.String() +} + +// SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value. +func (s *AwsRoute53QueryLoggingConfigDetails) SetCloudWatchLogsLogGroupArn(v *CloudWatchLogsLogGroupArnConfigDetails) *AwsRoute53QueryLoggingConfigDetails { + s.CloudWatchLogsLogGroupArn = v + return s +} + // provides information about the Amazon S3 Public Access Block configuration // for accounts. type AwsS3AccountPublicAccessBlockDetails struct { @@ -44500,6 +46103,58 @@ func (s *ClassificationStatus) SetReason(v string) *ClassificationStatus { return s } +// The Amazon Resource Name (ARN) and other details of the Amazon CloudWatch +// Logs log group that Amazon Route 53 is publishing logs to. +type CloudWatchLogsLogGroupArnConfigDetails struct { + _ struct{} `type:"structure"` + + // The ARN of the CloudWatch Logs log group that Route 53 is publishing logs + // to. + CloudWatchLogsLogGroupArn *string `type:"string"` + + // The ID of the hosted zone that CloudWatch Logs is logging queries for. + HostedZoneId *string `type:"string"` + + // The ID for a DNS query logging configuration. + Id *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 CloudWatchLogsLogGroupArnConfigDetails) 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 CloudWatchLogsLogGroupArnConfigDetails) GoString() string { + return s.String() +} + +// SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value. +func (s *CloudWatchLogsLogGroupArnConfigDetails) SetCloudWatchLogsLogGroupArn(v string) *CloudWatchLogsLogGroupArnConfigDetails { + s.CloudWatchLogsLogGroupArn = &v + return s +} + +// SetHostedZoneId sets the HostedZoneId field's value. +func (s *CloudWatchLogsLogGroupArnConfigDetails) SetHostedZoneId(v string) *CloudWatchLogsLogGroupArnConfigDetails { + s.HostedZoneId = &v + return s +} + +// SetId sets the Id field's value. +func (s *CloudWatchLogsLogGroupArnConfigDetails) SetId(v string) *CloudWatchLogsLogGroupArnConfigDetails { + s.Id = &v + return s +} + // Provides details about where a code vulnerability is located in your Lambda // function. type CodeVulnerabilitiesFilePath struct { @@ -53027,6 +54682,20 @@ type ResourceDetails struct { // Details for an CodeBuild project. AwsCodeBuildProject *AwsCodeBuildProjectDetails `type:"structure"` + // Provides details about an Database Migration Service (DMS) endpoint. An endpoint + // provides connection, data store type, and location information about your + // data store. + AwsDmsEndpoint *AwsDmsEndpointDetails `type:"structure"` + + // Provides details about an DMS replication instance. DMS uses a replication + // instance to connect to your source data store, read the source data, and + // format the data for consumption by the target data store. + AwsDmsReplicationInstance *AwsDmsReplicationInstanceDetails `type:"structure"` + + // Provides details about an DMS replication task. A replication task moves + // a set of data from the source endpoint to the target endpoint. + AwsDmsReplicationTask *AwsDmsReplicationTaskDetails `type:"structure"` + // Details about a DynamoDB table. AwsDynamoDbTable *AwsDynamoDbTableDetails `type:"structure"` @@ -53126,6 +54795,16 @@ type ResourceDetails struct { // so that your schemas are in logical groups. AwsEventSchemasRegistry *AwsEventSchemasRegistryDetails `type:"structure"` + // Provides details about an Amazon EventBridge global endpoint. The endpoint + // can improve your application’s availability by making it Regional-fault + // tolerant. + AwsEventsEndpoint *AwsEventsEndpointDetails `type:"structure"` + + // Provides details about Amazon EventBridge event bus for an endpoint. An event + // bus is a router that receives events and delivers them to zero or more destinations, + // or targets. + AwsEventsEventbus *AwsEventsEventbusDetails `type:"structure"` + // Provides details about an Amazon GuardDuty detector. A detector is an object // that represents the GuardDuty service. A detector is required for GuardDuty // to become operational. @@ -53158,6 +54837,10 @@ type ResourceDetails struct { // Details for a Lambda layer version. AwsLambdaLayerVersion *AwsLambdaLayerVersionDetails `type:"structure"` + // Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon + // MSK) cluster. + AwsMskCluster *AwsMskClusterDetails `type:"structure"` + // Details about an Network Firewall firewall. AwsNetworkFirewallFirewall *AwsNetworkFirewallFirewallDetails `type:"structure"` @@ -53191,6 +54874,12 @@ type ResourceDetails struct { // Contains details about an Amazon Redshift cluster. AwsRedshiftCluster *AwsRedshiftClusterDetails `type:"structure"` + // Provides details about an Amazon Route 53 hosted zone, including the four + // name servers assigned to the hosted zone. A hosted zone represents a collection + // of records that can be managed together, belonging to a single parent domain + // name. + AwsRoute53HostedZone *AwsRoute53HostedZoneDetails `type:"structure"` + // Details about the Amazon S3 Public Access Block configuration for an account. AwsS3AccountPublicAccessBlock *AwsS3AccountPublicAccessBlockDetails `type:"structure"` @@ -53410,6 +55099,24 @@ func (s *ResourceDetails) SetAwsCodeBuildProject(v *AwsCodeBuildProjectDetails) return s } +// SetAwsDmsEndpoint sets the AwsDmsEndpoint field's value. +func (s *ResourceDetails) SetAwsDmsEndpoint(v *AwsDmsEndpointDetails) *ResourceDetails { + s.AwsDmsEndpoint = v + return s +} + +// SetAwsDmsReplicationInstance sets the AwsDmsReplicationInstance field's value. +func (s *ResourceDetails) SetAwsDmsReplicationInstance(v *AwsDmsReplicationInstanceDetails) *ResourceDetails { + s.AwsDmsReplicationInstance = v + return s +} + +// SetAwsDmsReplicationTask sets the AwsDmsReplicationTask field's value. +func (s *ResourceDetails) SetAwsDmsReplicationTask(v *AwsDmsReplicationTaskDetails) *ResourceDetails { + s.AwsDmsReplicationTask = v + return s +} + // SetAwsDynamoDbTable sets the AwsDynamoDbTable field's value. func (s *ResourceDetails) SetAwsDynamoDbTable(v *AwsDynamoDbTableDetails) *ResourceDetails { s.AwsDynamoDbTable = v @@ -53584,6 +55291,18 @@ func (s *ResourceDetails) SetAwsEventSchemasRegistry(v *AwsEventSchemasRegistryD return s } +// SetAwsEventsEndpoint sets the AwsEventsEndpoint field's value. +func (s *ResourceDetails) SetAwsEventsEndpoint(v *AwsEventsEndpointDetails) *ResourceDetails { + s.AwsEventsEndpoint = v + return s +} + +// SetAwsEventsEventbus sets the AwsEventsEventbus field's value. +func (s *ResourceDetails) SetAwsEventsEventbus(v *AwsEventsEventbusDetails) *ResourceDetails { + s.AwsEventsEventbus = v + return s +} + // SetAwsGuardDutyDetector sets the AwsGuardDutyDetector field's value. func (s *ResourceDetails) SetAwsGuardDutyDetector(v *AwsGuardDutyDetectorDetails) *ResourceDetails { s.AwsGuardDutyDetector = v @@ -53644,6 +55363,12 @@ func (s *ResourceDetails) SetAwsLambdaLayerVersion(v *AwsLambdaLayerVersionDetai return s } +// SetAwsMskCluster sets the AwsMskCluster field's value. +func (s *ResourceDetails) SetAwsMskCluster(v *AwsMskClusterDetails) *ResourceDetails { + s.AwsMskCluster = v + return s +} + // SetAwsNetworkFirewallFirewall sets the AwsNetworkFirewallFirewall field's value. func (s *ResourceDetails) SetAwsNetworkFirewallFirewall(v *AwsNetworkFirewallFirewallDetails) *ResourceDetails { s.AwsNetworkFirewallFirewall = v @@ -53710,6 +55435,12 @@ func (s *ResourceDetails) SetAwsRedshiftCluster(v *AwsRedshiftClusterDetails) *R return s } +// SetAwsRoute53HostedZone sets the AwsRoute53HostedZone field's value. +func (s *ResourceDetails) SetAwsRoute53HostedZone(v *AwsRoute53HostedZoneDetails) *ResourceDetails { + s.AwsRoute53HostedZone = v + return s +} + // SetAwsS3AccountPublicAccessBlock sets the AwsS3AccountPublicAccessBlock field's value. func (s *ResourceDetails) SetAwsS3AccountPublicAccessBlock(v *AwsS3AccountPublicAccessBlockDetails) *ResourceDetails { s.AwsS3AccountPublicAccessBlock = v diff --git a/service/storagegateway/api.go b/service/storagegateway/api.go index 61c83d78091..cd7fa8ff931 100644 --- a/service/storagegateway/api.go +++ b/service/storagegateway/api.go @@ -3354,10 +3354,9 @@ func (c *StorageGateway) DescribeGatewayInformationRequest(input *DescribeGatewa // DescribeGatewayInformation API operation for AWS Storage Gateway. // -// Returns metadata about a gateway such as its name, network interfaces, configured -// time zone, and the state (whether the gateway is running or not). To specify -// which gateway to describe, use the Amazon Resource Name (ARN) of the gateway -// in your request. +// Returns metadata about a gateway such as its name, network interfaces, time +// zone, status, and software version. To specify which gateway to describe, +// use the Amazon Resource Name (ARN) of the gateway in your request. // // 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 @@ -4985,6 +4984,16 @@ func (c *StorageGateway) JoinDomainRequest(input *JoinDomainInput) (req *request // Adds a file gateway to an Active Directory domain. This operation is only // supported for file gateways that support the SMB file protocol. // +// Joining a domain creates an Active Directory computer account in the default +// organizational unit, using the gateway's Gateway ID as the account name (for +// example, SGW-1234ADE). If your Active Directory environment requires that +// you pre-stage accounts to facilitate the join domain process, you will need +// to create this account ahead of time. +// +// To create the gateway's computer account in an organizational unit other +// than the default, you must specify the organizational unit when joining the +// domain. +// // 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. @@ -5161,8 +5170,8 @@ func (c *StorageGateway) ListFileSharesRequest(input *ListFileSharesInput) (req // ListFileShares API operation for AWS Storage Gateway. // // Gets a list of the file shares for a specific S3 File Gateway, or the list -// of file shares that belong to the calling user account. This operation is -// only supported for S3 File Gateways. +// of file shares that belong to the calling Amazon Web Services account. This +// operation is only supported for S3 File Gateways. // // 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 @@ -6468,8 +6477,8 @@ func (c *StorageGateway) NotifyWhenUploadedRequest(input *NotifyWhenUploadedInpu // event targets such as Amazon SNS or Lambda function. This operation is only // supported for S3 File Gateways. // -// For more information, see Getting file upload notification (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification) -// in the Storage Gateway User Guide. +// For more information, see Getting file upload notification (https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) +// in the Amazon S3 File Gateway 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 @@ -6582,9 +6591,6 @@ func (c *StorageGateway) RefreshCacheRequest(input *RefreshCacheInput) (req *req // // - Wait at least 60 seconds between consecutive RefreshCache API requests. // -// - RefreshCache does not evict cache entries if invoked consecutively within -// 60 seconds of a previous RefreshCache request. -// // - If you invoke the RefreshCache API when two requests are already being // processed, any new request will cause an InvalidGatewayRequestException // error because too many requests were sent to the server. @@ -7693,8 +7699,9 @@ func (c *StorageGateway) UpdateBandwidthRateLimitScheduleRequest(input *UpdateBa // Updates the bandwidth rate limit schedule for a specified gateway. By default, // gateways do not have bandwidth rate limit schedules, which means no bandwidth // rate limiting is in effect. Use this to initiate or update a gateway's bandwidth -// rate limit schedule. This operation is supported only for volume, tape and -// S3 file gateways. FSx file gateways do not support bandwidth rate limits. +// rate limit schedule. This operation is supported for volume, tape, and S3 +// file gateways. S3 file gateways support bandwidth rate limits for upload +// only. FSx file gateways do not support bandwidth rate limits. // // 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 @@ -10151,6 +10158,10 @@ type BandwidthRateLimitInterval struct { // The average upload rate limit component of the bandwidth rate limit interval, // in bits per second. This field does not appear in the response if the upload // rate limit is not set. + // + // For Tape Gateway and Volume Gateway, the minimum value is 51200. + // + // For S3 File Gateway and FSx File Gateway, the minimum value is 104857600. AverageUploadRateLimitInBitsPerSec *int64 `min:"51200" type:"long"` // The days of the week component of the bandwidth rate limit interval, represented @@ -14791,6 +14802,9 @@ type DescribeGatewayInformationOutput struct { // Date after which this gateway will not receive software updates for new features. SoftwareUpdatesEndDate *string `min:"1" type:"string"` + // The version number of the software running on the gateway appliance. + SoftwareVersion *string `type:"string"` + // A list of the metadata cache sizes that the gateway can support based on // its current hardware specifications. SupportedGatewayCapacities []*string `type:"list" enum:"GatewayCapacity"` @@ -14931,6 +14945,12 @@ func (s *DescribeGatewayInformationOutput) SetSoftwareUpdatesEndDate(v string) * return s } +// SetSoftwareVersion sets the SoftwareVersion field's value. +func (s *DescribeGatewayInformationOutput) SetSoftwareVersion(v string) *DescribeGatewayInformationOutput { + s.SoftwareVersion = &v + return s +} + // SetSupportedGatewayCapacities sets the SupportedGatewayCapacities field's value. func (s *DescribeGatewayInformationOutput) SetSupportedGatewayCapacities(v []*string) *DescribeGatewayInformationOutput { s.SupportedGatewayCapacities = v @@ -19331,7 +19351,7 @@ func (s *NFSFileShareInfo) SetVPCEndpointDNSName(v string) *NFSFileShareInfo { // Describes a gateway's network interface. type NetworkInterface struct { - _ struct{} `type:"structure"` + _ struct{} `type:"structure" sensitive:"true"` // The Internet Protocol version 4 (IPv4) address of the interface. Ipv4Address *string `type:"string"` diff --git a/service/workspaces/api.go b/service/workspaces/api.go index fd9a86ec948..8614ddc5246 100644 --- a/service/workspaces/api.go +++ b/service/workspaces/api.go @@ -207,6 +207,112 @@ func (c *WorkSpaces) AssociateIpGroupsWithContext(ctx aws.Context, input *Associ return out, req.Send() } +const opAssociateWorkspaceApplication = "AssociateWorkspaceApplication" + +// AssociateWorkspaceApplicationRequest generates a "aws/request.Request" representing the +// client's request for the AssociateWorkspaceApplication 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 AssociateWorkspaceApplication for more information on using the AssociateWorkspaceApplication +// 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 AssociateWorkspaceApplicationRequest method. +// req, resp := client.AssociateWorkspaceApplicationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateWorkspaceApplication +func (c *WorkSpaces) AssociateWorkspaceApplicationRequest(input *AssociateWorkspaceApplicationInput) (req *request.Request, output *AssociateWorkspaceApplicationOutput) { + op := &request.Operation{ + Name: opAssociateWorkspaceApplication, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &AssociateWorkspaceApplicationInput{} + } + + output = &AssociateWorkspaceApplicationOutput{} + req = c.newRequest(op, input, output) + return +} + +// AssociateWorkspaceApplication API operation for Amazon WorkSpaces. +// +// Associates the specified application to the specified WorkSpace. +// +// 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 Amazon WorkSpaces's +// API operation AssociateWorkspaceApplication for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - OperationNotSupportedException +// This operation is not supported. +// +// - ResourceAlreadyExistsException +// The specified resource already exists. +// +// - ResourceInUseException +// The specified resource is currently in use. +// +// - ResourceNotFoundException +// The resource could not be found. +// +// - ComputeNotCompatibleException +// The compute type of the WorkSpace is not compatible with the application. +// +// - OperatingSystemNotCompatibleException +// The operating system of the WorkSpace is not compatible with the application. +// +// - ApplicationNotSupportedException +// The specified application is not supported. +// +// - IncompatibleApplicationsException +// The specified application is not compatible with the resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateWorkspaceApplication +func (c *WorkSpaces) AssociateWorkspaceApplication(input *AssociateWorkspaceApplicationInput) (*AssociateWorkspaceApplicationOutput, error) { + req, out := c.AssociateWorkspaceApplicationRequest(input) + return out, req.Send() +} + +// AssociateWorkspaceApplicationWithContext is the same as AssociateWorkspaceApplication with the addition of +// the ability to pass a context and additional request options. +// +// See AssociateWorkspaceApplication 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 *WorkSpaces) AssociateWorkspaceApplicationWithContext(ctx aws.Context, input *AssociateWorkspaceApplicationInput, opts ...request.Option) (*AssociateWorkspaceApplicationOutput, error) { + req, out := c.AssociateWorkspaceApplicationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opAuthorizeIpRules = "AuthorizeIpRules" // AuthorizeIpRulesRequest generates a "aws/request.Request" representing the @@ -1912,6 +2018,100 @@ func (c *WorkSpaces) DeleteWorkspaceImageWithContext(ctx aws.Context, input *Del return out, req.Send() } +const opDeployWorkspaceApplications = "DeployWorkspaceApplications" + +// DeployWorkspaceApplicationsRequest generates a "aws/request.Request" representing the +// client's request for the DeployWorkspaceApplications 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 DeployWorkspaceApplications for more information on using the DeployWorkspaceApplications +// 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 DeployWorkspaceApplicationsRequest method. +// req, resp := client.DeployWorkspaceApplicationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeployWorkspaceApplications +func (c *WorkSpaces) DeployWorkspaceApplicationsRequest(input *DeployWorkspaceApplicationsInput) (req *request.Request, output *DeployWorkspaceApplicationsOutput) { + op := &request.Operation{ + Name: opDeployWorkspaceApplications, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeployWorkspaceApplicationsInput{} + } + + output = &DeployWorkspaceApplicationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeployWorkspaceApplications API operation for Amazon WorkSpaces. +// +// # Deploys associated applications to the specified WorkSpace +// +// 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 Amazon WorkSpaces's +// API operation DeployWorkspaceApplications for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - OperationNotSupportedException +// This operation is not supported. +// +// - ResourceInUseException +// The specified resource is currently in use. +// +// - ResourceNotFoundException +// The resource could not be found. +// +// - IncompatibleApplicationsException +// The specified application is not compatible with the resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeployWorkspaceApplications +func (c *WorkSpaces) DeployWorkspaceApplications(input *DeployWorkspaceApplicationsInput) (*DeployWorkspaceApplicationsOutput, error) { + req, out := c.DeployWorkspaceApplicationsRequest(input) + return out, req.Send() +} + +// DeployWorkspaceApplicationsWithContext is the same as DeployWorkspaceApplications with the addition of +// the ability to pass a context and additional request options. +// +// See DeployWorkspaceApplications 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 *WorkSpaces) DeployWorkspaceApplicationsWithContext(ctx aws.Context, input *DeployWorkspaceApplicationsInput, opts ...request.Option) (*DeployWorkspaceApplicationsOutput, error) { + req, out := c.DeployWorkspaceApplicationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeregisterWorkspaceDirectory = "DeregisterWorkspaceDirectory" // DeregisterWorkspaceDirectoryRequest generates a "aws/request.Request" representing the @@ -2175,1254 +2375,1283 @@ func (c *WorkSpaces) DescribeAccountModificationsWithContext(ctx aws.Context, in return out, req.Send() } -const opDescribeClientBranding = "DescribeClientBranding" +const opDescribeApplicationAssociations = "DescribeApplicationAssociations" -// DescribeClientBrandingRequest generates a "aws/request.Request" representing the -// client's request for the DescribeClientBranding operation. The "output" return +// DescribeApplicationAssociationsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeApplicationAssociations 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 DescribeClientBranding for more information on using the DescribeClientBranding +// See DescribeApplicationAssociations for more information on using the DescribeApplicationAssociations // 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 DescribeClientBrandingRequest method. -// req, resp := client.DescribeClientBrandingRequest(params) +// // Example sending a request using the DescribeApplicationAssociationsRequest method. +// req, resp := client.DescribeApplicationAssociationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientBranding -func (c *WorkSpaces) DescribeClientBrandingRequest(input *DescribeClientBrandingInput) (req *request.Request, output *DescribeClientBrandingOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeApplicationAssociations +func (c *WorkSpaces) DescribeApplicationAssociationsRequest(input *DescribeApplicationAssociationsInput) (req *request.Request, output *DescribeApplicationAssociationsOutput) { op := &request.Operation{ - Name: opDescribeClientBranding, + Name: opDescribeApplicationAssociations, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &DescribeClientBrandingInput{} + input = &DescribeApplicationAssociationsInput{} } - output = &DescribeClientBrandingOutput{} + output = &DescribeApplicationAssociationsOutput{} req = c.newRequest(op, input, output) return } -// DescribeClientBranding API operation for Amazon WorkSpaces. -// -// Describes the specified client branding. Client branding allows you to customize -// the log in page of various device types for your users. You can add your -// company logo, the support email address, support link, link to reset password, -// and a custom message for users trying to sign in. +// DescribeApplicationAssociations API operation for Amazon WorkSpaces. // -// Only device types that have branding information configured will be shown -// in the response. +// Describes the associations between the application and the specified associated +// resources. // // 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 Amazon WorkSpaces's -// API operation DescribeClientBranding for usage and error information. +// API operation DescribeApplicationAssociations for usage and error information. // // Returned Error Types: // +// - AccessDeniedException +// The user is not authorized to access a resource. +// // - InvalidParameterValuesException // One or more parameter values are not valid. // +// - OperationNotSupportedException +// This operation is not supported. +// // - ResourceNotFoundException // The resource could not be found. // -// - AccessDeniedException -// The user is not authorized to access a resource. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientBranding -func (c *WorkSpaces) DescribeClientBranding(input *DescribeClientBrandingInput) (*DescribeClientBrandingOutput, error) { - req, out := c.DescribeClientBrandingRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeApplicationAssociations +func (c *WorkSpaces) DescribeApplicationAssociations(input *DescribeApplicationAssociationsInput) (*DescribeApplicationAssociationsOutput, error) { + req, out := c.DescribeApplicationAssociationsRequest(input) return out, req.Send() } -// DescribeClientBrandingWithContext is the same as DescribeClientBranding with the addition of +// DescribeApplicationAssociationsWithContext is the same as DescribeApplicationAssociations with the addition of // the ability to pass a context and additional request options. // -// See DescribeClientBranding for details on how to use this API operation. +// See DescribeApplicationAssociations 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 *WorkSpaces) DescribeClientBrandingWithContext(ctx aws.Context, input *DescribeClientBrandingInput, opts ...request.Option) (*DescribeClientBrandingOutput, error) { - req, out := c.DescribeClientBrandingRequest(input) +func (c *WorkSpaces) DescribeApplicationAssociationsWithContext(ctx aws.Context, input *DescribeApplicationAssociationsInput, opts ...request.Option) (*DescribeApplicationAssociationsOutput, error) { + req, out := c.DescribeApplicationAssociationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeClientProperties = "DescribeClientProperties" +// DescribeApplicationAssociationsPages iterates over the pages of a DescribeApplicationAssociations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeApplicationAssociations method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a DescribeApplicationAssociations operation. +// pageNum := 0 +// err := client.DescribeApplicationAssociationsPages(params, +// func(page *workspaces.DescribeApplicationAssociationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *WorkSpaces) DescribeApplicationAssociationsPages(input *DescribeApplicationAssociationsInput, fn func(*DescribeApplicationAssociationsOutput, bool) bool) error { + return c.DescribeApplicationAssociationsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// DescribeClientPropertiesRequest generates a "aws/request.Request" representing the -// client's request for the DescribeClientProperties operation. The "output" return +// DescribeApplicationAssociationsPagesWithContext same as DescribeApplicationAssociationsPages except +// it takes a Context and allows setting request options on the pages. +// +// 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 *WorkSpaces) DescribeApplicationAssociationsPagesWithContext(ctx aws.Context, input *DescribeApplicationAssociationsInput, fn func(*DescribeApplicationAssociationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeApplicationAssociationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeApplicationAssociationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeApplicationAssociationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opDescribeApplications = "DescribeApplications" + +// DescribeApplicationsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeApplications 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 DescribeClientProperties for more information on using the DescribeClientProperties +// See DescribeApplications for more information on using the DescribeApplications // 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 DescribeClientPropertiesRequest method. -// req, resp := client.DescribeClientPropertiesRequest(params) +// // Example sending a request using the DescribeApplicationsRequest method. +// req, resp := client.DescribeApplicationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientProperties -func (c *WorkSpaces) DescribeClientPropertiesRequest(input *DescribeClientPropertiesInput) (req *request.Request, output *DescribeClientPropertiesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeApplications +func (c *WorkSpaces) DescribeApplicationsRequest(input *DescribeApplicationsInput) (req *request.Request, output *DescribeApplicationsOutput) { op := &request.Operation{ - Name: opDescribeClientProperties, + Name: opDescribeApplications, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &DescribeClientPropertiesInput{} + input = &DescribeApplicationsInput{} } - output = &DescribeClientPropertiesOutput{} + output = &DescribeApplicationsOutput{} req = c.newRequest(op, input, output) return } -// DescribeClientProperties API operation for Amazon WorkSpaces. +// DescribeApplications API operation for Amazon WorkSpaces. // -// Retrieves a list that describes one or more specified Amazon WorkSpaces clients. +// Describes the specified applications by filtering based on their compute +// types, license availability, operating systems, and owners. // // 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 Amazon WorkSpaces's -// API operation DescribeClientProperties for usage and error information. +// API operation DescribeApplications for usage and error information. // // Returned Error Types: // +// - AccessDeniedException +// The user is not authorized to access a resource. +// // - InvalidParameterValuesException // One or more parameter values are not valid. // +// - OperationNotSupportedException +// This operation is not supported. +// // - ResourceNotFoundException // The resource could not be found. // -// - AccessDeniedException -// The user is not authorized to access a resource. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientProperties -func (c *WorkSpaces) DescribeClientProperties(input *DescribeClientPropertiesInput) (*DescribeClientPropertiesOutput, error) { - req, out := c.DescribeClientPropertiesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeApplications +func (c *WorkSpaces) DescribeApplications(input *DescribeApplicationsInput) (*DescribeApplicationsOutput, error) { + req, out := c.DescribeApplicationsRequest(input) return out, req.Send() } -// DescribeClientPropertiesWithContext is the same as DescribeClientProperties with the addition of +// DescribeApplicationsWithContext is the same as DescribeApplications with the addition of // the ability to pass a context and additional request options. // -// See DescribeClientProperties for details on how to use this API operation. +// See DescribeApplications 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 *WorkSpaces) DescribeClientPropertiesWithContext(ctx aws.Context, input *DescribeClientPropertiesInput, opts ...request.Option) (*DescribeClientPropertiesOutput, error) { - req, out := c.DescribeClientPropertiesRequest(input) +func (c *WorkSpaces) DescribeApplicationsWithContext(ctx aws.Context, input *DescribeApplicationsInput, opts ...request.Option) (*DescribeApplicationsOutput, error) { + req, out := c.DescribeApplicationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeConnectClientAddIns = "DescribeConnectClientAddIns" +// DescribeApplicationsPages iterates over the pages of a DescribeApplications operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeApplications method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a DescribeApplications operation. +// pageNum := 0 +// err := client.DescribeApplicationsPages(params, +// func(page *workspaces.DescribeApplicationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *WorkSpaces) DescribeApplicationsPages(input *DescribeApplicationsInput, fn func(*DescribeApplicationsOutput, bool) bool) error { + return c.DescribeApplicationsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// DescribeConnectClientAddInsRequest generates a "aws/request.Request" representing the -// client's request for the DescribeConnectClientAddIns operation. The "output" return +// DescribeApplicationsPagesWithContext same as DescribeApplicationsPages except +// it takes a Context and allows setting request options on the pages. +// +// 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 *WorkSpaces) DescribeApplicationsPagesWithContext(ctx aws.Context, input *DescribeApplicationsInput, fn func(*DescribeApplicationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeApplicationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeApplicationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeApplicationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opDescribeBundleAssociations = "DescribeBundleAssociations" + +// DescribeBundleAssociationsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeBundleAssociations 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 DescribeConnectClientAddIns for more information on using the DescribeConnectClientAddIns +// See DescribeBundleAssociations for more information on using the DescribeBundleAssociations // 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 DescribeConnectClientAddInsRequest method. -// req, resp := client.DescribeConnectClientAddInsRequest(params) +// // Example sending a request using the DescribeBundleAssociationsRequest method. +// req, resp := client.DescribeBundleAssociationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectClientAddIns -func (c *WorkSpaces) DescribeConnectClientAddInsRequest(input *DescribeConnectClientAddInsInput) (req *request.Request, output *DescribeConnectClientAddInsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeBundleAssociations +func (c *WorkSpaces) DescribeBundleAssociationsRequest(input *DescribeBundleAssociationsInput) (req *request.Request, output *DescribeBundleAssociationsOutput) { op := &request.Operation{ - Name: opDescribeConnectClientAddIns, + Name: opDescribeBundleAssociations, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeConnectClientAddInsInput{} + input = &DescribeBundleAssociationsInput{} } - output = &DescribeConnectClientAddInsOutput{} + output = &DescribeBundleAssociationsOutput{} req = c.newRequest(op, input, output) return } -// DescribeConnectClientAddIns API operation for Amazon WorkSpaces. +// DescribeBundleAssociations API operation for Amazon WorkSpaces. // -// Retrieves a list of Amazon Connect client add-ins that have been created. +// Describes the associations between the applications and the specified bundle. // // 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 Amazon WorkSpaces's -// API operation DescribeConnectClientAddIns for usage and error information. +// API operation DescribeBundleAssociations for usage and error information. // // Returned Error Types: // +// - AccessDeniedException +// The user is not authorized to access a resource. +// // - InvalidParameterValuesException // One or more parameter values are not valid. // +// - OperationNotSupportedException +// This operation is not supported. +// // - ResourceNotFoundException // The resource could not be found. // -// - AccessDeniedException -// The user is not authorized to access a resource. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectClientAddIns -func (c *WorkSpaces) DescribeConnectClientAddIns(input *DescribeConnectClientAddInsInput) (*DescribeConnectClientAddInsOutput, error) { - req, out := c.DescribeConnectClientAddInsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeBundleAssociations +func (c *WorkSpaces) DescribeBundleAssociations(input *DescribeBundleAssociationsInput) (*DescribeBundleAssociationsOutput, error) { + req, out := c.DescribeBundleAssociationsRequest(input) return out, req.Send() } -// DescribeConnectClientAddInsWithContext is the same as DescribeConnectClientAddIns with the addition of +// DescribeBundleAssociationsWithContext is the same as DescribeBundleAssociations with the addition of // the ability to pass a context and additional request options. // -// See DescribeConnectClientAddIns for details on how to use this API operation. +// See DescribeBundleAssociations 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 *WorkSpaces) DescribeConnectClientAddInsWithContext(ctx aws.Context, input *DescribeConnectClientAddInsInput, opts ...request.Option) (*DescribeConnectClientAddInsOutput, error) { - req, out := c.DescribeConnectClientAddInsRequest(input) +func (c *WorkSpaces) DescribeBundleAssociationsWithContext(ctx aws.Context, input *DescribeBundleAssociationsInput, opts ...request.Option) (*DescribeBundleAssociationsOutput, error) { + req, out := c.DescribeBundleAssociationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeConnectionAliasPermissions = "DescribeConnectionAliasPermissions" +const opDescribeClientBranding = "DescribeClientBranding" -// DescribeConnectionAliasPermissionsRequest generates a "aws/request.Request" representing the -// client's request for the DescribeConnectionAliasPermissions operation. The "output" return +// DescribeClientBrandingRequest generates a "aws/request.Request" representing the +// client's request for the DescribeClientBranding 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 DescribeConnectionAliasPermissions for more information on using the DescribeConnectionAliasPermissions +// See DescribeClientBranding for more information on using the DescribeClientBranding // 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 DescribeConnectionAliasPermissionsRequest method. -// req, resp := client.DescribeConnectionAliasPermissionsRequest(params) +// // Example sending a request using the DescribeClientBrandingRequest method. +// req, resp := client.DescribeClientBrandingRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissions -func (c *WorkSpaces) DescribeConnectionAliasPermissionsRequest(input *DescribeConnectionAliasPermissionsInput) (req *request.Request, output *DescribeConnectionAliasPermissionsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientBranding +func (c *WorkSpaces) DescribeClientBrandingRequest(input *DescribeClientBrandingInput) (req *request.Request, output *DescribeClientBrandingOutput) { op := &request.Operation{ - Name: opDescribeConnectionAliasPermissions, + Name: opDescribeClientBranding, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeConnectionAliasPermissionsInput{} + input = &DescribeClientBrandingInput{} } - output = &DescribeConnectionAliasPermissionsOutput{} + output = &DescribeClientBrandingOutput{} req = c.newRequest(op, input, output) return } -// DescribeConnectionAliasPermissions API operation for Amazon WorkSpaces. +// DescribeClientBranding API operation for Amazon WorkSpaces. // -// Describes the permissions that the owner of a connection alias has granted -// to another Amazon Web Services account for the specified connection alias. -// For more information, see Cross-Region Redirection for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// Describes the specified client branding. Client branding allows you to customize +// the log in page of various device types for your users. You can add your +// company logo, the support email address, support link, link to reset password, +// and a custom message for users trying to sign in. +// +// Only device types that have branding information configured will be shown +// in the response. // // 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 Amazon WorkSpaces's -// API operation DescribeConnectionAliasPermissions for usage and error information. +// API operation DescribeClientBranding for usage and error information. // // Returned Error Types: // -// - AccessDeniedException -// The user is not authorized to access a resource. -// // - InvalidParameterValuesException // One or more parameter values are not valid. // // - ResourceNotFoundException // The resource could not be found. // -// - OperationNotSupportedException -// This operation is not supported. +// - AccessDeniedException +// The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissions -func (c *WorkSpaces) DescribeConnectionAliasPermissions(input *DescribeConnectionAliasPermissionsInput) (*DescribeConnectionAliasPermissionsOutput, error) { - req, out := c.DescribeConnectionAliasPermissionsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientBranding +func (c *WorkSpaces) DescribeClientBranding(input *DescribeClientBrandingInput) (*DescribeClientBrandingOutput, error) { + req, out := c.DescribeClientBrandingRequest(input) return out, req.Send() } -// DescribeConnectionAliasPermissionsWithContext is the same as DescribeConnectionAliasPermissions with the addition of +// DescribeClientBrandingWithContext is the same as DescribeClientBranding with the addition of // the ability to pass a context and additional request options. // -// See DescribeConnectionAliasPermissions for details on how to use this API operation. +// See DescribeClientBranding 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 *WorkSpaces) DescribeConnectionAliasPermissionsWithContext(ctx aws.Context, input *DescribeConnectionAliasPermissionsInput, opts ...request.Option) (*DescribeConnectionAliasPermissionsOutput, error) { - req, out := c.DescribeConnectionAliasPermissionsRequest(input) +func (c *WorkSpaces) DescribeClientBrandingWithContext(ctx aws.Context, input *DescribeClientBrandingInput, opts ...request.Option) (*DescribeClientBrandingOutput, error) { + req, out := c.DescribeClientBrandingRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeConnectionAliases = "DescribeConnectionAliases" +const opDescribeClientProperties = "DescribeClientProperties" -// DescribeConnectionAliasesRequest generates a "aws/request.Request" representing the -// client's request for the DescribeConnectionAliases operation. The "output" return +// DescribeClientPropertiesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeClientProperties 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 DescribeConnectionAliases for more information on using the DescribeConnectionAliases +// See DescribeClientProperties for more information on using the DescribeClientProperties // 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 DescribeConnectionAliasesRequest method. -// req, resp := client.DescribeConnectionAliasesRequest(params) +// // Example sending a request using the DescribeClientPropertiesRequest method. +// req, resp := client.DescribeClientPropertiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliases -func (c *WorkSpaces) DescribeConnectionAliasesRequest(input *DescribeConnectionAliasesInput) (req *request.Request, output *DescribeConnectionAliasesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientProperties +func (c *WorkSpaces) DescribeClientPropertiesRequest(input *DescribeClientPropertiesInput) (req *request.Request, output *DescribeClientPropertiesOutput) { op := &request.Operation{ - Name: opDescribeConnectionAliases, + Name: opDescribeClientProperties, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeConnectionAliasesInput{} + input = &DescribeClientPropertiesInput{} } - output = &DescribeConnectionAliasesOutput{} + output = &DescribeClientPropertiesOutput{} req = c.newRequest(op, input, output) return } -// DescribeConnectionAliases API operation for Amazon WorkSpaces. +// DescribeClientProperties API operation for Amazon WorkSpaces. // -// Retrieves a list that describes the connection aliases used for cross-Region -// redirection. For more information, see Cross-Region Redirection for Amazon -// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// Retrieves a list that describes one or more specified Amazon WorkSpaces clients. // // 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 Amazon WorkSpaces's -// API operation DescribeConnectionAliases for usage and error information. +// API operation DescribeClientProperties for usage and error information. // // Returned Error Types: // -// - AccessDeniedException -// The user is not authorized to access a resource. -// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - OperationNotSupportedException -// This operation is not supported. +// - ResourceNotFoundException +// The resource could not be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliases -func (c *WorkSpaces) DescribeConnectionAliases(input *DescribeConnectionAliasesInput) (*DescribeConnectionAliasesOutput, error) { - req, out := c.DescribeConnectionAliasesRequest(input) +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientProperties +func (c *WorkSpaces) DescribeClientProperties(input *DescribeClientPropertiesInput) (*DescribeClientPropertiesOutput, error) { + req, out := c.DescribeClientPropertiesRequest(input) return out, req.Send() } -// DescribeConnectionAliasesWithContext is the same as DescribeConnectionAliases with the addition of +// DescribeClientPropertiesWithContext is the same as DescribeClientProperties with the addition of // the ability to pass a context and additional request options. // -// See DescribeConnectionAliases for details on how to use this API operation. +// See DescribeClientProperties 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 *WorkSpaces) DescribeConnectionAliasesWithContext(ctx aws.Context, input *DescribeConnectionAliasesInput, opts ...request.Option) (*DescribeConnectionAliasesOutput, error) { - req, out := c.DescribeConnectionAliasesRequest(input) +func (c *WorkSpaces) DescribeClientPropertiesWithContext(ctx aws.Context, input *DescribeClientPropertiesInput, opts ...request.Option) (*DescribeClientPropertiesOutput, error) { + req, out := c.DescribeClientPropertiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeIpGroups = "DescribeIpGroups" +const opDescribeConnectClientAddIns = "DescribeConnectClientAddIns" -// DescribeIpGroupsRequest generates a "aws/request.Request" representing the -// client's request for the DescribeIpGroups operation. The "output" return +// DescribeConnectClientAddInsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeConnectClientAddIns 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 DescribeIpGroups for more information on using the DescribeIpGroups +// See DescribeConnectClientAddIns for more information on using the DescribeConnectClientAddIns // 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 DescribeIpGroupsRequest method. -// req, resp := client.DescribeIpGroupsRequest(params) +// // Example sending a request using the DescribeConnectClientAddInsRequest method. +// req, resp := client.DescribeConnectClientAddInsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeIpGroups -func (c *WorkSpaces) DescribeIpGroupsRequest(input *DescribeIpGroupsInput) (req *request.Request, output *DescribeIpGroupsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectClientAddIns +func (c *WorkSpaces) DescribeConnectClientAddInsRequest(input *DescribeConnectClientAddInsInput) (req *request.Request, output *DescribeConnectClientAddInsOutput) { op := &request.Operation{ - Name: opDescribeIpGroups, + Name: opDescribeConnectClientAddIns, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeIpGroupsInput{} + input = &DescribeConnectClientAddInsInput{} } - output = &DescribeIpGroupsOutput{} + output = &DescribeConnectClientAddInsOutput{} req = c.newRequest(op, input, output) return } -// DescribeIpGroups API operation for Amazon WorkSpaces. +// DescribeConnectClientAddIns API operation for Amazon WorkSpaces. // -// Describes one or more of your IP access control groups. +// Retrieves a list of Amazon Connect client add-ins that have been created. // // 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 Amazon WorkSpaces's -// API operation DescribeIpGroups for usage and error information. +// API operation DescribeConnectClientAddIns for usage and error information. // // Returned Error Types: // // - InvalidParameterValuesException // One or more parameter values are not valid. // +// - ResourceNotFoundException +// The resource could not be found. +// // - AccessDeniedException // The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeIpGroups -func (c *WorkSpaces) DescribeIpGroups(input *DescribeIpGroupsInput) (*DescribeIpGroupsOutput, error) { - req, out := c.DescribeIpGroupsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectClientAddIns +func (c *WorkSpaces) DescribeConnectClientAddIns(input *DescribeConnectClientAddInsInput) (*DescribeConnectClientAddInsOutput, error) { + req, out := c.DescribeConnectClientAddInsRequest(input) return out, req.Send() } -// DescribeIpGroupsWithContext is the same as DescribeIpGroups with the addition of +// DescribeConnectClientAddInsWithContext is the same as DescribeConnectClientAddIns with the addition of // the ability to pass a context and additional request options. // -// See DescribeIpGroups for details on how to use this API operation. +// See DescribeConnectClientAddIns 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 *WorkSpaces) DescribeIpGroupsWithContext(ctx aws.Context, input *DescribeIpGroupsInput, opts ...request.Option) (*DescribeIpGroupsOutput, error) { - req, out := c.DescribeIpGroupsRequest(input) +func (c *WorkSpaces) DescribeConnectClientAddInsWithContext(ctx aws.Context, input *DescribeConnectClientAddInsInput, opts ...request.Option) (*DescribeConnectClientAddInsOutput, error) { + req, out := c.DescribeConnectClientAddInsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeTags = "DescribeTags" +const opDescribeConnectionAliasPermissions = "DescribeConnectionAliasPermissions" -// DescribeTagsRequest generates a "aws/request.Request" representing the -// client's request for the DescribeTags operation. The "output" return +// DescribeConnectionAliasPermissionsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeConnectionAliasPermissions 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 DescribeTags for more information on using the DescribeTags +// See DescribeConnectionAliasPermissions for more information on using the DescribeConnectionAliasPermissions // 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 DescribeTagsRequest method. -// req, resp := client.DescribeTagsRequest(params) +// // Example sending a request using the DescribeConnectionAliasPermissionsRequest method. +// req, resp := client.DescribeConnectionAliasPermissionsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags -func (c *WorkSpaces) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissions +func (c *WorkSpaces) DescribeConnectionAliasPermissionsRequest(input *DescribeConnectionAliasPermissionsInput) (req *request.Request, output *DescribeConnectionAliasPermissionsOutput) { op := &request.Operation{ - Name: opDescribeTags, + Name: opDescribeConnectionAliasPermissions, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeTagsInput{} + input = &DescribeConnectionAliasPermissionsInput{} } - output = &DescribeTagsOutput{} + output = &DescribeConnectionAliasPermissionsOutput{} req = c.newRequest(op, input, output) return } -// DescribeTags API operation for Amazon WorkSpaces. -// -// Describes the specified tags for the specified WorkSpaces resource. +// DescribeConnectionAliasPermissions API operation for Amazon WorkSpaces. // -// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// Describes the permissions that the owner of a connection alias has granted +// to another Amazon Web Services account for the specified connection alias. +// For more information, see Cross-Region Redirection for Amazon WorkSpaces +// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.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 Amazon WorkSpaces's -// API operation DescribeTags for usage and error information. +// API operation DescribeConnectionAliasPermissions for usage and error information. // // Returned Error Types: +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// // - ResourceNotFoundException // The resource could not be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags -func (c *WorkSpaces) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error) { - req, out := c.DescribeTagsRequest(input) +// - OperationNotSupportedException +// This operation is not supported. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissions +func (c *WorkSpaces) DescribeConnectionAliasPermissions(input *DescribeConnectionAliasPermissionsInput) (*DescribeConnectionAliasPermissionsOutput, error) { + req, out := c.DescribeConnectionAliasPermissionsRequest(input) return out, req.Send() } -// DescribeTagsWithContext is the same as DescribeTags with the addition of +// DescribeConnectionAliasPermissionsWithContext is the same as DescribeConnectionAliasPermissions with the addition of // the ability to pass a context and additional request options. // -// See DescribeTags for details on how to use this API operation. +// See DescribeConnectionAliasPermissions 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 *WorkSpaces) DescribeTagsWithContext(ctx aws.Context, input *DescribeTagsInput, opts ...request.Option) (*DescribeTagsOutput, error) { - req, out := c.DescribeTagsRequest(input) +func (c *WorkSpaces) DescribeConnectionAliasPermissionsWithContext(ctx aws.Context, input *DescribeConnectionAliasPermissionsInput, opts ...request.Option) (*DescribeConnectionAliasPermissionsOutput, error) { + req, out := c.DescribeConnectionAliasPermissionsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeWorkspaceBundles = "DescribeWorkspaceBundles" +const opDescribeConnectionAliases = "DescribeConnectionAliases" -// DescribeWorkspaceBundlesRequest generates a "aws/request.Request" representing the -// client's request for the DescribeWorkspaceBundles operation. The "output" return +// DescribeConnectionAliasesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeConnectionAliases 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 DescribeWorkspaceBundles for more information on using the DescribeWorkspaceBundles +// See DescribeConnectionAliases for more information on using the DescribeConnectionAliases // 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 DescribeWorkspaceBundlesRequest method. -// req, resp := client.DescribeWorkspaceBundlesRequest(params) +// // Example sending a request using the DescribeConnectionAliasesRequest method. +// req, resp := client.DescribeConnectionAliasesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles -func (c *WorkSpaces) DescribeWorkspaceBundlesRequest(input *DescribeWorkspaceBundlesInput) (req *request.Request, output *DescribeWorkspaceBundlesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliases +func (c *WorkSpaces) DescribeConnectionAliasesRequest(input *DescribeConnectionAliasesInput) (req *request.Request, output *DescribeConnectionAliasesOutput) { op := &request.Operation{ - Name: opDescribeWorkspaceBundles, + Name: opDescribeConnectionAliases, HTTPMethod: "POST", HTTPPath: "/", - Paginator: &request.Paginator{ - InputTokens: []string{"NextToken"}, - OutputTokens: []string{"NextToken"}, - LimitToken: "", - TruncationToken: "", - }, } if input == nil { - input = &DescribeWorkspaceBundlesInput{} + input = &DescribeConnectionAliasesInput{} } - output = &DescribeWorkspaceBundlesOutput{} + output = &DescribeConnectionAliasesOutput{} req = c.newRequest(op, input, output) return } -// DescribeWorkspaceBundles API operation for Amazon WorkSpaces. -// -// Retrieves a list that describes the available WorkSpace bundles. +// DescribeConnectionAliases API operation for Amazon WorkSpaces. // -// You can filter the results using either bundle ID or owner, but not both. +// Retrieves a list that describes the connection aliases used for cross-Region +// redirection. For more information, see Cross-Region Redirection for Amazon +// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.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 Amazon WorkSpaces's -// API operation DescribeWorkspaceBundles for usage and error information. +// API operation DescribeConnectionAliases for usage and error information. // // Returned Error Types: +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles -func (c *WorkSpaces) DescribeWorkspaceBundles(input *DescribeWorkspaceBundlesInput) (*DescribeWorkspaceBundlesOutput, error) { - req, out := c.DescribeWorkspaceBundlesRequest(input) +// - OperationNotSupportedException +// This operation is not supported. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliases +func (c *WorkSpaces) DescribeConnectionAliases(input *DescribeConnectionAliasesInput) (*DescribeConnectionAliasesOutput, error) { + req, out := c.DescribeConnectionAliasesRequest(input) return out, req.Send() } -// DescribeWorkspaceBundlesWithContext is the same as DescribeWorkspaceBundles with the addition of +// DescribeConnectionAliasesWithContext is the same as DescribeConnectionAliases with the addition of // the ability to pass a context and additional request options. // -// See DescribeWorkspaceBundles for details on how to use this API operation. +// See DescribeConnectionAliases 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 *WorkSpaces) DescribeWorkspaceBundlesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, opts ...request.Option) (*DescribeWorkspaceBundlesOutput, error) { - req, out := c.DescribeWorkspaceBundlesRequest(input) +func (c *WorkSpaces) DescribeConnectionAliasesWithContext(ctx aws.Context, input *DescribeConnectionAliasesInput, opts ...request.Option) (*DescribeConnectionAliasesOutput, error) { + req, out := c.DescribeConnectionAliasesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// DescribeWorkspaceBundlesPages iterates over the pages of a DescribeWorkspaceBundles operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See DescribeWorkspaceBundles method for more information on how to use this operation. -// -// Note: This operation can generate multiple requests to a service. -// -// // Example iterating over at most 3 pages of a DescribeWorkspaceBundles operation. -// pageNum := 0 -// err := client.DescribeWorkspaceBundlesPages(params, -// func(page *workspaces.DescribeWorkspaceBundlesOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -func (c *WorkSpaces) DescribeWorkspaceBundlesPages(input *DescribeWorkspaceBundlesInput, fn func(*DescribeWorkspaceBundlesOutput, bool) bool) error { - return c.DescribeWorkspaceBundlesPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// DescribeWorkspaceBundlesPagesWithContext same as DescribeWorkspaceBundlesPages except -// it takes a Context and allows setting request options on the pages. -// -// 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 *WorkSpaces) DescribeWorkspaceBundlesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, fn func(*DescribeWorkspaceBundlesOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *DescribeWorkspaceBundlesInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.DescribeWorkspaceBundlesRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*DescribeWorkspaceBundlesOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opDescribeWorkspaceDirectories = "DescribeWorkspaceDirectories" +const opDescribeImageAssociations = "DescribeImageAssociations" -// DescribeWorkspaceDirectoriesRequest generates a "aws/request.Request" representing the -// client's request for the DescribeWorkspaceDirectories operation. The "output" return +// DescribeImageAssociationsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeImageAssociations 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 DescribeWorkspaceDirectories for more information on using the DescribeWorkspaceDirectories +// See DescribeImageAssociations for more information on using the DescribeImageAssociations // 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 DescribeWorkspaceDirectoriesRequest method. -// req, resp := client.DescribeWorkspaceDirectoriesRequest(params) +// // Example sending a request using the DescribeImageAssociationsRequest method. +// req, resp := client.DescribeImageAssociationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories -func (c *WorkSpaces) DescribeWorkspaceDirectoriesRequest(input *DescribeWorkspaceDirectoriesInput) (req *request.Request, output *DescribeWorkspaceDirectoriesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeImageAssociations +func (c *WorkSpaces) DescribeImageAssociationsRequest(input *DescribeImageAssociationsInput) (req *request.Request, output *DescribeImageAssociationsOutput) { op := &request.Operation{ - Name: opDescribeWorkspaceDirectories, + Name: opDescribeImageAssociations, HTTPMethod: "POST", HTTPPath: "/", - Paginator: &request.Paginator{ - InputTokens: []string{"NextToken"}, - OutputTokens: []string{"NextToken"}, - LimitToken: "", - TruncationToken: "", - }, } if input == nil { - input = &DescribeWorkspaceDirectoriesInput{} + input = &DescribeImageAssociationsInput{} } - output = &DescribeWorkspaceDirectoriesOutput{} + output = &DescribeImageAssociationsOutput{} req = c.newRequest(op, input, output) return } -// DescribeWorkspaceDirectories API operation for Amazon WorkSpaces. +// DescribeImageAssociations API operation for Amazon WorkSpaces. // -// Describes the available directories that are registered with Amazon WorkSpaces. +// Describes the associations between the applications and the specified image. // // 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 Amazon WorkSpaces's -// API operation DescribeWorkspaceDirectories for usage and error information. +// API operation DescribeImageAssociations for usage and error information. // // Returned Error Types: +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories -func (c *WorkSpaces) DescribeWorkspaceDirectories(input *DescribeWorkspaceDirectoriesInput) (*DescribeWorkspaceDirectoriesOutput, error) { - req, out := c.DescribeWorkspaceDirectoriesRequest(input) +// - OperationNotSupportedException +// This operation is not supported. +// +// - ResourceNotFoundException +// The resource could not be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeImageAssociations +func (c *WorkSpaces) DescribeImageAssociations(input *DescribeImageAssociationsInput) (*DescribeImageAssociationsOutput, error) { + req, out := c.DescribeImageAssociationsRequest(input) return out, req.Send() } -// DescribeWorkspaceDirectoriesWithContext is the same as DescribeWorkspaceDirectories with the addition of +// DescribeImageAssociationsWithContext is the same as DescribeImageAssociations with the addition of // the ability to pass a context and additional request options. // -// See DescribeWorkspaceDirectories for details on how to use this API operation. +// See DescribeImageAssociations 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 *WorkSpaces) DescribeWorkspaceDirectoriesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, opts ...request.Option) (*DescribeWorkspaceDirectoriesOutput, error) { - req, out := c.DescribeWorkspaceDirectoriesRequest(input) +func (c *WorkSpaces) DescribeImageAssociationsWithContext(ctx aws.Context, input *DescribeImageAssociationsInput, opts ...request.Option) (*DescribeImageAssociationsOutput, error) { + req, out := c.DescribeImageAssociationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// DescribeWorkspaceDirectoriesPages iterates over the pages of a DescribeWorkspaceDirectories operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See DescribeWorkspaceDirectories method for more information on how to use this operation. -// -// Note: This operation can generate multiple requests to a service. -// -// // Example iterating over at most 3 pages of a DescribeWorkspaceDirectories operation. -// pageNum := 0 -// err := client.DescribeWorkspaceDirectoriesPages(params, -// func(page *workspaces.DescribeWorkspaceDirectoriesOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -func (c *WorkSpaces) DescribeWorkspaceDirectoriesPages(input *DescribeWorkspaceDirectoriesInput, fn func(*DescribeWorkspaceDirectoriesOutput, bool) bool) error { - return c.DescribeWorkspaceDirectoriesPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// DescribeWorkspaceDirectoriesPagesWithContext same as DescribeWorkspaceDirectoriesPages except -// it takes a Context and allows setting request options on the pages. -// -// 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 *WorkSpaces) DescribeWorkspaceDirectoriesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, fn func(*DescribeWorkspaceDirectoriesOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *DescribeWorkspaceDirectoriesInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.DescribeWorkspaceDirectoriesRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*DescribeWorkspaceDirectoriesOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opDescribeWorkspaceImagePermissions = "DescribeWorkspaceImagePermissions" +const opDescribeIpGroups = "DescribeIpGroups" -// DescribeWorkspaceImagePermissionsRequest generates a "aws/request.Request" representing the -// client's request for the DescribeWorkspaceImagePermissions operation. The "output" return +// DescribeIpGroupsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeIpGroups 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 DescribeWorkspaceImagePermissions for more information on using the DescribeWorkspaceImagePermissions +// See DescribeIpGroups for more information on using the DescribeIpGroups // 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 DescribeWorkspaceImagePermissionsRequest method. -// req, resp := client.DescribeWorkspaceImagePermissionsRequest(params) +// // Example sending a request using the DescribeIpGroupsRequest method. +// req, resp := client.DescribeIpGroupsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissions -func (c *WorkSpaces) DescribeWorkspaceImagePermissionsRequest(input *DescribeWorkspaceImagePermissionsInput) (req *request.Request, output *DescribeWorkspaceImagePermissionsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeIpGroups +func (c *WorkSpaces) DescribeIpGroupsRequest(input *DescribeIpGroupsInput) (req *request.Request, output *DescribeIpGroupsOutput) { op := &request.Operation{ - Name: opDescribeWorkspaceImagePermissions, + Name: opDescribeIpGroups, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeWorkspaceImagePermissionsInput{} + input = &DescribeIpGroupsInput{} } - output = &DescribeWorkspaceImagePermissionsOutput{} + output = &DescribeIpGroupsOutput{} req = c.newRequest(op, input, output) return } -// DescribeWorkspaceImagePermissions API operation for Amazon WorkSpaces. +// DescribeIpGroups API operation for Amazon WorkSpaces. // -// Describes the permissions that the owner of an image has granted to other -// Amazon Web Services accounts for an image. +// Describes one or more of your IP access control groups. // // 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 Amazon WorkSpaces's -// API operation DescribeWorkspaceImagePermissions for usage and error information. +// API operation DescribeIpGroups for usage and error information. // // Returned Error Types: // -// - ResourceNotFoundException -// The resource could not be found. +// - InvalidParameterValuesException +// One or more parameter values are not valid. // // - AccessDeniedException // The user is not authorized to access a resource. // -// - InvalidParameterValuesException -// One or more parameter values are not valid. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissions -func (c *WorkSpaces) DescribeWorkspaceImagePermissions(input *DescribeWorkspaceImagePermissionsInput) (*DescribeWorkspaceImagePermissionsOutput, error) { - req, out := c.DescribeWorkspaceImagePermissionsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeIpGroups +func (c *WorkSpaces) DescribeIpGroups(input *DescribeIpGroupsInput) (*DescribeIpGroupsOutput, error) { + req, out := c.DescribeIpGroupsRequest(input) return out, req.Send() } -// DescribeWorkspaceImagePermissionsWithContext is the same as DescribeWorkspaceImagePermissions with the addition of +// DescribeIpGroupsWithContext is the same as DescribeIpGroups with the addition of // the ability to pass a context and additional request options. // -// See DescribeWorkspaceImagePermissions for details on how to use this API operation. +// See DescribeIpGroups 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 *WorkSpaces) DescribeWorkspaceImagePermissionsWithContext(ctx aws.Context, input *DescribeWorkspaceImagePermissionsInput, opts ...request.Option) (*DescribeWorkspaceImagePermissionsOutput, error) { - req, out := c.DescribeWorkspaceImagePermissionsRequest(input) +func (c *WorkSpaces) DescribeIpGroupsWithContext(ctx aws.Context, input *DescribeIpGroupsInput, opts ...request.Option) (*DescribeIpGroupsOutput, error) { + req, out := c.DescribeIpGroupsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeWorkspaceImages = "DescribeWorkspaceImages" +const opDescribeTags = "DescribeTags" -// DescribeWorkspaceImagesRequest generates a "aws/request.Request" representing the -// client's request for the DescribeWorkspaceImages operation. The "output" return +// DescribeTagsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeTags 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 DescribeWorkspaceImages for more information on using the DescribeWorkspaceImages +// See DescribeTags for more information on using the DescribeTags // 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 DescribeWorkspaceImagesRequest method. -// req, resp := client.DescribeWorkspaceImagesRequest(params) +// // Example sending a request using the DescribeTagsRequest method. +// req, resp := client.DescribeTagsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImages -func (c *WorkSpaces) DescribeWorkspaceImagesRequest(input *DescribeWorkspaceImagesInput) (req *request.Request, output *DescribeWorkspaceImagesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags +func (c *WorkSpaces) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput) { op := &request.Operation{ - Name: opDescribeWorkspaceImages, + Name: opDescribeTags, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeWorkspaceImagesInput{} + input = &DescribeTagsInput{} } - output = &DescribeWorkspaceImagesOutput{} + output = &DescribeTagsOutput{} req = c.newRequest(op, input, output) return } -// DescribeWorkspaceImages API operation for Amazon WorkSpaces. +// DescribeTags API operation for Amazon WorkSpaces. // -// Retrieves a list that describes one or more specified images, if the image -// identifiers are provided. Otherwise, all images in the account are described. +// Describes the specified tags for the specified WorkSpaces resource. // // 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 Amazon WorkSpaces's -// API operation DescribeWorkspaceImages for usage and error information. +// API operation DescribeTags for usage and error information. // // Returned Error Types: -// - AccessDeniedException -// The user is not authorized to access a resource. +// - ResourceNotFoundException +// The resource could not be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImages -func (c *WorkSpaces) DescribeWorkspaceImages(input *DescribeWorkspaceImagesInput) (*DescribeWorkspaceImagesOutput, error) { - req, out := c.DescribeWorkspaceImagesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags +func (c *WorkSpaces) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error) { + req, out := c.DescribeTagsRequest(input) return out, req.Send() } -// DescribeWorkspaceImagesWithContext is the same as DescribeWorkspaceImages with the addition of +// DescribeTagsWithContext is the same as DescribeTags with the addition of // the ability to pass a context and additional request options. // -// See DescribeWorkspaceImages for details on how to use this API operation. +// See DescribeTags 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 *WorkSpaces) DescribeWorkspaceImagesWithContext(ctx aws.Context, input *DescribeWorkspaceImagesInput, opts ...request.Option) (*DescribeWorkspaceImagesOutput, error) { - req, out := c.DescribeWorkspaceImagesRequest(input) +func (c *WorkSpaces) DescribeTagsWithContext(ctx aws.Context, input *DescribeTagsInput, opts ...request.Option) (*DescribeTagsOutput, error) { + req, out := c.DescribeTagsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeWorkspaceSnapshots = "DescribeWorkspaceSnapshots" +const opDescribeWorkspaceAssociations = "DescribeWorkspaceAssociations" -// DescribeWorkspaceSnapshotsRequest generates a "aws/request.Request" representing the -// client's request for the DescribeWorkspaceSnapshots operation. The "output" return +// DescribeWorkspaceAssociationsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorkspaceAssociations 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 DescribeWorkspaceSnapshots for more information on using the DescribeWorkspaceSnapshots +// See DescribeWorkspaceAssociations for more information on using the DescribeWorkspaceAssociations // 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 DescribeWorkspaceSnapshotsRequest method. -// req, resp := client.DescribeWorkspaceSnapshotsRequest(params) +// // Example sending a request using the DescribeWorkspaceAssociationsRequest method. +// req, resp := client.DescribeWorkspaceAssociationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceSnapshots -func (c *WorkSpaces) DescribeWorkspaceSnapshotsRequest(input *DescribeWorkspaceSnapshotsInput) (req *request.Request, output *DescribeWorkspaceSnapshotsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceAssociations +func (c *WorkSpaces) DescribeWorkspaceAssociationsRequest(input *DescribeWorkspaceAssociationsInput) (req *request.Request, output *DescribeWorkspaceAssociationsOutput) { op := &request.Operation{ - Name: opDescribeWorkspaceSnapshots, + Name: opDescribeWorkspaceAssociations, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeWorkspaceSnapshotsInput{} + input = &DescribeWorkspaceAssociationsInput{} } - output = &DescribeWorkspaceSnapshotsOutput{} + output = &DescribeWorkspaceAssociationsOutput{} req = c.newRequest(op, input, output) return } -// DescribeWorkspaceSnapshots API operation for Amazon WorkSpaces. +// DescribeWorkspaceAssociations API operation for Amazon WorkSpaces. // -// Describes the snapshots for the specified WorkSpace. +// Describes the associations betweens applications and the specified WorkSpace. // // 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 Amazon WorkSpaces's -// API operation DescribeWorkspaceSnapshots for usage and error information. +// API operation DescribeWorkspaceAssociations for usage and error information. // // Returned Error Types: // +// - AccessDeniedException +// The user is not authorized to access a resource. +// // - InvalidParameterValuesException // One or more parameter values are not valid. // +// - OperationNotSupportedException +// This operation is not supported. +// // - ResourceNotFoundException // The resource could not be found. // -// - AccessDeniedException -// The user is not authorized to access a resource. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceSnapshots -func (c *WorkSpaces) DescribeWorkspaceSnapshots(input *DescribeWorkspaceSnapshotsInput) (*DescribeWorkspaceSnapshotsOutput, error) { - req, out := c.DescribeWorkspaceSnapshotsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceAssociations +func (c *WorkSpaces) DescribeWorkspaceAssociations(input *DescribeWorkspaceAssociationsInput) (*DescribeWorkspaceAssociationsOutput, error) { + req, out := c.DescribeWorkspaceAssociationsRequest(input) return out, req.Send() } -// DescribeWorkspaceSnapshotsWithContext is the same as DescribeWorkspaceSnapshots with the addition of +// DescribeWorkspaceAssociationsWithContext is the same as DescribeWorkspaceAssociations with the addition of // the ability to pass a context and additional request options. // -// See DescribeWorkspaceSnapshots for details on how to use this API operation. +// See DescribeWorkspaceAssociations 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 *WorkSpaces) DescribeWorkspaceSnapshotsWithContext(ctx aws.Context, input *DescribeWorkspaceSnapshotsInput, opts ...request.Option) (*DescribeWorkspaceSnapshotsOutput, error) { - req, out := c.DescribeWorkspaceSnapshotsRequest(input) +func (c *WorkSpaces) DescribeWorkspaceAssociationsWithContext(ctx aws.Context, input *DescribeWorkspaceAssociationsInput, opts ...request.Option) (*DescribeWorkspaceAssociationsOutput, error) { + req, out := c.DescribeWorkspaceAssociationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeWorkspaces = "DescribeWorkspaces" +const opDescribeWorkspaceBundles = "DescribeWorkspaceBundles" -// DescribeWorkspacesRequest generates a "aws/request.Request" representing the -// client's request for the DescribeWorkspaces operation. The "output" return +// DescribeWorkspaceBundlesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorkspaceBundles 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 DescribeWorkspaces for more information on using the DescribeWorkspaces +// See DescribeWorkspaceBundles for more information on using the DescribeWorkspaceBundles // 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 DescribeWorkspacesRequest method. -// req, resp := client.DescribeWorkspacesRequest(params) +// // Example sending a request using the DescribeWorkspaceBundlesRequest method. +// req, resp := client.DescribeWorkspaceBundlesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces -func (c *WorkSpaces) DescribeWorkspacesRequest(input *DescribeWorkspacesInput) (req *request.Request, output *DescribeWorkspacesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles +func (c *WorkSpaces) DescribeWorkspaceBundlesRequest(input *DescribeWorkspaceBundlesInput) (req *request.Request, output *DescribeWorkspaceBundlesOutput) { op := &request.Operation{ - Name: opDescribeWorkspaces, + Name: opDescribeWorkspaceBundles, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ InputTokens: []string{"NextToken"}, OutputTokens: []string{"NextToken"}, - LimitToken: "Limit", + LimitToken: "", TruncationToken: "", }, } if input == nil { - input = &DescribeWorkspacesInput{} + input = &DescribeWorkspaceBundlesInput{} } - output = &DescribeWorkspacesOutput{} + output = &DescribeWorkspaceBundlesOutput{} req = c.newRequest(op, input, output) return } -// DescribeWorkspaces API operation for Amazon WorkSpaces. +// DescribeWorkspaceBundles API operation for Amazon WorkSpaces. // -// Describes the specified WorkSpaces. +// Retrieves a list that describes the available WorkSpace bundles. // -// You can filter the results by using the bundle identifier, directory identifier, -// or owner, but you can specify only one filter at a time. +// You can filter the results using either bundle ID or owner, but not both. // // 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 Amazon WorkSpaces's -// API operation DescribeWorkspaces for usage and error information. +// API operation DescribeWorkspaceBundles for usage and error information. // // Returned Error Types: -// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - ResourceUnavailableException -// The specified resource is not available. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces -func (c *WorkSpaces) DescribeWorkspaces(input *DescribeWorkspacesInput) (*DescribeWorkspacesOutput, error) { - req, out := c.DescribeWorkspacesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles +func (c *WorkSpaces) DescribeWorkspaceBundles(input *DescribeWorkspaceBundlesInput) (*DescribeWorkspaceBundlesOutput, error) { + req, out := c.DescribeWorkspaceBundlesRequest(input) return out, req.Send() } -// DescribeWorkspacesWithContext is the same as DescribeWorkspaces with the addition of +// DescribeWorkspaceBundlesWithContext is the same as DescribeWorkspaceBundles with the addition of // the ability to pass a context and additional request options. // -// See DescribeWorkspaces for details on how to use this API operation. +// See DescribeWorkspaceBundles 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 *WorkSpaces) DescribeWorkspacesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, opts ...request.Option) (*DescribeWorkspacesOutput, error) { - req, out := c.DescribeWorkspacesRequest(input) +func (c *WorkSpaces) DescribeWorkspaceBundlesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, opts ...request.Option) (*DescribeWorkspaceBundlesOutput, error) { + req, out := c.DescribeWorkspaceBundlesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// DescribeWorkspacesPages iterates over the pages of a DescribeWorkspaces operation, +// DescribeWorkspaceBundlesPages iterates over the pages of a DescribeWorkspaceBundles operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See DescribeWorkspaces method for more information on how to use this operation. +// See DescribeWorkspaceBundles method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a DescribeWorkspaces operation. +// // Example iterating over at most 3 pages of a DescribeWorkspaceBundles operation. // pageNum := 0 -// err := client.DescribeWorkspacesPages(params, -// func(page *workspaces.DescribeWorkspacesOutput, lastPage bool) bool { +// err := client.DescribeWorkspaceBundlesPages(params, +// func(page *workspaces.DescribeWorkspaceBundlesOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *WorkSpaces) DescribeWorkspacesPages(input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool) error { - return c.DescribeWorkspacesPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *WorkSpaces) DescribeWorkspaceBundlesPages(input *DescribeWorkspaceBundlesInput, fn func(*DescribeWorkspaceBundlesOutput, bool) bool) error { + return c.DescribeWorkspaceBundlesPagesWithContext(aws.BackgroundContext(), input, fn) } -// DescribeWorkspacesPagesWithContext same as DescribeWorkspacesPages except +// DescribeWorkspaceBundlesPagesWithContext same as DescribeWorkspaceBundlesPages except // it takes a Context and allows setting request options on the pages. // // 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 *WorkSpaces) DescribeWorkspacesPagesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool, opts ...request.Option) error { +func (c *WorkSpaces) DescribeWorkspaceBundlesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, fn func(*DescribeWorkspaceBundlesOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *DescribeWorkspacesInput + var inCpy *DescribeWorkspaceBundlesInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.DescribeWorkspacesRequest(inCpy) + req, _ := c.DescribeWorkspaceBundlesRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -3430,7 +3659,7 @@ func (c *WorkSpaces) DescribeWorkspacesPagesWithContext(ctx aws.Context, input * } for p.Next() { - if !fn(p.Page().(*DescribeWorkspacesOutput), !p.HasNextPage()) { + if !fn(p.Page().(*DescribeWorkspaceBundlesOutput), !p.HasNextPage()) { break } } @@ -3438,820 +3667,849 @@ func (c *WorkSpaces) DescribeWorkspacesPagesWithContext(ctx aws.Context, input * return p.Err() } -const opDescribeWorkspacesConnectionStatus = "DescribeWorkspacesConnectionStatus" +const opDescribeWorkspaceDirectories = "DescribeWorkspaceDirectories" -// DescribeWorkspacesConnectionStatusRequest generates a "aws/request.Request" representing the -// client's request for the DescribeWorkspacesConnectionStatus operation. The "output" return +// DescribeWorkspaceDirectoriesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorkspaceDirectories 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 DescribeWorkspacesConnectionStatus for more information on using the DescribeWorkspacesConnectionStatus +// See DescribeWorkspaceDirectories for more information on using the DescribeWorkspaceDirectories // 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 DescribeWorkspacesConnectionStatusRequest method. -// req, resp := client.DescribeWorkspacesConnectionStatusRequest(params) +// // Example sending a request using the DescribeWorkspaceDirectoriesRequest method. +// req, resp := client.DescribeWorkspaceDirectoriesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus -func (c *WorkSpaces) DescribeWorkspacesConnectionStatusRequest(input *DescribeWorkspacesConnectionStatusInput) (req *request.Request, output *DescribeWorkspacesConnectionStatusOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories +func (c *WorkSpaces) DescribeWorkspaceDirectoriesRequest(input *DescribeWorkspaceDirectoriesInput) (req *request.Request, output *DescribeWorkspaceDirectoriesOutput) { op := &request.Operation{ - Name: opDescribeWorkspacesConnectionStatus, + Name: opDescribeWorkspaceDirectories, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "", + TruncationToken: "", + }, } if input == nil { - input = &DescribeWorkspacesConnectionStatusInput{} + input = &DescribeWorkspaceDirectoriesInput{} } - output = &DescribeWorkspacesConnectionStatusOutput{} + output = &DescribeWorkspaceDirectoriesOutput{} req = c.newRequest(op, input, output) return } -// DescribeWorkspacesConnectionStatus API operation for Amazon WorkSpaces. +// DescribeWorkspaceDirectories API operation for Amazon WorkSpaces. // -// Describes the connection status of the specified WorkSpaces. +// Describes the available directories that are registered with Amazon WorkSpaces. // // 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 Amazon WorkSpaces's -// API operation DescribeWorkspacesConnectionStatus for usage and error information. +// API operation DescribeWorkspaceDirectories for usage and error information. // // Returned Error Types: // - InvalidParameterValuesException // One or more parameter values are not valid. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus -func (c *WorkSpaces) DescribeWorkspacesConnectionStatus(input *DescribeWorkspacesConnectionStatusInput) (*DescribeWorkspacesConnectionStatusOutput, error) { - req, out := c.DescribeWorkspacesConnectionStatusRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories +func (c *WorkSpaces) DescribeWorkspaceDirectories(input *DescribeWorkspaceDirectoriesInput) (*DescribeWorkspaceDirectoriesOutput, error) { + req, out := c.DescribeWorkspaceDirectoriesRequest(input) return out, req.Send() } -// DescribeWorkspacesConnectionStatusWithContext is the same as DescribeWorkspacesConnectionStatus with the addition of +// DescribeWorkspaceDirectoriesWithContext is the same as DescribeWorkspaceDirectories with the addition of // the ability to pass a context and additional request options. // -// See DescribeWorkspacesConnectionStatus for details on how to use this API operation. +// See DescribeWorkspaceDirectories 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 *WorkSpaces) DescribeWorkspacesConnectionStatusWithContext(ctx aws.Context, input *DescribeWorkspacesConnectionStatusInput, opts ...request.Option) (*DescribeWorkspacesConnectionStatusOutput, error) { - req, out := c.DescribeWorkspacesConnectionStatusRequest(input) +func (c *WorkSpaces) DescribeWorkspaceDirectoriesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, opts ...request.Option) (*DescribeWorkspaceDirectoriesOutput, error) { + req, out := c.DescribeWorkspaceDirectoriesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDisassociateConnectionAlias = "DisassociateConnectionAlias" - -// DisassociateConnectionAliasRequest generates a "aws/request.Request" representing the -// client's request for the DisassociateConnectionAlias operation. The "output" return -// value will be populated with the request's response once the request completes -// successfully. +// DescribeWorkspaceDirectoriesPages iterates over the pages of a DescribeWorkspaceDirectories operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. // -// 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 DescribeWorkspaceDirectories method for more information on how to use this operation. // -// See DisassociateConnectionAlias for more information on using the DisassociateConnectionAlias -// API call, and error handling. +// Note: This operation can generate multiple requests to a service. // -// 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 iterating over at most 3 pages of a DescribeWorkspaceDirectories operation. +// pageNum := 0 +// err := client.DescribeWorkspaceDirectoriesPages(params, +// func(page *workspaces.DescribeWorkspaceDirectoriesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *WorkSpaces) DescribeWorkspaceDirectoriesPages(input *DescribeWorkspaceDirectoriesInput, fn func(*DescribeWorkspaceDirectoriesOutput, bool) bool) error { + return c.DescribeWorkspaceDirectoriesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// DescribeWorkspaceDirectoriesPagesWithContext same as DescribeWorkspaceDirectoriesPages except +// it takes a Context and allows setting request options on the pages. // -// // Example sending a request using the DisassociateConnectionAliasRequest method. -// req, resp := client.DisassociateConnectionAliasRequest(params) +// 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 *WorkSpaces) DescribeWorkspaceDirectoriesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, fn func(*DescribeWorkspaceDirectoriesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeWorkspaceDirectoriesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeWorkspaceDirectoriesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeWorkspaceDirectoriesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opDescribeWorkspaceImagePermissions = "DescribeWorkspaceImagePermissions" + +// DescribeWorkspaceImagePermissionsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorkspaceImagePermissions 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 DescribeWorkspaceImagePermissions for more information on using the DescribeWorkspaceImagePermissions +// 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 DescribeWorkspaceImagePermissionsRequest method. +// req, resp := client.DescribeWorkspaceImagePermissionsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAlias -func (c *WorkSpaces) DisassociateConnectionAliasRequest(input *DisassociateConnectionAliasInput) (req *request.Request, output *DisassociateConnectionAliasOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissions +func (c *WorkSpaces) DescribeWorkspaceImagePermissionsRequest(input *DescribeWorkspaceImagePermissionsInput) (req *request.Request, output *DescribeWorkspaceImagePermissionsOutput) { op := &request.Operation{ - Name: opDisassociateConnectionAlias, + Name: opDescribeWorkspaceImagePermissions, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DisassociateConnectionAliasInput{} + input = &DescribeWorkspaceImagePermissionsInput{} } - output = &DisassociateConnectionAliasOutput{} + output = &DescribeWorkspaceImagePermissionsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DisassociateConnectionAlias API operation for Amazon WorkSpaces. -// -// Disassociates a connection alias from a directory. Disassociating a connection -// alias disables cross-Region redirection between two directories in different -// Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// DescribeWorkspaceImagePermissions API operation for Amazon WorkSpaces. // -// Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) -// to make sure that the current state of the connection alias is CREATED. +// Describes the permissions that the owner of an image has granted to other +// Amazon Web Services accounts for an image. // // 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 Amazon WorkSpaces's -// API operation DisassociateConnectionAlias for usage and error information. +// API operation DescribeWorkspaceImagePermissions for usage and error information. // // Returned Error Types: // -// - AccessDeniedException -// The user is not authorized to access a resource. -// // - ResourceNotFoundException // The resource could not be found. // +// - AccessDeniedException +// The user is not authorized to access a resource. +// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - InvalidResourceStateException -// The state of the resource is not valid for this operation. -// -// - OperationNotSupportedException -// This operation is not supported. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAlias -func (c *WorkSpaces) DisassociateConnectionAlias(input *DisassociateConnectionAliasInput) (*DisassociateConnectionAliasOutput, error) { - req, out := c.DisassociateConnectionAliasRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissions +func (c *WorkSpaces) DescribeWorkspaceImagePermissions(input *DescribeWorkspaceImagePermissionsInput) (*DescribeWorkspaceImagePermissionsOutput, error) { + req, out := c.DescribeWorkspaceImagePermissionsRequest(input) return out, req.Send() } -// DisassociateConnectionAliasWithContext is the same as DisassociateConnectionAlias with the addition of +// DescribeWorkspaceImagePermissionsWithContext is the same as DescribeWorkspaceImagePermissions with the addition of // the ability to pass a context and additional request options. // -// See DisassociateConnectionAlias for details on how to use this API operation. +// See DescribeWorkspaceImagePermissions 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 *WorkSpaces) DisassociateConnectionAliasWithContext(ctx aws.Context, input *DisassociateConnectionAliasInput, opts ...request.Option) (*DisassociateConnectionAliasOutput, error) { - req, out := c.DisassociateConnectionAliasRequest(input) +func (c *WorkSpaces) DescribeWorkspaceImagePermissionsWithContext(ctx aws.Context, input *DescribeWorkspaceImagePermissionsInput, opts ...request.Option) (*DescribeWorkspaceImagePermissionsOutput, error) { + req, out := c.DescribeWorkspaceImagePermissionsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDisassociateIpGroups = "DisassociateIpGroups" +const opDescribeWorkspaceImages = "DescribeWorkspaceImages" -// DisassociateIpGroupsRequest generates a "aws/request.Request" representing the -// client's request for the DisassociateIpGroups operation. The "output" return +// DescribeWorkspaceImagesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorkspaceImages 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 DisassociateIpGroups for more information on using the DisassociateIpGroups +// See DescribeWorkspaceImages for more information on using the DescribeWorkspaceImages // 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 DisassociateIpGroupsRequest method. -// req, resp := client.DisassociateIpGroupsRequest(params) +// // Example sending a request using the DescribeWorkspaceImagesRequest method. +// req, resp := client.DescribeWorkspaceImagesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateIpGroups -func (c *WorkSpaces) DisassociateIpGroupsRequest(input *DisassociateIpGroupsInput) (req *request.Request, output *DisassociateIpGroupsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImages +func (c *WorkSpaces) DescribeWorkspaceImagesRequest(input *DescribeWorkspaceImagesInput) (req *request.Request, output *DescribeWorkspaceImagesOutput) { op := &request.Operation{ - Name: opDisassociateIpGroups, + Name: opDescribeWorkspaceImages, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DisassociateIpGroupsInput{} + input = &DescribeWorkspaceImagesInput{} } - output = &DisassociateIpGroupsOutput{} + output = &DescribeWorkspaceImagesOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DisassociateIpGroups API operation for Amazon WorkSpaces. +// DescribeWorkspaceImages API operation for Amazon WorkSpaces. // -// Disassociates the specified IP access control group from the specified directory. +// Retrieves a list that describes one or more specified images, if the image +// identifiers are provided. Otherwise, all images in the account are described. // // 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 Amazon WorkSpaces's -// API operation DisassociateIpGroups for usage and error information. +// API operation DescribeWorkspaceImages for usage and error information. // // Returned Error Types: -// -// - InvalidParameterValuesException -// One or more parameter values are not valid. -// -// - ResourceNotFoundException -// The resource could not be found. -// -// - InvalidResourceStateException -// The state of the resource is not valid for this operation. -// // - AccessDeniedException // The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateIpGroups -func (c *WorkSpaces) DisassociateIpGroups(input *DisassociateIpGroupsInput) (*DisassociateIpGroupsOutput, error) { - req, out := c.DisassociateIpGroupsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImages +func (c *WorkSpaces) DescribeWorkspaceImages(input *DescribeWorkspaceImagesInput) (*DescribeWorkspaceImagesOutput, error) { + req, out := c.DescribeWorkspaceImagesRequest(input) return out, req.Send() } -// DisassociateIpGroupsWithContext is the same as DisassociateIpGroups with the addition of +// DescribeWorkspaceImagesWithContext is the same as DescribeWorkspaceImages with the addition of // the ability to pass a context and additional request options. // -// See DisassociateIpGroups for details on how to use this API operation. +// See DescribeWorkspaceImages 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 *WorkSpaces) DisassociateIpGroupsWithContext(ctx aws.Context, input *DisassociateIpGroupsInput, opts ...request.Option) (*DisassociateIpGroupsOutput, error) { - req, out := c.DisassociateIpGroupsRequest(input) +func (c *WorkSpaces) DescribeWorkspaceImagesWithContext(ctx aws.Context, input *DescribeWorkspaceImagesInput, opts ...request.Option) (*DescribeWorkspaceImagesOutput, error) { + req, out := c.DescribeWorkspaceImagesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opImportClientBranding = "ImportClientBranding" +const opDescribeWorkspaceSnapshots = "DescribeWorkspaceSnapshots" -// ImportClientBrandingRequest generates a "aws/request.Request" representing the -// client's request for the ImportClientBranding operation. The "output" return +// DescribeWorkspaceSnapshotsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorkspaceSnapshots 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 ImportClientBranding for more information on using the ImportClientBranding +// See DescribeWorkspaceSnapshots for more information on using the DescribeWorkspaceSnapshots // 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 ImportClientBrandingRequest method. -// req, resp := client.ImportClientBrandingRequest(params) +// // Example sending a request using the DescribeWorkspaceSnapshotsRequest method. +// req, resp := client.DescribeWorkspaceSnapshotsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportClientBranding -func (c *WorkSpaces) ImportClientBrandingRequest(input *ImportClientBrandingInput) (req *request.Request, output *ImportClientBrandingOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceSnapshots +func (c *WorkSpaces) DescribeWorkspaceSnapshotsRequest(input *DescribeWorkspaceSnapshotsInput) (req *request.Request, output *DescribeWorkspaceSnapshotsOutput) { op := &request.Operation{ - Name: opImportClientBranding, + Name: opDescribeWorkspaceSnapshots, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ImportClientBrandingInput{} + input = &DescribeWorkspaceSnapshotsInput{} } - output = &ImportClientBrandingOutput{} + output = &DescribeWorkspaceSnapshotsOutput{} req = c.newRequest(op, input, output) return } -// ImportClientBranding API operation for Amazon WorkSpaces. -// -// Imports client branding. Client branding allows you to customize your WorkSpace's -// client login portal. You can tailor your login portal company logo, the support -// email address, support link, link to reset password, and a custom message -// for users trying to sign in. -// -// After you import client branding, the default branding experience for the -// specified platform type is replaced with the imported experience -// -// - You must specify at least one platform type when importing client branding. -// -// - You can import up to 6 MB of data with each request. If your request -// exceeds this limit, you can import client branding for different platform -// types using separate requests. -// -// - In each platform type, the SupportEmail and SupportLink parameters are -// mutually exclusive. You can specify only one parameter for each platform -// type, but not both. +// DescribeWorkspaceSnapshots API operation for Amazon WorkSpaces. // -// - Imported data can take up to a minute to appear in the WorkSpaces client. +// Describes the snapshots for the specified WorkSpace. // // 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 Amazon WorkSpaces's -// API operation ImportClientBranding for usage and error information. +// API operation DescribeWorkspaceSnapshots for usage and error information. // // Returned Error Types: // // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - ResourceLimitExceededException -// Your resource limits have been exceeded. -// // - ResourceNotFoundException // The resource could not be found. // // - AccessDeniedException // The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportClientBranding -func (c *WorkSpaces) ImportClientBranding(input *ImportClientBrandingInput) (*ImportClientBrandingOutput, error) { - req, out := c.ImportClientBrandingRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceSnapshots +func (c *WorkSpaces) DescribeWorkspaceSnapshots(input *DescribeWorkspaceSnapshotsInput) (*DescribeWorkspaceSnapshotsOutput, error) { + req, out := c.DescribeWorkspaceSnapshotsRequest(input) return out, req.Send() } -// ImportClientBrandingWithContext is the same as ImportClientBranding with the addition of +// DescribeWorkspaceSnapshotsWithContext is the same as DescribeWorkspaceSnapshots with the addition of // the ability to pass a context and additional request options. // -// See ImportClientBranding for details on how to use this API operation. +// See DescribeWorkspaceSnapshots 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 *WorkSpaces) ImportClientBrandingWithContext(ctx aws.Context, input *ImportClientBrandingInput, opts ...request.Option) (*ImportClientBrandingOutput, error) { - req, out := c.ImportClientBrandingRequest(input) +func (c *WorkSpaces) DescribeWorkspaceSnapshotsWithContext(ctx aws.Context, input *DescribeWorkspaceSnapshotsInput, opts ...request.Option) (*DescribeWorkspaceSnapshotsOutput, error) { + req, out := c.DescribeWorkspaceSnapshotsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opImportWorkspaceImage = "ImportWorkspaceImage" +const opDescribeWorkspaces = "DescribeWorkspaces" -// ImportWorkspaceImageRequest generates a "aws/request.Request" representing the -// client's request for the ImportWorkspaceImage operation. The "output" return +// DescribeWorkspacesRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorkspaces 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 ImportWorkspaceImage for more information on using the ImportWorkspaceImage +// See DescribeWorkspaces for more information on using the DescribeWorkspaces // 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 ImportWorkspaceImageRequest method. -// req, resp := client.ImportWorkspaceImageRequest(params) +// // Example sending a request using the DescribeWorkspacesRequest method. +// req, resp := client.DescribeWorkspacesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportWorkspaceImage -func (c *WorkSpaces) ImportWorkspaceImageRequest(input *ImportWorkspaceImageInput) (req *request.Request, output *ImportWorkspaceImageOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces +func (c *WorkSpaces) DescribeWorkspacesRequest(input *DescribeWorkspacesInput) (req *request.Request, output *DescribeWorkspacesOutput) { op := &request.Operation{ - Name: opImportWorkspaceImage, + Name: opDescribeWorkspaces, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "Limit", + TruncationToken: "", + }, } if input == nil { - input = &ImportWorkspaceImageInput{} + input = &DescribeWorkspacesInput{} } - output = &ImportWorkspaceImageOutput{} + output = &DescribeWorkspacesOutput{} req = c.newRequest(op, input, output) return } -// ImportWorkspaceImage API operation for Amazon WorkSpaces. +// DescribeWorkspaces API operation for Amazon WorkSpaces. // -// Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image -// into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 -// image that is in your Amazon Web Services account, and you must own the image. -// For more information about creating BYOL images, see Bring Your Own Windows -// Desktop Licenses (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). +// Describes the specified WorkSpaces. +// +// You can filter the results by using the bundle identifier, directory identifier, +// or owner, but you can specify only one filter at a time. // // 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 Amazon WorkSpaces's -// API operation ImportWorkspaceImage for usage and error information. +// API operation DescribeWorkspaces for usage and error information. // // Returned Error Types: // -// - ResourceLimitExceededException -// Your resource limits have been exceeded. -// -// - ResourceAlreadyExistsException -// The specified resource already exists. -// -// - ResourceNotFoundException -// The resource could not be found. -// -// - OperationNotSupportedException -// This operation is not supported. -// -// - AccessDeniedException -// The user is not authorized to access a resource. -// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportWorkspaceImage -func (c *WorkSpaces) ImportWorkspaceImage(input *ImportWorkspaceImageInput) (*ImportWorkspaceImageOutput, error) { - req, out := c.ImportWorkspaceImageRequest(input) +// - ResourceUnavailableException +// The specified resource is not available. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces +func (c *WorkSpaces) DescribeWorkspaces(input *DescribeWorkspacesInput) (*DescribeWorkspacesOutput, error) { + req, out := c.DescribeWorkspacesRequest(input) return out, req.Send() } -// ImportWorkspaceImageWithContext is the same as ImportWorkspaceImage with the addition of +// DescribeWorkspacesWithContext is the same as DescribeWorkspaces with the addition of // the ability to pass a context and additional request options. // -// See ImportWorkspaceImage for details on how to use this API operation. +// See DescribeWorkspaces 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 *WorkSpaces) ImportWorkspaceImageWithContext(ctx aws.Context, input *ImportWorkspaceImageInput, opts ...request.Option) (*ImportWorkspaceImageOutput, error) { - req, out := c.ImportWorkspaceImageRequest(input) +func (c *WorkSpaces) DescribeWorkspacesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, opts ...request.Option) (*DescribeWorkspacesOutput, error) { + req, out := c.DescribeWorkspacesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListAvailableManagementCidrRanges = "ListAvailableManagementCidrRanges" +// DescribeWorkspacesPages iterates over the pages of a DescribeWorkspaces operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See DescribeWorkspaces method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a DescribeWorkspaces operation. +// pageNum := 0 +// err := client.DescribeWorkspacesPages(params, +// func(page *workspaces.DescribeWorkspacesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *WorkSpaces) DescribeWorkspacesPages(input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool) error { + return c.DescribeWorkspacesPagesWithContext(aws.BackgroundContext(), input, fn) +} -// ListAvailableManagementCidrRangesRequest generates a "aws/request.Request" representing the -// client's request for the ListAvailableManagementCidrRanges operation. The "output" return +// DescribeWorkspacesPagesWithContext same as DescribeWorkspacesPages except +// it takes a Context and allows setting request options on the pages. +// +// 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 *WorkSpaces) DescribeWorkspacesPagesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *DescribeWorkspacesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeWorkspacesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*DescribeWorkspacesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opDescribeWorkspacesConnectionStatus = "DescribeWorkspacesConnectionStatus" + +// DescribeWorkspacesConnectionStatusRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorkspacesConnectionStatus 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 ListAvailableManagementCidrRanges for more information on using the ListAvailableManagementCidrRanges +// See DescribeWorkspacesConnectionStatus for more information on using the DescribeWorkspacesConnectionStatus // 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 ListAvailableManagementCidrRangesRequest method. -// req, resp := client.ListAvailableManagementCidrRangesRequest(params) +// // Example sending a request using the DescribeWorkspacesConnectionStatusRequest method. +// req, resp := client.DescribeWorkspacesConnectionStatusRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ListAvailableManagementCidrRanges -func (c *WorkSpaces) ListAvailableManagementCidrRangesRequest(input *ListAvailableManagementCidrRangesInput) (req *request.Request, output *ListAvailableManagementCidrRangesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus +func (c *WorkSpaces) DescribeWorkspacesConnectionStatusRequest(input *DescribeWorkspacesConnectionStatusInput) (req *request.Request, output *DescribeWorkspacesConnectionStatusOutput) { op := &request.Operation{ - Name: opListAvailableManagementCidrRanges, + Name: opDescribeWorkspacesConnectionStatus, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ListAvailableManagementCidrRangesInput{} + input = &DescribeWorkspacesConnectionStatusInput{} } - output = &ListAvailableManagementCidrRangesOutput{} + output = &DescribeWorkspacesConnectionStatusOutput{} req = c.newRequest(op, input, output) return } -// ListAvailableManagementCidrRanges API operation for Amazon WorkSpaces. -// -// Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that -// you can use for the network management interface when you enable Bring Your -// Own License (BYOL). -// -// This operation can be run only by Amazon Web Services accounts that are enabled -// for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException -// error. +// DescribeWorkspacesConnectionStatus API operation for Amazon WorkSpaces. // -// The management network interface is connected to a secure Amazon WorkSpaces -// management network. It is used for interactive streaming of the WorkSpace -// desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage -// the WorkSpace. +// Describes the connection status of the specified WorkSpaces. // // 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 Amazon WorkSpaces's -// API operation ListAvailableManagementCidrRanges for usage and error information. +// API operation DescribeWorkspacesConnectionStatus for usage and error information. // // Returned Error Types: -// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - AccessDeniedException -// The user is not authorized to access a resource. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ListAvailableManagementCidrRanges -func (c *WorkSpaces) ListAvailableManagementCidrRanges(input *ListAvailableManagementCidrRangesInput) (*ListAvailableManagementCidrRangesOutput, error) { - req, out := c.ListAvailableManagementCidrRangesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus +func (c *WorkSpaces) DescribeWorkspacesConnectionStatus(input *DescribeWorkspacesConnectionStatusInput) (*DescribeWorkspacesConnectionStatusOutput, error) { + req, out := c.DescribeWorkspacesConnectionStatusRequest(input) return out, req.Send() } -// ListAvailableManagementCidrRangesWithContext is the same as ListAvailableManagementCidrRanges with the addition of +// DescribeWorkspacesConnectionStatusWithContext is the same as DescribeWorkspacesConnectionStatus with the addition of // the ability to pass a context and additional request options. // -// See ListAvailableManagementCidrRanges for details on how to use this API operation. +// See DescribeWorkspacesConnectionStatus 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 *WorkSpaces) ListAvailableManagementCidrRangesWithContext(ctx aws.Context, input *ListAvailableManagementCidrRangesInput, opts ...request.Option) (*ListAvailableManagementCidrRangesOutput, error) { - req, out := c.ListAvailableManagementCidrRangesRequest(input) +func (c *WorkSpaces) DescribeWorkspacesConnectionStatusWithContext(ctx aws.Context, input *DescribeWorkspacesConnectionStatusInput, opts ...request.Option) (*DescribeWorkspacesConnectionStatusOutput, error) { + req, out := c.DescribeWorkspacesConnectionStatusRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opMigrateWorkspace = "MigrateWorkspace" +const opDisassociateConnectionAlias = "DisassociateConnectionAlias" -// MigrateWorkspaceRequest generates a "aws/request.Request" representing the -// client's request for the MigrateWorkspace operation. The "output" return +// DisassociateConnectionAliasRequest generates a "aws/request.Request" representing the +// client's request for the DisassociateConnectionAlias 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 MigrateWorkspace for more information on using the MigrateWorkspace +// See DisassociateConnectionAlias for more information on using the DisassociateConnectionAlias // 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 MigrateWorkspaceRequest method. -// req, resp := client.MigrateWorkspaceRequest(params) +// // Example sending a request using the DisassociateConnectionAliasRequest method. +// req, resp := client.DisassociateConnectionAliasRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/MigrateWorkspace -func (c *WorkSpaces) MigrateWorkspaceRequest(input *MigrateWorkspaceInput) (req *request.Request, output *MigrateWorkspaceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAlias +func (c *WorkSpaces) DisassociateConnectionAliasRequest(input *DisassociateConnectionAliasInput) (req *request.Request, output *DisassociateConnectionAliasOutput) { op := &request.Operation{ - Name: opMigrateWorkspace, + Name: opDisassociateConnectionAlias, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &MigrateWorkspaceInput{} + input = &DisassociateConnectionAliasInput{} } - output = &MigrateWorkspaceOutput{} + output = &DisassociateConnectionAliasOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// MigrateWorkspace API operation for Amazon WorkSpaces. -// -// Migrates a WorkSpace from one operating system or bundle type to another, -// while retaining the data on the user volume. +// DisassociateConnectionAlias API operation for Amazon WorkSpaces. // -// The migration process recreates the WorkSpace by using a new root volume -// from the target bundle image and the user volume from the last available -// snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% -// user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. -// A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files -// in the old user profile are moved to the new user profile. +// Disassociates a connection alias from a directory. Disassociating a connection +// alias disables cross-Region redirection between two directories in different +// Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces +// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). // -// For available migration scenarios, details about what happens during migration, -// and best practices, see Migrate a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html). +// Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) +// to make sure that the current state of the connection alias is CREATED. // // 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 Amazon WorkSpaces's -// API operation MigrateWorkspace for usage and error information. +// API operation DisassociateConnectionAlias for usage and error information. // // Returned Error Types: // -// - InvalidParameterValuesException -// One or more parameter values are not valid. +// - AccessDeniedException +// The user is not authorized to access a resource. // // - ResourceNotFoundException // The resource could not be found. // -// - AccessDeniedException -// The user is not authorized to access a resource. +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - InvalidResourceStateException +// The state of the resource is not valid for this operation. // // - OperationNotSupportedException // This operation is not supported. // -// - OperationInProgressException -// The properties of this WorkSpace are currently being modified. Try again -// in a moment. -// -// - ResourceUnavailableException -// The specified resource is not available. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/MigrateWorkspace -func (c *WorkSpaces) MigrateWorkspace(input *MigrateWorkspaceInput) (*MigrateWorkspaceOutput, error) { - req, out := c.MigrateWorkspaceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAlias +func (c *WorkSpaces) DisassociateConnectionAlias(input *DisassociateConnectionAliasInput) (*DisassociateConnectionAliasOutput, error) { + req, out := c.DisassociateConnectionAliasRequest(input) return out, req.Send() } -// MigrateWorkspaceWithContext is the same as MigrateWorkspace with the addition of +// DisassociateConnectionAliasWithContext is the same as DisassociateConnectionAlias with the addition of // the ability to pass a context and additional request options. // -// See MigrateWorkspace for details on how to use this API operation. +// See DisassociateConnectionAlias 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 *WorkSpaces) MigrateWorkspaceWithContext(ctx aws.Context, input *MigrateWorkspaceInput, opts ...request.Option) (*MigrateWorkspaceOutput, error) { - req, out := c.MigrateWorkspaceRequest(input) +func (c *WorkSpaces) DisassociateConnectionAliasWithContext(ctx aws.Context, input *DisassociateConnectionAliasInput, opts ...request.Option) (*DisassociateConnectionAliasOutput, error) { + req, out := c.DisassociateConnectionAliasRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opModifyAccount = "ModifyAccount" +const opDisassociateIpGroups = "DisassociateIpGroups" -// ModifyAccountRequest generates a "aws/request.Request" representing the -// client's request for the ModifyAccount operation. The "output" return +// DisassociateIpGroupsRequest generates a "aws/request.Request" representing the +// client's request for the DisassociateIpGroups 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 ModifyAccount for more information on using the ModifyAccount +// See DisassociateIpGroups for more information on using the DisassociateIpGroups // 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 ModifyAccountRequest method. -// req, resp := client.ModifyAccountRequest(params) +// // Example sending a request using the DisassociateIpGroupsRequest method. +// req, resp := client.DisassociateIpGroupsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyAccount -func (c *WorkSpaces) ModifyAccountRequest(input *ModifyAccountInput) (req *request.Request, output *ModifyAccountOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateIpGroups +func (c *WorkSpaces) DisassociateIpGroupsRequest(input *DisassociateIpGroupsInput) (req *request.Request, output *DisassociateIpGroupsOutput) { op := &request.Operation{ - Name: opModifyAccount, + Name: opDisassociateIpGroups, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ModifyAccountInput{} + input = &DisassociateIpGroupsInput{} } - output = &ModifyAccountOutput{} + output = &DisassociateIpGroupsOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ModifyAccount API operation for Amazon WorkSpaces. +// DisassociateIpGroups API operation for Amazon WorkSpaces. // -// Modifies the configuration of Bring Your Own License (BYOL) for the specified -// account. +// Disassociates the specified IP access control group from the specified directory. // // 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 Amazon WorkSpaces's -// API operation ModifyAccount for usage and error information. +// API operation DisassociateIpGroups for usage and error information. // // Returned Error Types: // // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - AccessDeniedException -// The user is not authorized to access a resource. +// - ResourceNotFoundException +// The resource could not be found. // // - InvalidResourceStateException // The state of the resource is not valid for this operation. // -// - ResourceUnavailableException -// The specified resource is not available. -// -// - ResourceNotFoundException -// The resource could not be found. +// - AccessDeniedException +// The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyAccount -func (c *WorkSpaces) ModifyAccount(input *ModifyAccountInput) (*ModifyAccountOutput, error) { - req, out := c.ModifyAccountRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateIpGroups +func (c *WorkSpaces) DisassociateIpGroups(input *DisassociateIpGroupsInput) (*DisassociateIpGroupsOutput, error) { + req, out := c.DisassociateIpGroupsRequest(input) return out, req.Send() } -// ModifyAccountWithContext is the same as ModifyAccount with the addition of +// DisassociateIpGroupsWithContext is the same as DisassociateIpGroups with the addition of // the ability to pass a context and additional request options. // -// See ModifyAccount for details on how to use this API operation. +// See DisassociateIpGroups 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 *WorkSpaces) ModifyAccountWithContext(ctx aws.Context, input *ModifyAccountInput, opts ...request.Option) (*ModifyAccountOutput, error) { - req, out := c.ModifyAccountRequest(input) +func (c *WorkSpaces) DisassociateIpGroupsWithContext(ctx aws.Context, input *DisassociateIpGroupsInput, opts ...request.Option) (*DisassociateIpGroupsOutput, error) { + req, out := c.DisassociateIpGroupsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opModifyCertificateBasedAuthProperties = "ModifyCertificateBasedAuthProperties" +const opDisassociateWorkspaceApplication = "DisassociateWorkspaceApplication" -// ModifyCertificateBasedAuthPropertiesRequest generates a "aws/request.Request" representing the -// client's request for the ModifyCertificateBasedAuthProperties operation. The "output" return +// DisassociateWorkspaceApplicationRequest generates a "aws/request.Request" representing the +// client's request for the DisassociateWorkspaceApplication 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 ModifyCertificateBasedAuthProperties for more information on using the ModifyCertificateBasedAuthProperties +// See DisassociateWorkspaceApplication for more information on using the DisassociateWorkspaceApplication // 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 ModifyCertificateBasedAuthPropertiesRequest method. -// req, resp := client.ModifyCertificateBasedAuthPropertiesRequest(params) +// // Example sending a request using the DisassociateWorkspaceApplicationRequest method. +// req, resp := client.DisassociateWorkspaceApplicationRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties -func (c *WorkSpaces) ModifyCertificateBasedAuthPropertiesRequest(input *ModifyCertificateBasedAuthPropertiesInput) (req *request.Request, output *ModifyCertificateBasedAuthPropertiesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateWorkspaceApplication +func (c *WorkSpaces) DisassociateWorkspaceApplicationRequest(input *DisassociateWorkspaceApplicationInput) (req *request.Request, output *DisassociateWorkspaceApplicationOutput) { op := &request.Operation{ - Name: opModifyCertificateBasedAuthProperties, + Name: opDisassociateWorkspaceApplication, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ModifyCertificateBasedAuthPropertiesInput{} + input = &DisassociateWorkspaceApplicationInput{} } - output = &ModifyCertificateBasedAuthPropertiesOutput{} + output = &DisassociateWorkspaceApplicationOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ModifyCertificateBasedAuthProperties API operation for Amazon WorkSpaces. +// DisassociateWorkspaceApplication API operation for Amazon WorkSpaces. // -// Modifies the properties of the certificate-based authentication you want -// to use with your WorkSpaces. +// Disassociates the specified application from a WorkSpace. // // 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 Amazon WorkSpaces's -// API operation ModifyCertificateBasedAuthProperties for usage and error information. +// API operation DisassociateWorkspaceApplication for usage and error information. // // Returned Error Types: // @@ -4264,1441 +4522,1485 @@ func (c *WorkSpaces) ModifyCertificateBasedAuthPropertiesRequest(input *ModifyCe // - OperationNotSupportedException // This operation is not supported. // +// - ResourceInUseException +// The specified resource is currently in use. +// // - ResourceNotFoundException // The resource could not be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties -func (c *WorkSpaces) ModifyCertificateBasedAuthProperties(input *ModifyCertificateBasedAuthPropertiesInput) (*ModifyCertificateBasedAuthPropertiesOutput, error) { - req, out := c.ModifyCertificateBasedAuthPropertiesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateWorkspaceApplication +func (c *WorkSpaces) DisassociateWorkspaceApplication(input *DisassociateWorkspaceApplicationInput) (*DisassociateWorkspaceApplicationOutput, error) { + req, out := c.DisassociateWorkspaceApplicationRequest(input) return out, req.Send() } -// ModifyCertificateBasedAuthPropertiesWithContext is the same as ModifyCertificateBasedAuthProperties with the addition of +// DisassociateWorkspaceApplicationWithContext is the same as DisassociateWorkspaceApplication with the addition of // the ability to pass a context and additional request options. // -// See ModifyCertificateBasedAuthProperties for details on how to use this API operation. +// See DisassociateWorkspaceApplication 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 *WorkSpaces) ModifyCertificateBasedAuthPropertiesWithContext(ctx aws.Context, input *ModifyCertificateBasedAuthPropertiesInput, opts ...request.Option) (*ModifyCertificateBasedAuthPropertiesOutput, error) { - req, out := c.ModifyCertificateBasedAuthPropertiesRequest(input) +func (c *WorkSpaces) DisassociateWorkspaceApplicationWithContext(ctx aws.Context, input *DisassociateWorkspaceApplicationInput, opts ...request.Option) (*DisassociateWorkspaceApplicationOutput, error) { + req, out := c.DisassociateWorkspaceApplicationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opModifyClientProperties = "ModifyClientProperties" +const opImportClientBranding = "ImportClientBranding" -// ModifyClientPropertiesRequest generates a "aws/request.Request" representing the -// client's request for the ModifyClientProperties operation. The "output" return +// ImportClientBrandingRequest generates a "aws/request.Request" representing the +// client's request for the ImportClientBranding 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 ModifyClientProperties for more information on using the ModifyClientProperties +// See ImportClientBranding for more information on using the ImportClientBranding // 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 ModifyClientPropertiesRequest method. -// req, resp := client.ModifyClientPropertiesRequest(params) +// // Example sending a request using the ImportClientBrandingRequest method. +// req, resp := client.ImportClientBrandingRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyClientProperties -func (c *WorkSpaces) ModifyClientPropertiesRequest(input *ModifyClientPropertiesInput) (req *request.Request, output *ModifyClientPropertiesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportClientBranding +func (c *WorkSpaces) ImportClientBrandingRequest(input *ImportClientBrandingInput) (req *request.Request, output *ImportClientBrandingOutput) { op := &request.Operation{ - Name: opModifyClientProperties, + Name: opImportClientBranding, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ModifyClientPropertiesInput{} + input = &ImportClientBrandingInput{} } - output = &ModifyClientPropertiesOutput{} + output = &ImportClientBrandingOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ModifyClientProperties API operation for Amazon WorkSpaces. +// ImportClientBranding API operation for Amazon WorkSpaces. // -// Modifies the properties of the specified Amazon WorkSpaces clients. +// Imports client branding. Client branding allows you to customize your WorkSpace's +// client login portal. You can tailor your login portal company logo, the support +// email address, support link, link to reset password, and a custom message +// for users trying to sign in. +// +// After you import client branding, the default branding experience for the +// specified platform type is replaced with the imported experience +// +// - You must specify at least one platform type when importing client branding. +// +// - You can import up to 6 MB of data with each request. If your request +// exceeds this limit, you can import client branding for different platform +// types using separate requests. +// +// - In each platform type, the SupportEmail and SupportLink parameters are +// mutually exclusive. You can specify only one parameter for each platform +// type, but not both. +// +// - Imported data can take up to a minute to appear in the WorkSpaces client. // // 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 Amazon WorkSpaces's -// API operation ModifyClientProperties for usage and error information. +// API operation ImportClientBranding for usage and error information. // // Returned Error Types: // // - InvalidParameterValuesException // One or more parameter values are not valid. // +// - ResourceLimitExceededException +// Your resource limits have been exceeded. +// // - ResourceNotFoundException // The resource could not be found. // // - AccessDeniedException // The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyClientProperties -func (c *WorkSpaces) ModifyClientProperties(input *ModifyClientPropertiesInput) (*ModifyClientPropertiesOutput, error) { - req, out := c.ModifyClientPropertiesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportClientBranding +func (c *WorkSpaces) ImportClientBranding(input *ImportClientBrandingInput) (*ImportClientBrandingOutput, error) { + req, out := c.ImportClientBrandingRequest(input) return out, req.Send() } -// ModifyClientPropertiesWithContext is the same as ModifyClientProperties with the addition of +// ImportClientBrandingWithContext is the same as ImportClientBranding with the addition of // the ability to pass a context and additional request options. // -// See ModifyClientProperties for details on how to use this API operation. +// See ImportClientBranding 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 *WorkSpaces) ModifyClientPropertiesWithContext(ctx aws.Context, input *ModifyClientPropertiesInput, opts ...request.Option) (*ModifyClientPropertiesOutput, error) { - req, out := c.ModifyClientPropertiesRequest(input) +func (c *WorkSpaces) ImportClientBrandingWithContext(ctx aws.Context, input *ImportClientBrandingInput, opts ...request.Option) (*ImportClientBrandingOutput, error) { + req, out := c.ImportClientBrandingRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opModifySamlProperties = "ModifySamlProperties" +const opImportWorkspaceImage = "ImportWorkspaceImage" -// ModifySamlPropertiesRequest generates a "aws/request.Request" representing the -// client's request for the ModifySamlProperties operation. The "output" return +// ImportWorkspaceImageRequest generates a "aws/request.Request" representing the +// client's request for the ImportWorkspaceImage 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 ModifySamlProperties for more information on using the ModifySamlProperties +// See ImportWorkspaceImage for more information on using the ImportWorkspaceImage // 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 ModifySamlPropertiesRequest method. -// req, resp := client.ModifySamlPropertiesRequest(params) +// // Example sending a request using the ImportWorkspaceImageRequest method. +// req, resp := client.ImportWorkspaceImageRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlProperties -func (c *WorkSpaces) ModifySamlPropertiesRequest(input *ModifySamlPropertiesInput) (req *request.Request, output *ModifySamlPropertiesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportWorkspaceImage +func (c *WorkSpaces) ImportWorkspaceImageRequest(input *ImportWorkspaceImageInput) (req *request.Request, output *ImportWorkspaceImageOutput) { op := &request.Operation{ - Name: opModifySamlProperties, + Name: opImportWorkspaceImage, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ModifySamlPropertiesInput{} + input = &ImportWorkspaceImageInput{} } - output = &ModifySamlPropertiesOutput{} + output = &ImportWorkspaceImageOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ModifySamlProperties API operation for Amazon WorkSpaces. +// ImportWorkspaceImage API operation for Amazon WorkSpaces. // -// Modifies multiple properties related to SAML 2.0 authentication, including -// the enablement status, user access URL, and relay state parameter name that -// are used for configuring federation with an SAML 2.0 identity provider. +// Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image +// into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 +// image that is in your Amazon Web Services account, and you must own the image. +// For more information about creating BYOL images, see Bring Your Own Windows +// Desktop Licenses (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.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 Amazon WorkSpaces's -// API operation ModifySamlProperties for usage and error information. +// API operation ImportWorkspaceImage for usage and error information. // // Returned Error Types: // -// - AccessDeniedException -// The user is not authorized to access a resource. +// - ResourceLimitExceededException +// Your resource limits have been exceeded. // -// - InvalidParameterValuesException -// One or more parameter values are not valid. +// - ResourceAlreadyExistsException +// The specified resource already exists. +// +// - ResourceNotFoundException +// The resource could not be found. // // - OperationNotSupportedException // This operation is not supported. // -// - ResourceNotFoundException -// The resource could not be found. +// - AccessDeniedException +// The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlProperties -func (c *WorkSpaces) ModifySamlProperties(input *ModifySamlPropertiesInput) (*ModifySamlPropertiesOutput, error) { - req, out := c.ModifySamlPropertiesRequest(input) +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportWorkspaceImage +func (c *WorkSpaces) ImportWorkspaceImage(input *ImportWorkspaceImageInput) (*ImportWorkspaceImageOutput, error) { + req, out := c.ImportWorkspaceImageRequest(input) return out, req.Send() } -// ModifySamlPropertiesWithContext is the same as ModifySamlProperties with the addition of +// ImportWorkspaceImageWithContext is the same as ImportWorkspaceImage with the addition of // the ability to pass a context and additional request options. // -// See ModifySamlProperties for details on how to use this API operation. +// See ImportWorkspaceImage 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 *WorkSpaces) ModifySamlPropertiesWithContext(ctx aws.Context, input *ModifySamlPropertiesInput, opts ...request.Option) (*ModifySamlPropertiesOutput, error) { - req, out := c.ModifySamlPropertiesRequest(input) +func (c *WorkSpaces) ImportWorkspaceImageWithContext(ctx aws.Context, input *ImportWorkspaceImageInput, opts ...request.Option) (*ImportWorkspaceImageOutput, error) { + req, out := c.ImportWorkspaceImageRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opModifySelfservicePermissions = "ModifySelfservicePermissions" +const opListAvailableManagementCidrRanges = "ListAvailableManagementCidrRanges" -// ModifySelfservicePermissionsRequest generates a "aws/request.Request" representing the -// client's request for the ModifySelfservicePermissions operation. The "output" return +// ListAvailableManagementCidrRangesRequest generates a "aws/request.Request" representing the +// client's request for the ListAvailableManagementCidrRanges 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 ModifySelfservicePermissions for more information on using the ModifySelfservicePermissions +// See ListAvailableManagementCidrRanges for more information on using the ListAvailableManagementCidrRanges // 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 ModifySelfservicePermissionsRequest method. -// req, resp := client.ModifySelfservicePermissionsRequest(params) +// // Example sending a request using the ListAvailableManagementCidrRangesRequest method. +// req, resp := client.ListAvailableManagementCidrRangesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySelfservicePermissions -func (c *WorkSpaces) ModifySelfservicePermissionsRequest(input *ModifySelfservicePermissionsInput) (req *request.Request, output *ModifySelfservicePermissionsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ListAvailableManagementCidrRanges +func (c *WorkSpaces) ListAvailableManagementCidrRangesRequest(input *ListAvailableManagementCidrRangesInput) (req *request.Request, output *ListAvailableManagementCidrRangesOutput) { op := &request.Operation{ - Name: opModifySelfservicePermissions, + Name: opListAvailableManagementCidrRanges, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ModifySelfservicePermissionsInput{} + input = &ListAvailableManagementCidrRangesInput{} } - output = &ModifySelfservicePermissionsOutput{} + output = &ListAvailableManagementCidrRangesOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ModifySelfservicePermissions API operation for Amazon WorkSpaces. +// ListAvailableManagementCidrRanges API operation for Amazon WorkSpaces. // -// Modifies the self-service WorkSpace management capabilities for your users. -// For more information, see Enable Self-Service WorkSpace Management Capabilities -// for Your Users (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html). +// Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that +// you can use for the network management interface when you enable Bring Your +// Own License (BYOL). +// +// This operation can be run only by Amazon Web Services accounts that are enabled +// for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException +// error. +// +// The management network interface is connected to a secure Amazon WorkSpaces +// management network. It is used for interactive streaming of the WorkSpace +// desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage +// the WorkSpace. // // 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 Amazon WorkSpaces's -// API operation ModifySelfservicePermissions for usage and error information. +// API operation ListAvailableManagementCidrRanges for usage and error information. // // Returned Error Types: // -// - AccessDeniedException -// The user is not authorized to access a resource. -// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - ResourceNotFoundException -// The resource could not be found. +// - AccessDeniedException +// The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySelfservicePermissions -func (c *WorkSpaces) ModifySelfservicePermissions(input *ModifySelfservicePermissionsInput) (*ModifySelfservicePermissionsOutput, error) { - req, out := c.ModifySelfservicePermissionsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ListAvailableManagementCidrRanges +func (c *WorkSpaces) ListAvailableManagementCidrRanges(input *ListAvailableManagementCidrRangesInput) (*ListAvailableManagementCidrRangesOutput, error) { + req, out := c.ListAvailableManagementCidrRangesRequest(input) return out, req.Send() } -// ModifySelfservicePermissionsWithContext is the same as ModifySelfservicePermissions with the addition of +// ListAvailableManagementCidrRangesWithContext is the same as ListAvailableManagementCidrRanges with the addition of // the ability to pass a context and additional request options. // -// See ModifySelfservicePermissions for details on how to use this API operation. +// See ListAvailableManagementCidrRanges 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 *WorkSpaces) ModifySelfservicePermissionsWithContext(ctx aws.Context, input *ModifySelfservicePermissionsInput, opts ...request.Option) (*ModifySelfservicePermissionsOutput, error) { - req, out := c.ModifySelfservicePermissionsRequest(input) +func (c *WorkSpaces) ListAvailableManagementCidrRangesWithContext(ctx aws.Context, input *ListAvailableManagementCidrRangesInput, opts ...request.Option) (*ListAvailableManagementCidrRangesOutput, error) { + req, out := c.ListAvailableManagementCidrRangesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opModifyWorkspaceAccessProperties = "ModifyWorkspaceAccessProperties" +const opMigrateWorkspace = "MigrateWorkspace" -// ModifyWorkspaceAccessPropertiesRequest generates a "aws/request.Request" representing the -// client's request for the ModifyWorkspaceAccessProperties operation. The "output" return +// MigrateWorkspaceRequest generates a "aws/request.Request" representing the +// client's request for the MigrateWorkspace 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 ModifyWorkspaceAccessProperties for more information on using the ModifyWorkspaceAccessProperties +// See MigrateWorkspace for more information on using the MigrateWorkspace // 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 ModifyWorkspaceAccessPropertiesRequest method. -// req, resp := client.ModifyWorkspaceAccessPropertiesRequest(params) +// // Example sending a request using the MigrateWorkspaceRequest method. +// req, resp := client.MigrateWorkspaceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceAccessProperties -func (c *WorkSpaces) ModifyWorkspaceAccessPropertiesRequest(input *ModifyWorkspaceAccessPropertiesInput) (req *request.Request, output *ModifyWorkspaceAccessPropertiesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/MigrateWorkspace +func (c *WorkSpaces) MigrateWorkspaceRequest(input *MigrateWorkspaceInput) (req *request.Request, output *MigrateWorkspaceOutput) { op := &request.Operation{ - Name: opModifyWorkspaceAccessProperties, + Name: opMigrateWorkspace, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ModifyWorkspaceAccessPropertiesInput{} + input = &MigrateWorkspaceInput{} } - output = &ModifyWorkspaceAccessPropertiesOutput{} + output = &MigrateWorkspaceOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ModifyWorkspaceAccessProperties API operation for Amazon WorkSpaces. +// MigrateWorkspace API operation for Amazon WorkSpaces. // -// Specifies which devices and operating systems users can use to access their -// WorkSpaces. For more information, see Control Device Access (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access). +// Migrates a WorkSpace from one operating system or bundle type to another, +// while retaining the data on the user volume. +// +// The migration process recreates the WorkSpace by using a new root volume +// from the target bundle image and the user volume from the last available +// snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% +// user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. +// A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files +// in the old user profile are moved to the new user profile. +// +// For available migration scenarios, details about what happens during migration, +// and best practices, see Migrate a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.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 Amazon WorkSpaces's -// API operation ModifyWorkspaceAccessProperties for usage and error information. +// API operation MigrateWorkspace for usage and error information. // // Returned Error Types: // +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// // - ResourceNotFoundException // The resource could not be found. // // - AccessDeniedException // The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceAccessProperties -func (c *WorkSpaces) ModifyWorkspaceAccessProperties(input *ModifyWorkspaceAccessPropertiesInput) (*ModifyWorkspaceAccessPropertiesOutput, error) { - req, out := c.ModifyWorkspaceAccessPropertiesRequest(input) +// - OperationNotSupportedException +// This operation is not supported. +// +// - OperationInProgressException +// The properties of this WorkSpace are currently being modified. Try again +// in a moment. +// +// - ResourceUnavailableException +// The specified resource is not available. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/MigrateWorkspace +func (c *WorkSpaces) MigrateWorkspace(input *MigrateWorkspaceInput) (*MigrateWorkspaceOutput, error) { + req, out := c.MigrateWorkspaceRequest(input) return out, req.Send() } -// ModifyWorkspaceAccessPropertiesWithContext is the same as ModifyWorkspaceAccessProperties with the addition of +// MigrateWorkspaceWithContext is the same as MigrateWorkspace with the addition of // the ability to pass a context and additional request options. // -// See ModifyWorkspaceAccessProperties for details on how to use this API operation. +// See MigrateWorkspace 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 *WorkSpaces) ModifyWorkspaceAccessPropertiesWithContext(ctx aws.Context, input *ModifyWorkspaceAccessPropertiesInput, opts ...request.Option) (*ModifyWorkspaceAccessPropertiesOutput, error) { - req, out := c.ModifyWorkspaceAccessPropertiesRequest(input) +func (c *WorkSpaces) MigrateWorkspaceWithContext(ctx aws.Context, input *MigrateWorkspaceInput, opts ...request.Option) (*MigrateWorkspaceOutput, error) { + req, out := c.MigrateWorkspaceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opModifyWorkspaceCreationProperties = "ModifyWorkspaceCreationProperties" +const opModifyAccount = "ModifyAccount" -// ModifyWorkspaceCreationPropertiesRequest generates a "aws/request.Request" representing the -// client's request for the ModifyWorkspaceCreationProperties operation. The "output" return +// ModifyAccountRequest generates a "aws/request.Request" representing the +// client's request for the ModifyAccount 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 ModifyWorkspaceCreationProperties for more information on using the ModifyWorkspaceCreationProperties +// See ModifyAccount for more information on using the ModifyAccount // 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 ModifyWorkspaceCreationPropertiesRequest method. -// req, resp := client.ModifyWorkspaceCreationPropertiesRequest(params) +// // Example sending a request using the ModifyAccountRequest method. +// req, resp := client.ModifyAccountRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceCreationProperties -func (c *WorkSpaces) ModifyWorkspaceCreationPropertiesRequest(input *ModifyWorkspaceCreationPropertiesInput) (req *request.Request, output *ModifyWorkspaceCreationPropertiesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyAccount +func (c *WorkSpaces) ModifyAccountRequest(input *ModifyAccountInput) (req *request.Request, output *ModifyAccountOutput) { op := &request.Operation{ - Name: opModifyWorkspaceCreationProperties, + Name: opModifyAccount, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ModifyWorkspaceCreationPropertiesInput{} + input = &ModifyAccountInput{} } - output = &ModifyWorkspaceCreationPropertiesOutput{} + output = &ModifyAccountOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ModifyWorkspaceCreationProperties API operation for Amazon WorkSpaces. +// ModifyAccount API operation for Amazon WorkSpaces. // -// Modify the default properties used to create WorkSpaces. +// Modifies the configuration of Bring Your Own License (BYOL) for the specified +// account. // // 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 Amazon WorkSpaces's -// API operation ModifyWorkspaceCreationProperties for usage and error information. +// API operation ModifyAccount for usage and error information. // // Returned Error Types: // +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// // - AccessDeniedException // The user is not authorized to access a resource. // -// - InvalidParameterValuesException -// One or more parameter values are not valid. +// - InvalidResourceStateException +// The state of the resource is not valid for this operation. +// +// - ResourceUnavailableException +// The specified resource is not available. // // - ResourceNotFoundException // The resource could not be found. // -// - OperationNotSupportedException -// This operation is not supported. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceCreationProperties -func (c *WorkSpaces) ModifyWorkspaceCreationProperties(input *ModifyWorkspaceCreationPropertiesInput) (*ModifyWorkspaceCreationPropertiesOutput, error) { - req, out := c.ModifyWorkspaceCreationPropertiesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyAccount +func (c *WorkSpaces) ModifyAccount(input *ModifyAccountInput) (*ModifyAccountOutput, error) { + req, out := c.ModifyAccountRequest(input) return out, req.Send() } -// ModifyWorkspaceCreationPropertiesWithContext is the same as ModifyWorkspaceCreationProperties with the addition of +// ModifyAccountWithContext is the same as ModifyAccount with the addition of // the ability to pass a context and additional request options. // -// See ModifyWorkspaceCreationProperties for details on how to use this API operation. +// See ModifyAccount 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 *WorkSpaces) ModifyWorkspaceCreationPropertiesWithContext(ctx aws.Context, input *ModifyWorkspaceCreationPropertiesInput, opts ...request.Option) (*ModifyWorkspaceCreationPropertiesOutput, error) { - req, out := c.ModifyWorkspaceCreationPropertiesRequest(input) +func (c *WorkSpaces) ModifyAccountWithContext(ctx aws.Context, input *ModifyAccountInput, opts ...request.Option) (*ModifyAccountOutput, error) { + req, out := c.ModifyAccountRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opModifyWorkspaceProperties = "ModifyWorkspaceProperties" +const opModifyCertificateBasedAuthProperties = "ModifyCertificateBasedAuthProperties" -// ModifyWorkspacePropertiesRequest generates a "aws/request.Request" representing the -// client's request for the ModifyWorkspaceProperties operation. The "output" return +// ModifyCertificateBasedAuthPropertiesRequest generates a "aws/request.Request" representing the +// client's request for the ModifyCertificateBasedAuthProperties 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 ModifyWorkspaceProperties for more information on using the ModifyWorkspaceProperties +// See ModifyCertificateBasedAuthProperties for more information on using the ModifyCertificateBasedAuthProperties // 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 ModifyWorkspacePropertiesRequest method. -// req, resp := client.ModifyWorkspacePropertiesRequest(params) +// // Example sending a request using the ModifyCertificateBasedAuthPropertiesRequest method. +// req, resp := client.ModifyCertificateBasedAuthPropertiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties -func (c *WorkSpaces) ModifyWorkspacePropertiesRequest(input *ModifyWorkspacePropertiesInput) (req *request.Request, output *ModifyWorkspacePropertiesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties +func (c *WorkSpaces) ModifyCertificateBasedAuthPropertiesRequest(input *ModifyCertificateBasedAuthPropertiesInput) (req *request.Request, output *ModifyCertificateBasedAuthPropertiesOutput) { op := &request.Operation{ - Name: opModifyWorkspaceProperties, + Name: opModifyCertificateBasedAuthProperties, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ModifyWorkspacePropertiesInput{} + input = &ModifyCertificateBasedAuthPropertiesInput{} } - output = &ModifyWorkspacePropertiesOutput{} + output = &ModifyCertificateBasedAuthPropertiesOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ModifyWorkspaceProperties API operation for Amazon WorkSpaces. -// -// Modifies the specified WorkSpace properties. For important information about -// how to modify the size of the root and user volumes, see Modify a WorkSpace -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html). +// ModifyCertificateBasedAuthProperties API operation for Amazon WorkSpaces. // -// The MANUAL running mode value is only supported by Amazon WorkSpaces Core. -// Contact your account team to be allow-listed to use this value. For more -// information, see Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/). +// Modifies the properties of the certificate-based authentication you want +// to use with your WorkSpaces. // // 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 Amazon WorkSpaces's -// API operation ModifyWorkspaceProperties for usage and error information. +// API operation ModifyCertificateBasedAuthProperties for usage and error information. // // Returned Error Types: // +// - AccessDeniedException +// The user is not authorized to access a resource. +// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - InvalidResourceStateException -// The state of the resource is not valid for this operation. -// -// - OperationInProgressException -// The properties of this WorkSpace are currently being modified. Try again -// in a moment. -// -// - UnsupportedWorkspaceConfigurationException -// The configuration of this WorkSpace is not supported for this operation. -// For more information, see Required Configuration and Service Components for -// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html). +// - OperationNotSupportedException +// This operation is not supported. // // - ResourceNotFoundException // The resource could not be found. // -// - AccessDeniedException -// The user is not authorized to access a resource. -// -// - ResourceUnavailableException -// The specified resource is not available. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties -func (c *WorkSpaces) ModifyWorkspaceProperties(input *ModifyWorkspacePropertiesInput) (*ModifyWorkspacePropertiesOutput, error) { - req, out := c.ModifyWorkspacePropertiesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties +func (c *WorkSpaces) ModifyCertificateBasedAuthProperties(input *ModifyCertificateBasedAuthPropertiesInput) (*ModifyCertificateBasedAuthPropertiesOutput, error) { + req, out := c.ModifyCertificateBasedAuthPropertiesRequest(input) return out, req.Send() } -// ModifyWorkspacePropertiesWithContext is the same as ModifyWorkspaceProperties with the addition of +// ModifyCertificateBasedAuthPropertiesWithContext is the same as ModifyCertificateBasedAuthProperties with the addition of // the ability to pass a context and additional request options. // -// See ModifyWorkspaceProperties for details on how to use this API operation. +// See ModifyCertificateBasedAuthProperties 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 *WorkSpaces) ModifyWorkspacePropertiesWithContext(ctx aws.Context, input *ModifyWorkspacePropertiesInput, opts ...request.Option) (*ModifyWorkspacePropertiesOutput, error) { - req, out := c.ModifyWorkspacePropertiesRequest(input) +func (c *WorkSpaces) ModifyCertificateBasedAuthPropertiesWithContext(ctx aws.Context, input *ModifyCertificateBasedAuthPropertiesInput, opts ...request.Option) (*ModifyCertificateBasedAuthPropertiesOutput, error) { + req, out := c.ModifyCertificateBasedAuthPropertiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opModifyWorkspaceState = "ModifyWorkspaceState" +const opModifyClientProperties = "ModifyClientProperties" -// ModifyWorkspaceStateRequest generates a "aws/request.Request" representing the -// client's request for the ModifyWorkspaceState operation. The "output" return +// ModifyClientPropertiesRequest generates a "aws/request.Request" representing the +// client's request for the ModifyClientProperties 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 ModifyWorkspaceState for more information on using the ModifyWorkspaceState +// See ModifyClientProperties for more information on using the ModifyClientProperties // 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 ModifyWorkspaceStateRequest method. -// req, resp := client.ModifyWorkspaceStateRequest(params) +// // Example sending a request using the ModifyClientPropertiesRequest method. +// req, resp := client.ModifyClientPropertiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceState -func (c *WorkSpaces) ModifyWorkspaceStateRequest(input *ModifyWorkspaceStateInput) (req *request.Request, output *ModifyWorkspaceStateOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyClientProperties +func (c *WorkSpaces) ModifyClientPropertiesRequest(input *ModifyClientPropertiesInput) (req *request.Request, output *ModifyClientPropertiesOutput) { op := &request.Operation{ - Name: opModifyWorkspaceState, + Name: opModifyClientProperties, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ModifyWorkspaceStateInput{} + input = &ModifyClientPropertiesInput{} } - output = &ModifyWorkspaceStateOutput{} + output = &ModifyClientPropertiesOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ModifyWorkspaceState API operation for Amazon WorkSpaces. -// -// Sets the state of the specified WorkSpace. +// ModifyClientProperties API operation for Amazon WorkSpaces. // -// To maintain a WorkSpace without being interrupted, set the WorkSpace state -// to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests -// to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this -// state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE -// state. +// Modifies the properties of the specified Amazon WorkSpaces clients. // // 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 Amazon WorkSpaces's -// API operation ModifyWorkspaceState for usage and error information. +// API operation ModifyClientProperties for usage and error information. // // Returned Error Types: // // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - InvalidResourceStateException -// The state of the resource is not valid for this operation. -// // - ResourceNotFoundException // The resource could not be found. // -// - OperationNotSupportedException -// This operation is not supported. +// - AccessDeniedException +// The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceState -func (c *WorkSpaces) ModifyWorkspaceState(input *ModifyWorkspaceStateInput) (*ModifyWorkspaceStateOutput, error) { - req, out := c.ModifyWorkspaceStateRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyClientProperties +func (c *WorkSpaces) ModifyClientProperties(input *ModifyClientPropertiesInput) (*ModifyClientPropertiesOutput, error) { + req, out := c.ModifyClientPropertiesRequest(input) return out, req.Send() } -// ModifyWorkspaceStateWithContext is the same as ModifyWorkspaceState with the addition of +// ModifyClientPropertiesWithContext is the same as ModifyClientProperties with the addition of // the ability to pass a context and additional request options. // -// See ModifyWorkspaceState for details on how to use this API operation. +// See ModifyClientProperties 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 *WorkSpaces) ModifyWorkspaceStateWithContext(ctx aws.Context, input *ModifyWorkspaceStateInput, opts ...request.Option) (*ModifyWorkspaceStateOutput, error) { - req, out := c.ModifyWorkspaceStateRequest(input) +func (c *WorkSpaces) ModifyClientPropertiesWithContext(ctx aws.Context, input *ModifyClientPropertiesInput, opts ...request.Option) (*ModifyClientPropertiesOutput, error) { + req, out := c.ModifyClientPropertiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opRebootWorkspaces = "RebootWorkspaces" +const opModifySamlProperties = "ModifySamlProperties" -// RebootWorkspacesRequest generates a "aws/request.Request" representing the -// client's request for the RebootWorkspaces operation. The "output" return +// ModifySamlPropertiesRequest generates a "aws/request.Request" representing the +// client's request for the ModifySamlProperties 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 RebootWorkspaces for more information on using the RebootWorkspaces +// See ModifySamlProperties for more information on using the ModifySamlProperties // 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 RebootWorkspacesRequest method. -// req, resp := client.RebootWorkspacesRequest(params) +// // Example sending a request using the ModifySamlPropertiesRequest method. +// req, resp := client.ModifySamlPropertiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces -func (c *WorkSpaces) RebootWorkspacesRequest(input *RebootWorkspacesInput) (req *request.Request, output *RebootWorkspacesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlProperties +func (c *WorkSpaces) ModifySamlPropertiesRequest(input *ModifySamlPropertiesInput) (req *request.Request, output *ModifySamlPropertiesOutput) { op := &request.Operation{ - Name: opRebootWorkspaces, + Name: opModifySamlProperties, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &RebootWorkspacesInput{} + input = &ModifySamlPropertiesInput{} } - output = &RebootWorkspacesOutput{} + output = &ModifySamlPropertiesOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// RebootWorkspaces API operation for Amazon WorkSpaces. -// -// Reboots the specified WorkSpaces. +// ModifySamlProperties API operation for Amazon WorkSpaces. // -// You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY. -// -// This operation is asynchronous and returns before the WorkSpaces have rebooted. +// Modifies multiple properties related to SAML 2.0 authentication, including +// the enablement status, user access URL, and relay state parameter name that +// are used for configuring federation with an SAML 2.0 identity provider. // // 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 Amazon WorkSpaces's -// API operation RebootWorkspaces for usage and error information. +// API operation ModifySamlProperties for usage and error information. // // Returned Error Types: +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// // - OperationNotSupportedException // This operation is not supported. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces -func (c *WorkSpaces) RebootWorkspaces(input *RebootWorkspacesInput) (*RebootWorkspacesOutput, error) { - req, out := c.RebootWorkspacesRequest(input) +// - ResourceNotFoundException +// The resource could not be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlProperties +func (c *WorkSpaces) ModifySamlProperties(input *ModifySamlPropertiesInput) (*ModifySamlPropertiesOutput, error) { + req, out := c.ModifySamlPropertiesRequest(input) return out, req.Send() } -// RebootWorkspacesWithContext is the same as RebootWorkspaces with the addition of +// ModifySamlPropertiesWithContext is the same as ModifySamlProperties with the addition of // the ability to pass a context and additional request options. // -// See RebootWorkspaces for details on how to use this API operation. +// See ModifySamlProperties 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 *WorkSpaces) RebootWorkspacesWithContext(ctx aws.Context, input *RebootWorkspacesInput, opts ...request.Option) (*RebootWorkspacesOutput, error) { - req, out := c.RebootWorkspacesRequest(input) +func (c *WorkSpaces) ModifySamlPropertiesWithContext(ctx aws.Context, input *ModifySamlPropertiesInput, opts ...request.Option) (*ModifySamlPropertiesOutput, error) { + req, out := c.ModifySamlPropertiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opRebuildWorkspaces = "RebuildWorkspaces" +const opModifySelfservicePermissions = "ModifySelfservicePermissions" -// RebuildWorkspacesRequest generates a "aws/request.Request" representing the -// client's request for the RebuildWorkspaces operation. The "output" return +// ModifySelfservicePermissionsRequest generates a "aws/request.Request" representing the +// client's request for the ModifySelfservicePermissions 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 RebuildWorkspaces for more information on using the RebuildWorkspaces +// See ModifySelfservicePermissions for more information on using the ModifySelfservicePermissions // 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 RebuildWorkspacesRequest method. -// req, resp := client.RebuildWorkspacesRequest(params) +// // Example sending a request using the ModifySelfservicePermissionsRequest method. +// req, resp := client.ModifySelfservicePermissionsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces -func (c *WorkSpaces) RebuildWorkspacesRequest(input *RebuildWorkspacesInput) (req *request.Request, output *RebuildWorkspacesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySelfservicePermissions +func (c *WorkSpaces) ModifySelfservicePermissionsRequest(input *ModifySelfservicePermissionsInput) (req *request.Request, output *ModifySelfservicePermissionsOutput) { op := &request.Operation{ - Name: opRebuildWorkspaces, + Name: opModifySelfservicePermissions, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &RebuildWorkspacesInput{} + input = &ModifySelfservicePermissionsInput{} } - output = &RebuildWorkspacesOutput{} + output = &ModifySelfservicePermissionsOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// RebuildWorkspaces API operation for Amazon WorkSpaces. -// -// Rebuilds the specified WorkSpace. -// -// You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, -// STOPPED, or REBOOTING. -// -// Rebuilding a WorkSpace is a potentially destructive action that can result -// in the loss of data. For more information, see Rebuild a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html). +// ModifySelfservicePermissions API operation for Amazon WorkSpaces. // -// This operation is asynchronous and returns before the WorkSpaces have been -// completely rebuilt. +// Modifies the self-service WorkSpace management capabilities for your users. +// For more information, see Enable Self-Service WorkSpace Management Capabilities +// for Your Users (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.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 Amazon WorkSpaces's -// API operation RebuildWorkspaces for usage and error information. +// API operation ModifySelfservicePermissions for usage and error information. // // Returned Error Types: -// - OperationNotSupportedException -// This operation is not supported. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces -func (c *WorkSpaces) RebuildWorkspaces(input *RebuildWorkspacesInput) (*RebuildWorkspacesOutput, error) { - req, out := c.RebuildWorkspacesRequest(input) +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - ResourceNotFoundException +// The resource could not be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySelfservicePermissions +func (c *WorkSpaces) ModifySelfservicePermissions(input *ModifySelfservicePermissionsInput) (*ModifySelfservicePermissionsOutput, error) { + req, out := c.ModifySelfservicePermissionsRequest(input) return out, req.Send() } -// RebuildWorkspacesWithContext is the same as RebuildWorkspaces with the addition of +// ModifySelfservicePermissionsWithContext is the same as ModifySelfservicePermissions with the addition of // the ability to pass a context and additional request options. // -// See RebuildWorkspaces for details on how to use this API operation. +// See ModifySelfservicePermissions 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 *WorkSpaces) RebuildWorkspacesWithContext(ctx aws.Context, input *RebuildWorkspacesInput, opts ...request.Option) (*RebuildWorkspacesOutput, error) { - req, out := c.RebuildWorkspacesRequest(input) +func (c *WorkSpaces) ModifySelfservicePermissionsWithContext(ctx aws.Context, input *ModifySelfservicePermissionsInput, opts ...request.Option) (*ModifySelfservicePermissionsOutput, error) { + req, out := c.ModifySelfservicePermissionsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opRegisterWorkspaceDirectory = "RegisterWorkspaceDirectory" +const opModifyWorkspaceAccessProperties = "ModifyWorkspaceAccessProperties" -// RegisterWorkspaceDirectoryRequest generates a "aws/request.Request" representing the -// client's request for the RegisterWorkspaceDirectory operation. The "output" return +// ModifyWorkspaceAccessPropertiesRequest generates a "aws/request.Request" representing the +// client's request for the ModifyWorkspaceAccessProperties 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 RegisterWorkspaceDirectory for more information on using the RegisterWorkspaceDirectory +// See ModifyWorkspaceAccessProperties for more information on using the ModifyWorkspaceAccessProperties // 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 RegisterWorkspaceDirectoryRequest method. -// req, resp := client.RegisterWorkspaceDirectoryRequest(params) +// // Example sending a request using the ModifyWorkspaceAccessPropertiesRequest method. +// req, resp := client.ModifyWorkspaceAccessPropertiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectory -func (c *WorkSpaces) RegisterWorkspaceDirectoryRequest(input *RegisterWorkspaceDirectoryInput) (req *request.Request, output *RegisterWorkspaceDirectoryOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceAccessProperties +func (c *WorkSpaces) ModifyWorkspaceAccessPropertiesRequest(input *ModifyWorkspaceAccessPropertiesInput) (req *request.Request, output *ModifyWorkspaceAccessPropertiesOutput) { op := &request.Operation{ - Name: opRegisterWorkspaceDirectory, + Name: opModifyWorkspaceAccessProperties, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &RegisterWorkspaceDirectoryInput{} + input = &ModifyWorkspaceAccessPropertiesInput{} } - output = &RegisterWorkspaceDirectoryOutput{} + output = &ModifyWorkspaceAccessPropertiesOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// RegisterWorkspaceDirectory API operation for Amazon WorkSpaces. +// ModifyWorkspaceAccessProperties API operation for Amazon WorkSpaces. // -// Registers the specified directory. This operation is asynchronous and returns -// before the WorkSpace directory is registered. If this is the first time you -// are registering a directory, you will need to create the workspaces_DefaultRole -// role before you can register a directory. For more information, see Creating -// the workspaces_DefaultRole Role (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role). +// Specifies which devices and operating systems users can use to access their +// WorkSpaces. For more information, see Control Device Access (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access). // // 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 Amazon WorkSpaces's -// API operation RegisterWorkspaceDirectory for usage and error information. +// API operation ModifyWorkspaceAccessProperties for usage and error information. // // Returned Error Types: // -// - InvalidParameterValuesException -// One or more parameter values are not valid. -// // - ResourceNotFoundException // The resource could not be found. // -// - ResourceLimitExceededException -// Your resource limits have been exceeded. -// // - AccessDeniedException // The user is not authorized to access a resource. // -// - WorkspacesDefaultRoleNotFoundException -// The workspaces_DefaultRole role could not be found. If this is the first -// time you are registering a directory, you will need to create the workspaces_DefaultRole -// role before you can register a directory. For more information, see Creating -// the workspaces_DefaultRole Role (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role). -// -// - InvalidResourceStateException -// The state of the resource is not valid for this operation. -// -// - UnsupportedNetworkConfigurationException -// The configuration of this network is not supported for this operation, or -// your network configuration conflicts with the Amazon WorkSpaces management -// network IP range. For more information, see Configure a VPC for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html). -// -// - OperationNotSupportedException -// This operation is not supported. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectory -func (c *WorkSpaces) RegisterWorkspaceDirectory(input *RegisterWorkspaceDirectoryInput) (*RegisterWorkspaceDirectoryOutput, error) { - req, out := c.RegisterWorkspaceDirectoryRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceAccessProperties +func (c *WorkSpaces) ModifyWorkspaceAccessProperties(input *ModifyWorkspaceAccessPropertiesInput) (*ModifyWorkspaceAccessPropertiesOutput, error) { + req, out := c.ModifyWorkspaceAccessPropertiesRequest(input) return out, req.Send() } -// RegisterWorkspaceDirectoryWithContext is the same as RegisterWorkspaceDirectory with the addition of +// ModifyWorkspaceAccessPropertiesWithContext is the same as ModifyWorkspaceAccessProperties with the addition of // the ability to pass a context and additional request options. // -// See RegisterWorkspaceDirectory for details on how to use this API operation. +// See ModifyWorkspaceAccessProperties 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 *WorkSpaces) RegisterWorkspaceDirectoryWithContext(ctx aws.Context, input *RegisterWorkspaceDirectoryInput, opts ...request.Option) (*RegisterWorkspaceDirectoryOutput, error) { - req, out := c.RegisterWorkspaceDirectoryRequest(input) +func (c *WorkSpaces) ModifyWorkspaceAccessPropertiesWithContext(ctx aws.Context, input *ModifyWorkspaceAccessPropertiesInput, opts ...request.Option) (*ModifyWorkspaceAccessPropertiesOutput, error) { + req, out := c.ModifyWorkspaceAccessPropertiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opRestoreWorkspace = "RestoreWorkspace" +const opModifyWorkspaceCreationProperties = "ModifyWorkspaceCreationProperties" -// RestoreWorkspaceRequest generates a "aws/request.Request" representing the -// client's request for the RestoreWorkspace operation. The "output" return +// ModifyWorkspaceCreationPropertiesRequest generates a "aws/request.Request" representing the +// client's request for the ModifyWorkspaceCreationProperties 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 RestoreWorkspace for more information on using the RestoreWorkspace +// See ModifyWorkspaceCreationProperties for more information on using the ModifyWorkspaceCreationProperties // 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 RestoreWorkspaceRequest method. -// req, resp := client.RestoreWorkspaceRequest(params) +// // Example sending a request using the ModifyWorkspaceCreationPropertiesRequest method. +// req, resp := client.ModifyWorkspaceCreationPropertiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RestoreWorkspace -func (c *WorkSpaces) RestoreWorkspaceRequest(input *RestoreWorkspaceInput) (req *request.Request, output *RestoreWorkspaceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceCreationProperties +func (c *WorkSpaces) ModifyWorkspaceCreationPropertiesRequest(input *ModifyWorkspaceCreationPropertiesInput) (req *request.Request, output *ModifyWorkspaceCreationPropertiesOutput) { op := &request.Operation{ - Name: opRestoreWorkspace, + Name: opModifyWorkspaceCreationProperties, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &RestoreWorkspaceInput{} + input = &ModifyWorkspaceCreationPropertiesInput{} } - output = &RestoreWorkspaceOutput{} + output = &ModifyWorkspaceCreationPropertiesOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// RestoreWorkspace API operation for Amazon WorkSpaces. -// -// Restores the specified WorkSpace to its last known healthy state. -// -// You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, -// or STOPPED. -// -// Restoring a WorkSpace is a potentially destructive action that can result -// in the loss of data. For more information, see Restore a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html). +// ModifyWorkspaceCreationProperties API operation for Amazon WorkSpaces. // -// This operation is asynchronous and returns before the WorkSpace is completely -// restored. +// Modify the default properties used to create WorkSpaces. // // 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 Amazon WorkSpaces's -// API operation RestoreWorkspace for usage and error information. +// API operation ModifyWorkspaceCreationProperties for usage and error information. // // Returned Error Types: // +// - AccessDeniedException +// The user is not authorized to access a resource. +// // - InvalidParameterValuesException // One or more parameter values are not valid. // // - ResourceNotFoundException // The resource could not be found. // -// - AccessDeniedException -// The user is not authorized to access a resource. -// // - OperationNotSupportedException // This operation is not supported. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RestoreWorkspace -func (c *WorkSpaces) RestoreWorkspace(input *RestoreWorkspaceInput) (*RestoreWorkspaceOutput, error) { - req, out := c.RestoreWorkspaceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceCreationProperties +func (c *WorkSpaces) ModifyWorkspaceCreationProperties(input *ModifyWorkspaceCreationPropertiesInput) (*ModifyWorkspaceCreationPropertiesOutput, error) { + req, out := c.ModifyWorkspaceCreationPropertiesRequest(input) return out, req.Send() } -// RestoreWorkspaceWithContext is the same as RestoreWorkspace with the addition of +// ModifyWorkspaceCreationPropertiesWithContext is the same as ModifyWorkspaceCreationProperties with the addition of // the ability to pass a context and additional request options. // -// See RestoreWorkspace for details on how to use this API operation. +// See ModifyWorkspaceCreationProperties 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 *WorkSpaces) RestoreWorkspaceWithContext(ctx aws.Context, input *RestoreWorkspaceInput, opts ...request.Option) (*RestoreWorkspaceOutput, error) { - req, out := c.RestoreWorkspaceRequest(input) +func (c *WorkSpaces) ModifyWorkspaceCreationPropertiesWithContext(ctx aws.Context, input *ModifyWorkspaceCreationPropertiesInput, opts ...request.Option) (*ModifyWorkspaceCreationPropertiesOutput, error) { + req, out := c.ModifyWorkspaceCreationPropertiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opRevokeIpRules = "RevokeIpRules" +const opModifyWorkspaceProperties = "ModifyWorkspaceProperties" -// RevokeIpRulesRequest generates a "aws/request.Request" representing the -// client's request for the RevokeIpRules operation. The "output" return +// ModifyWorkspacePropertiesRequest generates a "aws/request.Request" representing the +// client's request for the ModifyWorkspaceProperties 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 RevokeIpRules for more information on using the RevokeIpRules +// See ModifyWorkspaceProperties for more information on using the ModifyWorkspaceProperties // 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 RevokeIpRulesRequest method. -// req, resp := client.RevokeIpRulesRequest(params) +// // Example sending a request using the ModifyWorkspacePropertiesRequest method. +// req, resp := client.ModifyWorkspacePropertiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RevokeIpRules -func (c *WorkSpaces) RevokeIpRulesRequest(input *RevokeIpRulesInput) (req *request.Request, output *RevokeIpRulesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties +func (c *WorkSpaces) ModifyWorkspacePropertiesRequest(input *ModifyWorkspacePropertiesInput) (req *request.Request, output *ModifyWorkspacePropertiesOutput) { op := &request.Operation{ - Name: opRevokeIpRules, + Name: opModifyWorkspaceProperties, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &RevokeIpRulesInput{} + input = &ModifyWorkspacePropertiesInput{} } - output = &RevokeIpRulesOutput{} + output = &ModifyWorkspacePropertiesOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// RevokeIpRules API operation for Amazon WorkSpaces. +// ModifyWorkspaceProperties API operation for Amazon WorkSpaces. // -// Removes one or more rules from the specified IP access control group. +// Modifies the specified WorkSpace properties. For important information about +// how to modify the size of the root and user volumes, see Modify a WorkSpace +// (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html). +// +// The MANUAL running mode value is only supported by Amazon WorkSpaces Core. +// Contact your account team to be allow-listed to use this value. For more +// information, see Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/). // // 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 Amazon WorkSpaces's -// API operation RevokeIpRules for usage and error information. +// API operation ModifyWorkspaceProperties for usage and error information. // // Returned Error Types: // // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - ResourceNotFoundException -// The resource could not be found. -// // - InvalidResourceStateException // The state of the resource is not valid for this operation. // +// - OperationInProgressException +// The properties of this WorkSpace are currently being modified. Try again +// in a moment. +// +// - UnsupportedWorkspaceConfigurationException +// The configuration of this WorkSpace is not supported for this operation. +// For more information, see Required Configuration and Service Components for +// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html). +// +// - ResourceNotFoundException +// The resource could not be found. +// // - AccessDeniedException // The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RevokeIpRules -func (c *WorkSpaces) RevokeIpRules(input *RevokeIpRulesInput) (*RevokeIpRulesOutput, error) { - req, out := c.RevokeIpRulesRequest(input) +// - ResourceUnavailableException +// The specified resource is not available. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties +func (c *WorkSpaces) ModifyWorkspaceProperties(input *ModifyWorkspacePropertiesInput) (*ModifyWorkspacePropertiesOutput, error) { + req, out := c.ModifyWorkspacePropertiesRequest(input) return out, req.Send() } -// RevokeIpRulesWithContext is the same as RevokeIpRules with the addition of +// ModifyWorkspacePropertiesWithContext is the same as ModifyWorkspaceProperties with the addition of // the ability to pass a context and additional request options. // -// See RevokeIpRules for details on how to use this API operation. +// See ModifyWorkspaceProperties 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 *WorkSpaces) RevokeIpRulesWithContext(ctx aws.Context, input *RevokeIpRulesInput, opts ...request.Option) (*RevokeIpRulesOutput, error) { - req, out := c.RevokeIpRulesRequest(input) +func (c *WorkSpaces) ModifyWorkspacePropertiesWithContext(ctx aws.Context, input *ModifyWorkspacePropertiesInput, opts ...request.Option) (*ModifyWorkspacePropertiesOutput, error) { + req, out := c.ModifyWorkspacePropertiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartWorkspaces = "StartWorkspaces" +const opModifyWorkspaceState = "ModifyWorkspaceState" -// StartWorkspacesRequest generates a "aws/request.Request" representing the -// client's request for the StartWorkspaces operation. The "output" return +// ModifyWorkspaceStateRequest generates a "aws/request.Request" representing the +// client's request for the ModifyWorkspaceState 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 StartWorkspaces for more information on using the StartWorkspaces +// See ModifyWorkspaceState for more information on using the ModifyWorkspaceState // 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 StartWorkspacesRequest method. -// req, resp := client.StartWorkspacesRequest(params) +// // Example sending a request using the ModifyWorkspaceStateRequest method. +// req, resp := client.ModifyWorkspaceStateRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces -func (c *WorkSpaces) StartWorkspacesRequest(input *StartWorkspacesInput) (req *request.Request, output *StartWorkspacesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceState +func (c *WorkSpaces) ModifyWorkspaceStateRequest(input *ModifyWorkspaceStateInput) (req *request.Request, output *ModifyWorkspaceStateOutput) { op := &request.Operation{ - Name: opStartWorkspaces, + Name: opModifyWorkspaceState, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartWorkspacesInput{} + input = &ModifyWorkspaceStateInput{} } - output = &StartWorkspacesOutput{} + output = &ModifyWorkspaceStateOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// StartWorkspaces API operation for Amazon WorkSpaces. +// ModifyWorkspaceState API operation for Amazon WorkSpaces. // -// Starts the specified WorkSpaces. +// Sets the state of the specified WorkSpace. // -// You cannot start a WorkSpace unless it has a running mode of AutoStop and -// a state of STOPPED. +// To maintain a WorkSpace without being interrupted, set the WorkSpace state +// to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests +// to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this +// state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE +// state. // // 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 Amazon WorkSpaces's -// API operation StartWorkspaces for usage and error information. -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces -func (c *WorkSpaces) StartWorkspaces(input *StartWorkspacesInput) (*StartWorkspacesOutput, error) { - req, out := c.StartWorkspacesRequest(input) +// API operation ModifyWorkspaceState for usage and error information. +// +// Returned Error Types: +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - InvalidResourceStateException +// The state of the resource is not valid for this operation. +// +// - ResourceNotFoundException +// The resource could not be found. +// +// - OperationNotSupportedException +// This operation is not supported. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceState +func (c *WorkSpaces) ModifyWorkspaceState(input *ModifyWorkspaceStateInput) (*ModifyWorkspaceStateOutput, error) { + req, out := c.ModifyWorkspaceStateRequest(input) return out, req.Send() } -// StartWorkspacesWithContext is the same as StartWorkspaces with the addition of +// ModifyWorkspaceStateWithContext is the same as ModifyWorkspaceState with the addition of // the ability to pass a context and additional request options. // -// See StartWorkspaces for details on how to use this API operation. +// See ModifyWorkspaceState 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 *WorkSpaces) StartWorkspacesWithContext(ctx aws.Context, input *StartWorkspacesInput, opts ...request.Option) (*StartWorkspacesOutput, error) { - req, out := c.StartWorkspacesRequest(input) +func (c *WorkSpaces) ModifyWorkspaceStateWithContext(ctx aws.Context, input *ModifyWorkspaceStateInput, opts ...request.Option) (*ModifyWorkspaceStateOutput, error) { + req, out := c.ModifyWorkspaceStateRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopWorkspaces = "StopWorkspaces" +const opRebootWorkspaces = "RebootWorkspaces" -// StopWorkspacesRequest generates a "aws/request.Request" representing the -// client's request for the StopWorkspaces operation. The "output" return +// RebootWorkspacesRequest generates a "aws/request.Request" representing the +// client's request for the RebootWorkspaces 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 StopWorkspaces for more information on using the StopWorkspaces +// See RebootWorkspaces for more information on using the RebootWorkspaces // 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 StopWorkspacesRequest method. -// req, resp := client.StopWorkspacesRequest(params) +// // Example sending a request using the RebootWorkspacesRequest method. +// req, resp := client.RebootWorkspacesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces -func (c *WorkSpaces) StopWorkspacesRequest(input *StopWorkspacesInput) (req *request.Request, output *StopWorkspacesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces +func (c *WorkSpaces) RebootWorkspacesRequest(input *RebootWorkspacesInput) (req *request.Request, output *RebootWorkspacesOutput) { op := &request.Operation{ - Name: opStopWorkspaces, + Name: opRebootWorkspaces, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StopWorkspacesInput{} + input = &RebootWorkspacesInput{} } - output = &StopWorkspacesOutput{} + output = &RebootWorkspacesOutput{} req = c.newRequest(op, input, output) return } -// StopWorkspaces API operation for Amazon WorkSpaces. +// RebootWorkspaces API operation for Amazon WorkSpaces. // -// Stops the specified WorkSpaces. +// Reboots the specified WorkSpaces. // -// You cannot stop a WorkSpace unless it has a running mode of AutoStop and -// a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. +// You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY. +// +// This operation is asynchronous and returns before the WorkSpaces have rebooted. // // 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 Amazon WorkSpaces's -// API operation StopWorkspaces for usage and error information. -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces -func (c *WorkSpaces) StopWorkspaces(input *StopWorkspacesInput) (*StopWorkspacesOutput, error) { - req, out := c.StopWorkspacesRequest(input) +// API operation RebootWorkspaces for usage and error information. +// +// Returned Error Types: +// - OperationNotSupportedException +// This operation is not supported. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces +func (c *WorkSpaces) RebootWorkspaces(input *RebootWorkspacesInput) (*RebootWorkspacesOutput, error) { + req, out := c.RebootWorkspacesRequest(input) return out, req.Send() } -// StopWorkspacesWithContext is the same as StopWorkspaces with the addition of +// RebootWorkspacesWithContext is the same as RebootWorkspaces with the addition of // the ability to pass a context and additional request options. // -// See StopWorkspaces for details on how to use this API operation. +// See RebootWorkspaces 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 *WorkSpaces) StopWorkspacesWithContext(ctx aws.Context, input *StopWorkspacesInput, opts ...request.Option) (*StopWorkspacesOutput, error) { - req, out := c.StopWorkspacesRequest(input) +func (c *WorkSpaces) RebootWorkspacesWithContext(ctx aws.Context, input *RebootWorkspacesInput, opts ...request.Option) (*RebootWorkspacesOutput, error) { + req, out := c.RebootWorkspacesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opTerminateWorkspaces = "TerminateWorkspaces" +const opRebuildWorkspaces = "RebuildWorkspaces" -// TerminateWorkspacesRequest generates a "aws/request.Request" representing the -// client's request for the TerminateWorkspaces operation. The "output" return +// RebuildWorkspacesRequest generates a "aws/request.Request" representing the +// client's request for the RebuildWorkspaces 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 TerminateWorkspaces for more information on using the TerminateWorkspaces +// See RebuildWorkspaces for more information on using the RebuildWorkspaces // 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 TerminateWorkspacesRequest method. -// req, resp := client.TerminateWorkspacesRequest(params) +// // Example sending a request using the RebuildWorkspacesRequest method. +// req, resp := client.RebuildWorkspacesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces -func (c *WorkSpaces) TerminateWorkspacesRequest(input *TerminateWorkspacesInput) (req *request.Request, output *TerminateWorkspacesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces +func (c *WorkSpaces) RebuildWorkspacesRequest(input *RebuildWorkspacesInput) (req *request.Request, output *RebuildWorkspacesOutput) { op := &request.Operation{ - Name: opTerminateWorkspaces, + Name: opRebuildWorkspaces, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &TerminateWorkspacesInput{} + input = &RebuildWorkspacesInput{} } - output = &TerminateWorkspacesOutput{} + output = &RebuildWorkspacesOutput{} req = c.newRequest(op, input, output) return } -// TerminateWorkspaces API operation for Amazon WorkSpaces. +// RebuildWorkspaces API operation for Amazon WorkSpaces. // -// Terminates the specified WorkSpaces. +// Rebuilds the specified WorkSpace. // -// Terminating a WorkSpace is a permanent action and cannot be undone. The user's -// data is destroyed. If you need to archive any user data, contact Amazon Web -// Services Support before terminating the WorkSpace. +// You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, +// STOPPED, or REBOOTING. // -// You can terminate a WorkSpace that is in any state except SUSPENDED. +// Rebuilding a WorkSpace is a potentially destructive action that can result +// in the loss of data. For more information, see Rebuild a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html). // // This operation is asynchronous and returns before the WorkSpaces have been -// completely terminated. After a WorkSpace is terminated, the TERMINATED state -// is returned only briefly before the WorkSpace directory metadata is cleaned -// up, so this state is rarely returned. To confirm that a WorkSpace is terminated, -// check for the WorkSpace ID by using DescribeWorkSpaces (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html). -// If the WorkSpace ID isn't returned, then the WorkSpace has been successfully -// terminated. -// -// Simple AD and AD Connector are made available to you free of charge to use -// with WorkSpaces. If there are no WorkSpaces being used with your Simple AD -// or AD Connector directory for 30 consecutive days, this directory will be -// automatically deregistered for use with Amazon WorkSpaces, and you will be -// charged for this directory as per the Directory Service pricing terms (http://aws.amazon.com/directoryservice/pricing/). -// -// To delete empty directories, see Delete the Directory for Your WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). -// If you delete your Simple AD or AD Connector directory, you can always create -// a new one when you want to start using WorkSpaces again. +// completely rebuilt. // // 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 Amazon WorkSpaces's -// API operation TerminateWorkspaces for usage and error information. -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces -func (c *WorkSpaces) TerminateWorkspaces(input *TerminateWorkspacesInput) (*TerminateWorkspacesOutput, error) { - req, out := c.TerminateWorkspacesRequest(input) +// API operation RebuildWorkspaces for usage and error information. +// +// Returned Error Types: +// - OperationNotSupportedException +// This operation is not supported. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces +func (c *WorkSpaces) RebuildWorkspaces(input *RebuildWorkspacesInput) (*RebuildWorkspacesOutput, error) { + req, out := c.RebuildWorkspacesRequest(input) return out, req.Send() } -// TerminateWorkspacesWithContext is the same as TerminateWorkspaces with the addition of +// RebuildWorkspacesWithContext is the same as RebuildWorkspaces with the addition of // the ability to pass a context and additional request options. // -// See TerminateWorkspaces for details on how to use this API operation. +// See RebuildWorkspaces 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 *WorkSpaces) TerminateWorkspacesWithContext(ctx aws.Context, input *TerminateWorkspacesInput, opts ...request.Option) (*TerminateWorkspacesOutput, error) { - req, out := c.TerminateWorkspacesRequest(input) +func (c *WorkSpaces) RebuildWorkspacesWithContext(ctx aws.Context, input *RebuildWorkspacesInput, opts ...request.Option) (*RebuildWorkspacesOutput, error) { + req, out := c.RebuildWorkspacesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateConnectClientAddIn = "UpdateConnectClientAddIn" +const opRegisterWorkspaceDirectory = "RegisterWorkspaceDirectory" -// UpdateConnectClientAddInRequest generates a "aws/request.Request" representing the -// client's request for the UpdateConnectClientAddIn operation. The "output" return +// RegisterWorkspaceDirectoryRequest generates a "aws/request.Request" representing the +// client's request for the RegisterWorkspaceDirectory 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 UpdateConnectClientAddIn for more information on using the UpdateConnectClientAddIn +// See RegisterWorkspaceDirectory for more information on using the RegisterWorkspaceDirectory // 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 UpdateConnectClientAddInRequest method. -// req, resp := client.UpdateConnectClientAddInRequest(params) +// // Example sending a request using the RegisterWorkspaceDirectoryRequest method. +// req, resp := client.RegisterWorkspaceDirectoryRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectClientAddIn -func (c *WorkSpaces) UpdateConnectClientAddInRequest(input *UpdateConnectClientAddInInput) (req *request.Request, output *UpdateConnectClientAddInOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectory +func (c *WorkSpaces) RegisterWorkspaceDirectoryRequest(input *RegisterWorkspaceDirectoryInput) (req *request.Request, output *RegisterWorkspaceDirectoryOutput) { op := &request.Operation{ - Name: opUpdateConnectClientAddIn, + Name: opRegisterWorkspaceDirectory, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateConnectClientAddInInput{} + input = &RegisterWorkspaceDirectoryInput{} } - output = &UpdateConnectClientAddInOutput{} + output = &RegisterWorkspaceDirectoryOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateConnectClientAddIn API operation for Amazon WorkSpaces. +// RegisterWorkspaceDirectory API operation for Amazon WorkSpaces. // -// Updates a Amazon Connect client add-in. Use this action to update the name -// and endpoint URL of a Amazon Connect client add-in. +// Registers the specified directory. This operation is asynchronous and returns +// before the WorkSpace directory is registered. If this is the first time you +// are registering a directory, you will need to create the workspaces_DefaultRole +// role before you can register a directory. For more information, see Creating +// the workspaces_DefaultRole Role (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role). // // 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 Amazon WorkSpaces's -// API operation UpdateConnectClientAddIn for usage and error information. +// API operation RegisterWorkspaceDirectory for usage and error information. // // Returned Error Types: // @@ -5708,197 +6010,202 @@ func (c *WorkSpaces) UpdateConnectClientAddInRequest(input *UpdateConnectClientA // - ResourceNotFoundException // The resource could not be found. // -// - AccessDeniedException -// The user is not authorized to access a resource. +// - ResourceLimitExceededException +// Your resource limits have been exceeded. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectClientAddIn -func (c *WorkSpaces) UpdateConnectClientAddIn(input *UpdateConnectClientAddInInput) (*UpdateConnectClientAddInOutput, error) { - req, out := c.UpdateConnectClientAddInRequest(input) +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - WorkspacesDefaultRoleNotFoundException +// The workspaces_DefaultRole role could not be found. If this is the first +// time you are registering a directory, you will need to create the workspaces_DefaultRole +// role before you can register a directory. For more information, see Creating +// the workspaces_DefaultRole Role (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role). +// +// - InvalidResourceStateException +// The state of the resource is not valid for this operation. +// +// - UnsupportedNetworkConfigurationException +// The configuration of this network is not supported for this operation, or +// your network configuration conflicts with the Amazon WorkSpaces management +// network IP range. For more information, see Configure a VPC for Amazon WorkSpaces +// (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html). +// +// - OperationNotSupportedException +// This operation is not supported. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectory +func (c *WorkSpaces) RegisterWorkspaceDirectory(input *RegisterWorkspaceDirectoryInput) (*RegisterWorkspaceDirectoryOutput, error) { + req, out := c.RegisterWorkspaceDirectoryRequest(input) return out, req.Send() } -// UpdateConnectClientAddInWithContext is the same as UpdateConnectClientAddIn with the addition of +// RegisterWorkspaceDirectoryWithContext is the same as RegisterWorkspaceDirectory with the addition of // the ability to pass a context and additional request options. // -// See UpdateConnectClientAddIn for details on how to use this API operation. +// See RegisterWorkspaceDirectory 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 *WorkSpaces) UpdateConnectClientAddInWithContext(ctx aws.Context, input *UpdateConnectClientAddInInput, opts ...request.Option) (*UpdateConnectClientAddInOutput, error) { - req, out := c.UpdateConnectClientAddInRequest(input) +func (c *WorkSpaces) RegisterWorkspaceDirectoryWithContext(ctx aws.Context, input *RegisterWorkspaceDirectoryInput, opts ...request.Option) (*RegisterWorkspaceDirectoryOutput, error) { + req, out := c.RegisterWorkspaceDirectoryRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateConnectionAliasPermission = "UpdateConnectionAliasPermission" +const opRestoreWorkspace = "RestoreWorkspace" -// UpdateConnectionAliasPermissionRequest generates a "aws/request.Request" representing the -// client's request for the UpdateConnectionAliasPermission operation. The "output" return +// RestoreWorkspaceRequest generates a "aws/request.Request" representing the +// client's request for the RestoreWorkspace 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 UpdateConnectionAliasPermission for more information on using the UpdateConnectionAliasPermission +// See RestoreWorkspace for more information on using the RestoreWorkspace // 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 UpdateConnectionAliasPermissionRequest method. -// req, resp := client.UpdateConnectionAliasPermissionRequest(params) +// // Example sending a request using the RestoreWorkspaceRequest method. +// req, resp := client.RestoreWorkspaceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermission -func (c *WorkSpaces) UpdateConnectionAliasPermissionRequest(input *UpdateConnectionAliasPermissionInput) (req *request.Request, output *UpdateConnectionAliasPermissionOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RestoreWorkspace +func (c *WorkSpaces) RestoreWorkspaceRequest(input *RestoreWorkspaceInput) (req *request.Request, output *RestoreWorkspaceOutput) { op := &request.Operation{ - Name: opUpdateConnectionAliasPermission, + Name: opRestoreWorkspace, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateConnectionAliasPermissionInput{} + input = &RestoreWorkspaceInput{} } - output = &UpdateConnectionAliasPermissionOutput{} + output = &RestoreWorkspaceOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateConnectionAliasPermission API operation for Amazon WorkSpaces. +// RestoreWorkspace API operation for Amazon WorkSpaces. // -// Shares or unshares a connection alias with one account by specifying whether -// that account has permission to associate the connection alias with a directory. -// If the association permission is granted, the connection alias is shared -// with that account. If the association permission is revoked, the connection -// alias is unshared with the account. For more information, see Cross-Region -// Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// Restores the specified WorkSpace to its last known healthy state. // -// - Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) -// to make sure that the current state of the connection alias is CREATED. +// You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, +// or STOPPED. // -// - To delete a connection alias that has been shared, the shared account -// must first disassociate the connection alias from any directories it has -// been associated with. Then you must unshare the connection alias from -// the account it has been shared with. You can delete a connection alias -// only after it is no longer shared with any accounts or associated with -// any directories. +// Restoring a WorkSpace is a potentially destructive action that can result +// in the loss of data. For more information, see Restore a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html). +// +// This operation is asynchronous and returns before the WorkSpace is completely +// restored. // // 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 Amazon WorkSpaces's -// API operation UpdateConnectionAliasPermission for usage and error information. +// API operation RestoreWorkspace for usage and error information. // // Returned Error Types: // -// - AccessDeniedException -// The user is not authorized to access a resource. -// // - InvalidParameterValuesException // One or more parameter values are not valid. // -// - ResourceLimitExceededException -// Your resource limits have been exceeded. -// // - ResourceNotFoundException // The resource could not be found. // -// - ResourceAssociatedException -// The resource is associated with a directory. -// -// - InvalidResourceStateException -// The state of the resource is not valid for this operation. +// - AccessDeniedException +// The user is not authorized to access a resource. // // - OperationNotSupportedException // This operation is not supported. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermission -func (c *WorkSpaces) UpdateConnectionAliasPermission(input *UpdateConnectionAliasPermissionInput) (*UpdateConnectionAliasPermissionOutput, error) { - req, out := c.UpdateConnectionAliasPermissionRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RestoreWorkspace +func (c *WorkSpaces) RestoreWorkspace(input *RestoreWorkspaceInput) (*RestoreWorkspaceOutput, error) { + req, out := c.RestoreWorkspaceRequest(input) return out, req.Send() } -// UpdateConnectionAliasPermissionWithContext is the same as UpdateConnectionAliasPermission with the addition of +// RestoreWorkspaceWithContext is the same as RestoreWorkspace with the addition of // the ability to pass a context and additional request options. // -// See UpdateConnectionAliasPermission for details on how to use this API operation. +// See RestoreWorkspace 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 *WorkSpaces) UpdateConnectionAliasPermissionWithContext(ctx aws.Context, input *UpdateConnectionAliasPermissionInput, opts ...request.Option) (*UpdateConnectionAliasPermissionOutput, error) { - req, out := c.UpdateConnectionAliasPermissionRequest(input) +func (c *WorkSpaces) RestoreWorkspaceWithContext(ctx aws.Context, input *RestoreWorkspaceInput, opts ...request.Option) (*RestoreWorkspaceOutput, error) { + req, out := c.RestoreWorkspaceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateRulesOfIpGroup = "UpdateRulesOfIpGroup" +const opRevokeIpRules = "RevokeIpRules" -// UpdateRulesOfIpGroupRequest generates a "aws/request.Request" representing the -// client's request for the UpdateRulesOfIpGroup operation. The "output" return +// RevokeIpRulesRequest generates a "aws/request.Request" representing the +// client's request for the RevokeIpRules 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 UpdateRulesOfIpGroup for more information on using the UpdateRulesOfIpGroup +// See RevokeIpRules for more information on using the RevokeIpRules // 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 UpdateRulesOfIpGroupRequest method. -// req, resp := client.UpdateRulesOfIpGroupRequest(params) +// // Example sending a request using the RevokeIpRulesRequest method. +// req, resp := client.RevokeIpRulesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateRulesOfIpGroup -func (c *WorkSpaces) UpdateRulesOfIpGroupRequest(input *UpdateRulesOfIpGroupInput) (req *request.Request, output *UpdateRulesOfIpGroupOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RevokeIpRules +func (c *WorkSpaces) RevokeIpRulesRequest(input *RevokeIpRulesInput) (req *request.Request, output *RevokeIpRulesOutput) { op := &request.Operation{ - Name: opUpdateRulesOfIpGroup, + Name: opRevokeIpRules, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateRulesOfIpGroupInput{} + input = &RevokeIpRulesInput{} } - output = &UpdateRulesOfIpGroupOutput{} + output = &RevokeIpRulesOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateRulesOfIpGroup API operation for Amazon WorkSpaces. +// RevokeIpRules API operation for Amazon WorkSpaces. // -// Replaces the current rules of the specified IP access control group with -// the specified rules. +// Removes one or more rules from the specified IP access control group. // // 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 Amazon WorkSpaces's -// API operation UpdateRulesOfIpGroup for usage and error information. +// API operation RevokeIpRules for usage and error information. // // Returned Error Types: // @@ -5908,251 +6215,1714 @@ func (c *WorkSpaces) UpdateRulesOfIpGroupRequest(input *UpdateRulesOfIpGroupInpu // - ResourceNotFoundException // The resource could not be found. // -// - ResourceLimitExceededException -// Your resource limits have been exceeded. -// // - InvalidResourceStateException // The state of the resource is not valid for this operation. // // - AccessDeniedException // The user is not authorized to access a resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateRulesOfIpGroup -func (c *WorkSpaces) UpdateRulesOfIpGroup(input *UpdateRulesOfIpGroupInput) (*UpdateRulesOfIpGroupOutput, error) { - req, out := c.UpdateRulesOfIpGroupRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RevokeIpRules +func (c *WorkSpaces) RevokeIpRules(input *RevokeIpRulesInput) (*RevokeIpRulesOutput, error) { + req, out := c.RevokeIpRulesRequest(input) return out, req.Send() } -// UpdateRulesOfIpGroupWithContext is the same as UpdateRulesOfIpGroup with the addition of +// RevokeIpRulesWithContext is the same as RevokeIpRules with the addition of // the ability to pass a context and additional request options. // -// See UpdateRulesOfIpGroup for details on how to use this API operation. +// See RevokeIpRules 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 *WorkSpaces) UpdateRulesOfIpGroupWithContext(ctx aws.Context, input *UpdateRulesOfIpGroupInput, opts ...request.Option) (*UpdateRulesOfIpGroupOutput, error) { - req, out := c.UpdateRulesOfIpGroupRequest(input) +func (c *WorkSpaces) RevokeIpRulesWithContext(ctx aws.Context, input *RevokeIpRulesInput, opts ...request.Option) (*RevokeIpRulesOutput, error) { + req, out := c.RevokeIpRulesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateWorkspaceBundle = "UpdateWorkspaceBundle" +const opStartWorkspaces = "StartWorkspaces" -// UpdateWorkspaceBundleRequest generates a "aws/request.Request" representing the -// client's request for the UpdateWorkspaceBundle operation. The "output" return +// StartWorkspacesRequest generates a "aws/request.Request" representing the +// client's request for the StartWorkspaces 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 UpdateWorkspaceBundle for more information on using the UpdateWorkspaceBundle +// See StartWorkspaces for more information on using the StartWorkspaces // 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 UpdateWorkspaceBundleRequest method. -// req, resp := client.UpdateWorkspaceBundleRequest(params) +// // Example sending a request using the StartWorkspacesRequest method. +// req, resp := client.StartWorkspacesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceBundle -func (c *WorkSpaces) UpdateWorkspaceBundleRequest(input *UpdateWorkspaceBundleInput) (req *request.Request, output *UpdateWorkspaceBundleOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces +func (c *WorkSpaces) StartWorkspacesRequest(input *StartWorkspacesInput) (req *request.Request, output *StartWorkspacesOutput) { op := &request.Operation{ - Name: opUpdateWorkspaceBundle, + Name: opStartWorkspaces, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateWorkspaceBundleInput{} + input = &StartWorkspacesInput{} } - output = &UpdateWorkspaceBundleOutput{} + output = &StartWorkspacesOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateWorkspaceBundle API operation for Amazon WorkSpaces. +// StartWorkspaces API operation for Amazon WorkSpaces. // -// Updates a WorkSpace bundle with a new image. For more information about updating -// WorkSpace bundles, see Update a Custom WorkSpaces Bundle (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html). +// Starts the specified WorkSpaces. // -// Existing WorkSpaces aren't automatically updated when you update the bundle -// that they're based on. To update existing WorkSpaces that are based on a -// bundle that you've updated, you must either rebuild the WorkSpaces or delete -// and recreate them. +// You cannot start a WorkSpace unless it has a running mode of AutoStop and +// a state of STOPPED. // // 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 Amazon WorkSpaces's -// API operation UpdateWorkspaceBundle for usage and error information. -// -// Returned Error Types: -// -// - AccessDeniedException -// The user is not authorized to access a resource. -// -// - InvalidParameterValuesException -// One or more parameter values are not valid. -// -// - ResourceNotFoundException -// The resource could not be found. -// -// - ResourceUnavailableException -// The specified resource is not available. -// -// - OperationNotSupportedException -// This operation is not supported. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceBundle -func (c *WorkSpaces) UpdateWorkspaceBundle(input *UpdateWorkspaceBundleInput) (*UpdateWorkspaceBundleOutput, error) { - req, out := c.UpdateWorkspaceBundleRequest(input) +// API operation StartWorkspaces for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces +func (c *WorkSpaces) StartWorkspaces(input *StartWorkspacesInput) (*StartWorkspacesOutput, error) { + req, out := c.StartWorkspacesRequest(input) return out, req.Send() } -// UpdateWorkspaceBundleWithContext is the same as UpdateWorkspaceBundle with the addition of +// StartWorkspacesWithContext is the same as StartWorkspaces with the addition of // the ability to pass a context and additional request options. // -// See UpdateWorkspaceBundle for details on how to use this API operation. +// See StartWorkspaces 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 *WorkSpaces) UpdateWorkspaceBundleWithContext(ctx aws.Context, input *UpdateWorkspaceBundleInput, opts ...request.Option) (*UpdateWorkspaceBundleOutput, error) { - req, out := c.UpdateWorkspaceBundleRequest(input) +func (c *WorkSpaces) StartWorkspacesWithContext(ctx aws.Context, input *StartWorkspacesInput, opts ...request.Option) (*StartWorkspacesOutput, error) { + req, out := c.StartWorkspacesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateWorkspaceImagePermission = "UpdateWorkspaceImagePermission" +const opStopWorkspaces = "StopWorkspaces" -// UpdateWorkspaceImagePermissionRequest generates a "aws/request.Request" representing the -// client's request for the UpdateWorkspaceImagePermission operation. The "output" return +// StopWorkspacesRequest generates a "aws/request.Request" representing the +// client's request for the StopWorkspaces 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 UpdateWorkspaceImagePermission for more information on using the UpdateWorkspaceImagePermission +// See StopWorkspaces for more information on using the StopWorkspaces // 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 UpdateWorkspaceImagePermissionRequest method. -// req, resp := client.UpdateWorkspaceImagePermissionRequest(params) +// // Example sending a request using the StopWorkspacesRequest method. +// req, resp := client.StopWorkspacesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceImagePermission -func (c *WorkSpaces) UpdateWorkspaceImagePermissionRequest(input *UpdateWorkspaceImagePermissionInput) (req *request.Request, output *UpdateWorkspaceImagePermissionOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces +func (c *WorkSpaces) StopWorkspacesRequest(input *StopWorkspacesInput) (req *request.Request, output *StopWorkspacesOutput) { op := &request.Operation{ - Name: opUpdateWorkspaceImagePermission, + Name: opStopWorkspaces, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateWorkspaceImagePermissionInput{} + input = &StopWorkspacesInput{} } - output = &UpdateWorkspaceImagePermissionOutput{} + output = &StopWorkspacesOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateWorkspaceImagePermission API operation for Amazon WorkSpaces. +// StopWorkspaces API operation for Amazon WorkSpaces. // -// Shares or unshares an image with one account in the same Amazon Web Services -// Region by specifying whether that account has permission to copy the image. -// If the copy image permission is granted, the image is shared with that account. -// If the copy image permission is revoked, the image is unshared with the account. +// Stops the specified WorkSpaces. // -// After an image has been shared, the recipient account can copy the image -// to other Regions as needed. +// You cannot stop a WorkSpace unless it has a running mode of AutoStop and +// a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. // -// In the China (Ningxia) Region, you can copy images only within the same Region. +// 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. // -// In Amazon Web Services GovCloud (US), to copy images to and from other Regions, -// contact Amazon Web Services Support. +// See the AWS API reference guide for Amazon WorkSpaces's +// API operation StopWorkspaces for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces +func (c *WorkSpaces) StopWorkspaces(input *StopWorkspacesInput) (*StopWorkspacesOutput, error) { + req, out := c.StopWorkspacesRequest(input) + return out, req.Send() +} + +// StopWorkspacesWithContext is the same as StopWorkspaces with the addition of +// the ability to pass a context and additional request options. // -// For more information about sharing images, see Share or Unshare a Custom -// WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html). +// See StopWorkspaces for details on how to use this API operation. // -// - To delete an image that has been shared, you must unshare the image -// before you delete it. +// 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 *WorkSpaces) StopWorkspacesWithContext(ctx aws.Context, input *StopWorkspacesInput, opts ...request.Option) (*StopWorkspacesOutput, error) { + req, out := c.StopWorkspacesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTerminateWorkspaces = "TerminateWorkspaces" + +// TerminateWorkspacesRequest generates a "aws/request.Request" representing the +// client's request for the TerminateWorkspaces operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. // -// - Sharing Bring Your Own License (BYOL) images across Amazon Web Services -// accounts isn't supported at this time in Amazon Web Services GovCloud -// (US). To share BYOL images across accounts in Amazon Web Services GovCloud -// (US), contact Amazon Web Services Support. +// 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 TerminateWorkspaces for more information on using the TerminateWorkspaces +// 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 TerminateWorkspacesRequest method. +// req, resp := client.TerminateWorkspacesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces +func (c *WorkSpaces) TerminateWorkspacesRequest(input *TerminateWorkspacesInput) (req *request.Request, output *TerminateWorkspacesOutput) { + op := &request.Operation{ + Name: opTerminateWorkspaces, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &TerminateWorkspacesInput{} + } + + output = &TerminateWorkspacesOutput{} + req = c.newRequest(op, input, output) + return +} + +// TerminateWorkspaces API operation for Amazon WorkSpaces. +// +// Terminates the specified WorkSpaces. +// +// Terminating a WorkSpace is a permanent action and cannot be undone. The user's +// data is destroyed. If you need to archive any user data, contact Amazon Web +// Services Support before terminating the WorkSpace. +// +// You can terminate a WorkSpace that is in any state except SUSPENDED. +// +// This operation is asynchronous and returns before the WorkSpaces have been +// completely terminated. After a WorkSpace is terminated, the TERMINATED state +// is returned only briefly before the WorkSpace directory metadata is cleaned +// up, so this state is rarely returned. To confirm that a WorkSpace is terminated, +// check for the WorkSpace ID by using DescribeWorkSpaces (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html). +// If the WorkSpace ID isn't returned, then the WorkSpace has been successfully +// terminated. +// +// Simple AD and AD Connector are made available to you free of charge to use +// with WorkSpaces. If there are no WorkSpaces being used with your Simple AD +// or AD Connector directory for 30 consecutive days, this directory will be +// automatically deregistered for use with Amazon WorkSpaces, and you will be +// charged for this directory as per the Directory Service pricing terms (http://aws.amazon.com/directoryservice/pricing/). +// +// To delete empty directories, see Delete the Directory for Your WorkSpaces +// (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). +// If you delete your Simple AD or AD Connector directory, you can always create +// a new one when you want to start using WorkSpaces again. // // 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 Amazon WorkSpaces's -// API operation UpdateWorkspaceImagePermission for usage and error information. +// API operation TerminateWorkspaces for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces +func (c *WorkSpaces) TerminateWorkspaces(input *TerminateWorkspacesInput) (*TerminateWorkspacesOutput, error) { + req, out := c.TerminateWorkspacesRequest(input) + return out, req.Send() +} + +// TerminateWorkspacesWithContext is the same as TerminateWorkspaces with the addition of +// the ability to pass a context and additional request options. +// +// See TerminateWorkspaces 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 *WorkSpaces) TerminateWorkspacesWithContext(ctx aws.Context, input *TerminateWorkspacesInput, opts ...request.Option) (*TerminateWorkspacesOutput, error) { + req, out := c.TerminateWorkspacesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateConnectClientAddIn = "UpdateConnectClientAddIn" + +// UpdateConnectClientAddInRequest generates a "aws/request.Request" representing the +// client's request for the UpdateConnectClientAddIn 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 UpdateConnectClientAddIn for more information on using the UpdateConnectClientAddIn +// 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 UpdateConnectClientAddInRequest method. +// req, resp := client.UpdateConnectClientAddInRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectClientAddIn +func (c *WorkSpaces) UpdateConnectClientAddInRequest(input *UpdateConnectClientAddInInput) (req *request.Request, output *UpdateConnectClientAddInOutput) { + op := &request.Operation{ + Name: opUpdateConnectClientAddIn, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateConnectClientAddInInput{} + } + + output = &UpdateConnectClientAddInOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateConnectClientAddIn API operation for Amazon WorkSpaces. +// +// Updates a Amazon Connect client add-in. Use this action to update the name +// and endpoint URL of a Amazon Connect client add-in. +// +// 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 Amazon WorkSpaces's +// API operation UpdateConnectClientAddIn for usage and error information. // // Returned Error Types: // +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// // - ResourceNotFoundException // The resource could not be found. // -// - ResourceUnavailableException -// The specified resource is not available. -// // - AccessDeniedException // The user is not authorized to access a resource. // -// - InvalidParameterValuesException -// One or more parameter values are not valid. +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectClientAddIn +func (c *WorkSpaces) UpdateConnectClientAddIn(input *UpdateConnectClientAddInInput) (*UpdateConnectClientAddInOutput, error) { + req, out := c.UpdateConnectClientAddInRequest(input) + return out, req.Send() +} + +// UpdateConnectClientAddInWithContext is the same as UpdateConnectClientAddIn with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateConnectClientAddIn 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 *WorkSpaces) UpdateConnectClientAddInWithContext(ctx aws.Context, input *UpdateConnectClientAddInInput, opts ...request.Option) (*UpdateConnectClientAddInOutput, error) { + req, out := c.UpdateConnectClientAddInRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateConnectionAliasPermission = "UpdateConnectionAliasPermission" + +// UpdateConnectionAliasPermissionRequest generates a "aws/request.Request" representing the +// client's request for the UpdateConnectionAliasPermission 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 UpdateConnectionAliasPermission for more information on using the UpdateConnectionAliasPermission +// 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 UpdateConnectionAliasPermissionRequest method. +// req, resp := client.UpdateConnectionAliasPermissionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermission +func (c *WorkSpaces) UpdateConnectionAliasPermissionRequest(input *UpdateConnectionAliasPermissionInput) (req *request.Request, output *UpdateConnectionAliasPermissionOutput) { + op := &request.Operation{ + Name: opUpdateConnectionAliasPermission, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateConnectionAliasPermissionInput{} + } + + output = &UpdateConnectionAliasPermissionOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateConnectionAliasPermission API operation for Amazon WorkSpaces. +// +// Shares or unshares a connection alias with one account by specifying whether +// that account has permission to associate the connection alias with a directory. +// If the association permission is granted, the connection alias is shared +// with that account. If the association permission is revoked, the connection +// alias is unshared with the account. For more information, see Cross-Region +// Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// +// - Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) +// to make sure that the current state of the connection alias is CREATED. +// +// - To delete a connection alias that has been shared, the shared account +// must first disassociate the connection alias from any directories it has +// been associated with. Then you must unshare the connection alias from +// the account it has been shared with. You can delete a connection alias +// only after it is no longer shared with any accounts or associated with +// any directories. +// +// 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 Amazon WorkSpaces's +// API operation UpdateConnectionAliasPermission for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - ResourceLimitExceededException +// Your resource limits have been exceeded. +// +// - ResourceNotFoundException +// The resource could not be found. +// +// - ResourceAssociatedException +// The resource is associated with a directory. +// +// - InvalidResourceStateException +// The state of the resource is not valid for this operation. +// +// - OperationNotSupportedException +// This operation is not supported. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermission +func (c *WorkSpaces) UpdateConnectionAliasPermission(input *UpdateConnectionAliasPermissionInput) (*UpdateConnectionAliasPermissionOutput, error) { + req, out := c.UpdateConnectionAliasPermissionRequest(input) + return out, req.Send() +} + +// UpdateConnectionAliasPermissionWithContext is the same as UpdateConnectionAliasPermission with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateConnectionAliasPermission 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 *WorkSpaces) UpdateConnectionAliasPermissionWithContext(ctx aws.Context, input *UpdateConnectionAliasPermissionInput, opts ...request.Option) (*UpdateConnectionAliasPermissionOutput, error) { + req, out := c.UpdateConnectionAliasPermissionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateRulesOfIpGroup = "UpdateRulesOfIpGroup" + +// UpdateRulesOfIpGroupRequest generates a "aws/request.Request" representing the +// client's request for the UpdateRulesOfIpGroup 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 UpdateRulesOfIpGroup for more information on using the UpdateRulesOfIpGroup +// 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 UpdateRulesOfIpGroupRequest method. +// req, resp := client.UpdateRulesOfIpGroupRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateRulesOfIpGroup +func (c *WorkSpaces) UpdateRulesOfIpGroupRequest(input *UpdateRulesOfIpGroupInput) (req *request.Request, output *UpdateRulesOfIpGroupOutput) { + op := &request.Operation{ + Name: opUpdateRulesOfIpGroup, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateRulesOfIpGroupInput{} + } + + output = &UpdateRulesOfIpGroupOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateRulesOfIpGroup API operation for Amazon WorkSpaces. +// +// Replaces the current rules of the specified IP access control group with +// the specified rules. +// +// 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 Amazon WorkSpaces's +// API operation UpdateRulesOfIpGroup for usage and error information. +// +// Returned Error Types: +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - ResourceNotFoundException +// The resource could not be found. +// +// - ResourceLimitExceededException +// Your resource limits have been exceeded. +// +// - InvalidResourceStateException +// The state of the resource is not valid for this operation. +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateRulesOfIpGroup +func (c *WorkSpaces) UpdateRulesOfIpGroup(input *UpdateRulesOfIpGroupInput) (*UpdateRulesOfIpGroupOutput, error) { + req, out := c.UpdateRulesOfIpGroupRequest(input) + return out, req.Send() +} + +// UpdateRulesOfIpGroupWithContext is the same as UpdateRulesOfIpGroup with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateRulesOfIpGroup 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 *WorkSpaces) UpdateRulesOfIpGroupWithContext(ctx aws.Context, input *UpdateRulesOfIpGroupInput, opts ...request.Option) (*UpdateRulesOfIpGroupOutput, error) { + req, out := c.UpdateRulesOfIpGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateWorkspaceBundle = "UpdateWorkspaceBundle" + +// UpdateWorkspaceBundleRequest generates a "aws/request.Request" representing the +// client's request for the UpdateWorkspaceBundle 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 UpdateWorkspaceBundle for more information on using the UpdateWorkspaceBundle +// 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 UpdateWorkspaceBundleRequest method. +// req, resp := client.UpdateWorkspaceBundleRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceBundle +func (c *WorkSpaces) UpdateWorkspaceBundleRequest(input *UpdateWorkspaceBundleInput) (req *request.Request, output *UpdateWorkspaceBundleOutput) { + op := &request.Operation{ + Name: opUpdateWorkspaceBundle, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateWorkspaceBundleInput{} + } + + output = &UpdateWorkspaceBundleOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateWorkspaceBundle API operation for Amazon WorkSpaces. +// +// Updates a WorkSpace bundle with a new image. For more information about updating +// WorkSpace bundles, see Update a Custom WorkSpaces Bundle (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html). +// +// Existing WorkSpaces aren't automatically updated when you update the bundle +// that they're based on. To update existing WorkSpaces that are based on a +// bundle that you've updated, you must either rebuild the WorkSpaces or delete +// and recreate them. +// +// 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 Amazon WorkSpaces's +// API operation UpdateWorkspaceBundle for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - ResourceNotFoundException +// The resource could not be found. +// +// - ResourceUnavailableException +// The specified resource is not available. +// +// - OperationNotSupportedException +// This operation is not supported. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceBundle +func (c *WorkSpaces) UpdateWorkspaceBundle(input *UpdateWorkspaceBundleInput) (*UpdateWorkspaceBundleOutput, error) { + req, out := c.UpdateWorkspaceBundleRequest(input) + return out, req.Send() +} + +// UpdateWorkspaceBundleWithContext is the same as UpdateWorkspaceBundle with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateWorkspaceBundle 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 *WorkSpaces) UpdateWorkspaceBundleWithContext(ctx aws.Context, input *UpdateWorkspaceBundleInput, opts ...request.Option) (*UpdateWorkspaceBundleOutput, error) { + req, out := c.UpdateWorkspaceBundleRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateWorkspaceImagePermission = "UpdateWorkspaceImagePermission" + +// UpdateWorkspaceImagePermissionRequest generates a "aws/request.Request" representing the +// client's request for the UpdateWorkspaceImagePermission 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 UpdateWorkspaceImagePermission for more information on using the UpdateWorkspaceImagePermission +// 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 UpdateWorkspaceImagePermissionRequest method. +// req, resp := client.UpdateWorkspaceImagePermissionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceImagePermission +func (c *WorkSpaces) UpdateWorkspaceImagePermissionRequest(input *UpdateWorkspaceImagePermissionInput) (req *request.Request, output *UpdateWorkspaceImagePermissionOutput) { + op := &request.Operation{ + Name: opUpdateWorkspaceImagePermission, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateWorkspaceImagePermissionInput{} + } + + output = &UpdateWorkspaceImagePermissionOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateWorkspaceImagePermission API operation for Amazon WorkSpaces. +// +// Shares or unshares an image with one account in the same Amazon Web Services +// Region by specifying whether that account has permission to copy the image. +// If the copy image permission is granted, the image is shared with that account. +// If the copy image permission is revoked, the image is unshared with the account. +// +// After an image has been shared, the recipient account can copy the image +// to other Regions as needed. +// +// In the China (Ningxia) Region, you can copy images only within the same Region. +// +// In Amazon Web Services GovCloud (US), to copy images to and from other Regions, +// contact Amazon Web Services Support. +// +// For more information about sharing images, see Share or Unshare a Custom +// WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html). +// +// - To delete an image that has been shared, you must unshare the image +// before you delete it. +// +// - Sharing Bring Your Own License (BYOL) images across Amazon Web Services +// accounts isn't supported at this time in Amazon Web Services GovCloud +// (US). To share BYOL images across accounts in Amazon Web Services GovCloud +// (US), contact Amazon Web Services Support. +// +// 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 Amazon WorkSpaces's +// API operation UpdateWorkspaceImagePermission for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The resource could not be found. +// +// - ResourceUnavailableException +// The specified resource is not available. +// +// - AccessDeniedException +// The user is not authorized to access a resource. +// +// - InvalidParameterValuesException +// One or more parameter values are not valid. +// +// - OperationNotSupportedException +// This operation is not supported. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceImagePermission +func (c *WorkSpaces) UpdateWorkspaceImagePermission(input *UpdateWorkspaceImagePermissionInput) (*UpdateWorkspaceImagePermissionOutput, error) { + req, out := c.UpdateWorkspaceImagePermissionRequest(input) + return out, req.Send() +} + +// UpdateWorkspaceImagePermissionWithContext is the same as UpdateWorkspaceImagePermission with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateWorkspaceImagePermission 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 *WorkSpaces) UpdateWorkspaceImagePermissionWithContext(ctx aws.Context, input *UpdateWorkspaceImagePermissionInput, opts ...request.Option) (*UpdateWorkspaceImagePermissionOutput, error) { + req, out := c.UpdateWorkspaceImagePermissionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// The user is not authorized to access a resource. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" 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 AccessDeniedException) 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 AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Describes a modification to the configuration of Bring Your Own License (BYOL) +// for the specified account. +type AccountModification struct { + _ struct{} `type:"structure"` + + // The IP address range, specified as an IPv4 CIDR block, for the management + // network interface used for the account. + DedicatedTenancyManagementCidrRange *string `type:"string"` + + // The status of BYOL (whether BYOL is being enabled or disabled). + DedicatedTenancySupport *string `type:"string" enum:"DedicatedTenancySupportResultEnum"` + + // The error code that is returned if the configuration of BYOL cannot be modified. + ErrorCode *string `type:"string"` + + // The text of the error message that is returned if the configuration of BYOL + // cannot be modified. + ErrorMessage *string `type:"string"` + + // The state of the modification to the configuration of BYOL. + ModificationState *string `type:"string" enum:"DedicatedTenancyModificationStateEnum"` + + // The timestamp when the modification of the BYOL configuration was started. + StartTime *time.Time `type:"timestamp"` +} + +// 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 AccountModification) 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 AccountModification) GoString() string { + return s.String() +} + +// SetDedicatedTenancyManagementCidrRange sets the DedicatedTenancyManagementCidrRange field's value. +func (s *AccountModification) SetDedicatedTenancyManagementCidrRange(v string) *AccountModification { + s.DedicatedTenancyManagementCidrRange = &v + return s +} + +// SetDedicatedTenancySupport sets the DedicatedTenancySupport field's value. +func (s *AccountModification) SetDedicatedTenancySupport(v string) *AccountModification { + s.DedicatedTenancySupport = &v + return s +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *AccountModification) SetErrorCode(v string) *AccountModification { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *AccountModification) SetErrorMessage(v string) *AccountModification { + s.ErrorMessage = &v + return s +} + +// SetModificationState sets the ModificationState field's value. +func (s *AccountModification) SetModificationState(v string) *AccountModification { + s.ModificationState = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *AccountModification) SetStartTime(v time.Time) *AccountModification { + s.StartTime = &v + return s +} + +// The specified application is not supported. +type ApplicationNotSupportedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" 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 ApplicationNotSupportedException) 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 ApplicationNotSupportedException) GoString() string { + return s.String() +} + +func newErrorApplicationNotSupportedException(v protocol.ResponseMetadata) error { + return &ApplicationNotSupportedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ApplicationNotSupportedException) Code() string { + return "ApplicationNotSupportedException" +} + +// Message returns the exception's message. +func (s *ApplicationNotSupportedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ApplicationNotSupportedException) OrigErr() error { + return nil +} + +func (s *ApplicationNotSupportedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ApplicationNotSupportedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ApplicationNotSupportedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Describes the association between an application and an application resource. +type ApplicationResourceAssociation struct { + _ struct{} `type:"structure"` + + // The identifier of the application. + ApplicationId *string `type:"string"` + + // The identifier of the associated resource. + AssociatedResourceId *string `min:"1" type:"string"` + + // The resource type of the associated resource. + AssociatedResourceType *string `type:"string" enum:"ApplicationAssociatedResourceType"` + + // The time the association was created. + Created *time.Time `type:"timestamp"` + + // The time the association status was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The status of the application resource association. + State *string `type:"string" enum:"AssociationState"` + + // The reason the association deployment failed. + StateReason *AssociationStateReason `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 ApplicationResourceAssociation) 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 ApplicationResourceAssociation) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *ApplicationResourceAssociation) SetApplicationId(v string) *ApplicationResourceAssociation { + s.ApplicationId = &v + return s +} + +// SetAssociatedResourceId sets the AssociatedResourceId field's value. +func (s *ApplicationResourceAssociation) SetAssociatedResourceId(v string) *ApplicationResourceAssociation { + s.AssociatedResourceId = &v + return s +} + +// SetAssociatedResourceType sets the AssociatedResourceType field's value. +func (s *ApplicationResourceAssociation) SetAssociatedResourceType(v string) *ApplicationResourceAssociation { + s.AssociatedResourceType = &v + return s +} + +// SetCreated sets the Created field's value. +func (s *ApplicationResourceAssociation) SetCreated(v time.Time) *ApplicationResourceAssociation { + s.Created = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *ApplicationResourceAssociation) SetLastUpdatedTime(v time.Time) *ApplicationResourceAssociation { + s.LastUpdatedTime = &v + return s +} + +// SetState sets the State field's value. +func (s *ApplicationResourceAssociation) SetState(v string) *ApplicationResourceAssociation { + s.State = &v + return s +} + +// SetStateReason sets the StateReason field's value. +func (s *ApplicationResourceAssociation) SetStateReason(v *AssociationStateReason) *ApplicationResourceAssociation { + s.StateReason = v + return s +} + +type AssociateConnectionAliasInput struct { + _ struct{} `type:"structure"` + + // The identifier of the connection alias. + // + // AliasId is a required field + AliasId *string `min:"13" type:"string" required:"true"` + + // The identifier of the directory to associate the connection alias with. + // + // ResourceId is a required field + ResourceId *string `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 AssociateConnectionAliasInput) 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 AssociateConnectionAliasInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssociateConnectionAliasInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssociateConnectionAliasInput"} + if s.AliasId == nil { + invalidParams.Add(request.NewErrParamRequired("AliasId")) + } + if s.AliasId != nil && len(*s.AliasId) < 13 { + invalidParams.Add(request.NewErrParamMinLen("AliasId", 13)) + } + if s.ResourceId == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceId")) + } + if s.ResourceId != nil && len(*s.ResourceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAliasId sets the AliasId field's value. +func (s *AssociateConnectionAliasInput) SetAliasId(v string) *AssociateConnectionAliasInput { + s.AliasId = &v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *AssociateConnectionAliasInput) SetResourceId(v string) *AssociateConnectionAliasInput { + s.ResourceId = &v + return s +} + +type AssociateConnectionAliasOutput struct { + _ struct{} `type:"structure"` + + // The identifier of the connection alias association. You use the connection + // identifier in the DNS TXT record when you're configuring your DNS routing + // policies. + ConnectionIdentifier *string `min:"1" 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 AssociateConnectionAliasOutput) 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 AssociateConnectionAliasOutput) GoString() string { + return s.String() +} + +// SetConnectionIdentifier sets the ConnectionIdentifier field's value. +func (s *AssociateConnectionAliasOutput) SetConnectionIdentifier(v string) *AssociateConnectionAliasOutput { + s.ConnectionIdentifier = &v + return s +} + +type AssociateIpGroupsInput struct { + _ struct{} `type:"structure"` + + // The identifier of the directory. + // + // DirectoryId is a required field + DirectoryId *string `min:"10" type:"string" required:"true"` + + // The identifiers of one or more IP access control groups. + // + // GroupIds is a required field + GroupIds []*string `type:"list" 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 AssociateIpGroupsInput) 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 AssociateIpGroupsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssociateIpGroupsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssociateIpGroupsInput"} + if s.DirectoryId == nil { + invalidParams.Add(request.NewErrParamRequired("DirectoryId")) + } + if s.DirectoryId != nil && len(*s.DirectoryId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("DirectoryId", 10)) + } + if s.GroupIds == nil { + invalidParams.Add(request.NewErrParamRequired("GroupIds")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDirectoryId sets the DirectoryId field's value. +func (s *AssociateIpGroupsInput) SetDirectoryId(v string) *AssociateIpGroupsInput { + s.DirectoryId = &v + return s +} + +// SetGroupIds sets the GroupIds field's value. +func (s *AssociateIpGroupsInput) SetGroupIds(v []*string) *AssociateIpGroupsInput { + s.GroupIds = v + return s +} + +type AssociateIpGroupsOutput struct { + _ struct{} `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 AssociateIpGroupsOutput) 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 AssociateIpGroupsOutput) GoString() string { + return s.String() +} + +type AssociateWorkspaceApplicationInput struct { + _ struct{} `type:"structure"` + + // The identifier of the application. + // + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` + + // The identifier of the WorkSpace. + // + // WorkspaceId is a required field + WorkspaceId *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 AssociateWorkspaceApplicationInput) 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 AssociateWorkspaceApplicationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssociateWorkspaceApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssociateWorkspaceApplicationInput"} + if s.ApplicationId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationId")) + } + if s.WorkspaceId == nil { + invalidParams.Add(request.NewErrParamRequired("WorkspaceId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *AssociateWorkspaceApplicationInput) SetApplicationId(v string) *AssociateWorkspaceApplicationInput { + s.ApplicationId = &v + return s +} + +// SetWorkspaceId sets the WorkspaceId field's value. +func (s *AssociateWorkspaceApplicationInput) SetWorkspaceId(v string) *AssociateWorkspaceApplicationInput { + s.WorkspaceId = &v + return s +} + +type AssociateWorkspaceApplicationOutput struct { + _ struct{} `type:"structure"` + + // Information about the association between the specified WorkSpace and the + // specified application. + Association *WorkspaceResourceAssociation `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 AssociateWorkspaceApplicationOutput) 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 AssociateWorkspaceApplicationOutput) GoString() string { + return s.String() +} + +// SetAssociation sets the Association field's value. +func (s *AssociateWorkspaceApplicationOutput) SetAssociation(v *WorkspaceResourceAssociation) *AssociateWorkspaceApplicationOutput { + s.Association = v + return s +} + +// Indicates the reason that the association deployment failed, including the +// error code and error message. +type AssociationStateReason struct { + _ struct{} `type:"structure"` + + // The error code of the association deployment failure. + ErrorCode *string `type:"string" enum:"AssociationErrorCode"` + + // The error message of the association deployment failure. + ErrorMessage *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 AssociationStateReason) 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 AssociationStateReason) GoString() string { + return s.String() +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *AssociationStateReason) SetErrorCode(v string) *AssociationStateReason { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *AssociationStateReason) SetErrorMessage(v string) *AssociationStateReason { + s.ErrorMessage = &v + return s +} + +type AuthorizeIpRulesInput struct { + _ struct{} `type:"structure"` + + // The identifier of the group. + // + // GroupId is a required field + GroupId *string `type:"string" required:"true"` + + // The rules to add to the group. + // + // UserRules is a required field + UserRules []*IpRuleItem `type:"list" 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 AuthorizeIpRulesInput) 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 AuthorizeIpRulesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AuthorizeIpRulesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AuthorizeIpRulesInput"} + if s.GroupId == nil { + invalidParams.Add(request.NewErrParamRequired("GroupId")) + } + if s.UserRules == nil { + invalidParams.Add(request.NewErrParamRequired("UserRules")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetGroupId sets the GroupId field's value. +func (s *AuthorizeIpRulesInput) SetGroupId(v string) *AuthorizeIpRulesInput { + s.GroupId = &v + return s +} + +// SetUserRules sets the UserRules field's value. +func (s *AuthorizeIpRulesInput) SetUserRules(v []*IpRuleItem) *AuthorizeIpRulesInput { + s.UserRules = v + return s +} + +type AuthorizeIpRulesOutput struct { + _ struct{} `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 AuthorizeIpRulesOutput) 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 AuthorizeIpRulesOutput) GoString() string { + return s.String() +} + +// Describes the association between an application and a bundle resource. +type BundleResourceAssociation struct { + _ struct{} `type:"structure"` + + // The identifier of the associated resource. + AssociatedResourceId *string `min:"1" type:"string"` + + // The resource type of the associated resources. + AssociatedResourceType *string `type:"string" enum:"BundleAssociatedResourceType"` + + // The identifier of the bundle. + BundleId *string `type:"string"` + + // The time the association is created. + Created *time.Time `type:"timestamp"` + + // The time the association status was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The status of the bundle resource association. + State *string `type:"string" enum:"AssociationState"` + + // The reason the association deployment failed. + StateReason *AssociationStateReason `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 BundleResourceAssociation) 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 BundleResourceAssociation) GoString() string { + return s.String() +} + +// SetAssociatedResourceId sets the AssociatedResourceId field's value. +func (s *BundleResourceAssociation) SetAssociatedResourceId(v string) *BundleResourceAssociation { + s.AssociatedResourceId = &v + return s +} + +// SetAssociatedResourceType sets the AssociatedResourceType field's value. +func (s *BundleResourceAssociation) SetAssociatedResourceType(v string) *BundleResourceAssociation { + s.AssociatedResourceType = &v + return s +} + +// SetBundleId sets the BundleId field's value. +func (s *BundleResourceAssociation) SetBundleId(v string) *BundleResourceAssociation { + s.BundleId = &v + return s +} + +// SetCreated sets the Created field's value. +func (s *BundleResourceAssociation) SetCreated(v time.Time) *BundleResourceAssociation { + s.Created = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *BundleResourceAssociation) SetLastUpdatedTime(v time.Time) *BundleResourceAssociation { + s.LastUpdatedTime = &v + return s +} + +// SetState sets the State field's value. +func (s *BundleResourceAssociation) SetState(v string) *BundleResourceAssociation { + s.State = &v + return s +} + +// SetStateReason sets the StateReason field's value. +func (s *BundleResourceAssociation) SetStateReason(v *AssociationStateReason) *BundleResourceAssociation { + s.StateReason = v + return s +} + +// Describes the properties of the certificate-based authentication you want +// to use with your WorkSpaces. +type CertificateBasedAuthProperties struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager + // Private CA resource. + CertificateAuthorityArn *string `min:"5" type:"string"` + + // The status of the certificate-based authentication properties. + Status *string `type:"string" enum:"CertificateBasedAuthStatusEnum"` +} + +// 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 CertificateBasedAuthProperties) 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 CertificateBasedAuthProperties) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CertificateBasedAuthProperties) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CertificateBasedAuthProperties"} + if s.CertificateAuthorityArn != nil && len(*s.CertificateAuthorityArn) < 5 { + invalidParams.Add(request.NewErrParamMinLen("CertificateAuthorityArn", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value. +func (s *CertificateBasedAuthProperties) SetCertificateAuthorityArn(v string) *CertificateBasedAuthProperties { + s.CertificateAuthorityArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CertificateBasedAuthProperties) SetStatus(v string) *CertificateBasedAuthProperties { + s.Status = &v + return s +} + +// Describes an Amazon WorkSpaces client. +type ClientProperties struct { + _ struct{} `type:"structure"` + + // Specifies whether users can upload diagnostic log files of Amazon WorkSpaces + // client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces + // client. When enabled, the log files will be sent to WorkSpaces automatically + // and will be applied to all users in the specified directory. + LogUploadEnabled *string `type:"string" enum:"LogUploadEnum"` + + // Specifies whether users can cache their credentials on the Amazon WorkSpaces + // client. When enabled, users can choose to reconnect to their WorkSpaces without + // re-entering their credentials. + ReconnectEnabled *string `type:"string" enum:"ReconnectEnum"` +} + +// String returns the string representation. // -// - OperationNotSupportedException -// This operation is not supported. +// 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 ClientProperties) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceImagePermission -func (c *WorkSpaces) UpdateWorkspaceImagePermission(input *UpdateWorkspaceImagePermissionInput) (*UpdateWorkspaceImagePermissionOutput, error) { - req, out := c.UpdateWorkspaceImagePermissionRequest(input) - return out, req.Send() +// 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 ClientProperties) GoString() string { + return s.String() } -// UpdateWorkspaceImagePermissionWithContext is the same as UpdateWorkspaceImagePermission with the addition of -// the ability to pass a context and additional request options. +// SetLogUploadEnabled sets the LogUploadEnabled field's value. +func (s *ClientProperties) SetLogUploadEnabled(v string) *ClientProperties { + s.LogUploadEnabled = &v + return s +} + +// SetReconnectEnabled sets the ReconnectEnabled field's value. +func (s *ClientProperties) SetReconnectEnabled(v string) *ClientProperties { + s.ReconnectEnabled = &v + return s +} + +// Information about the Amazon WorkSpaces client. +type ClientPropertiesResult struct { + _ struct{} `type:"structure"` + + // Information about the Amazon WorkSpaces client. + ClientProperties *ClientProperties `type:"structure"` + + // The resource identifier, in the form of a directory ID. + ResourceId *string `min:"1" type:"string"` +} + +// String returns the string representation. // -// See UpdateWorkspaceImagePermission for details on how to use this API operation. +// 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 ClientPropertiesResult) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. // -// 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 *WorkSpaces) UpdateWorkspaceImagePermissionWithContext(ctx aws.Context, input *UpdateWorkspaceImagePermissionInput, opts ...request.Option) (*UpdateWorkspaceImagePermissionOutput, error) { - req, out := c.UpdateWorkspaceImagePermissionRequest(input) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return out, req.Send() +// 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 ClientPropertiesResult) GoString() string { + return s.String() } -// The user is not authorized to access a resource. -type AccessDeniedException struct { +// SetClientProperties sets the ClientProperties field's value. +func (s *ClientPropertiesResult) SetClientProperties(v *ClientProperties) *ClientPropertiesResult { + s.ClientProperties = v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *ClientPropertiesResult) SetResourceId(v string) *ClientPropertiesResult { + s.ResourceId = &v + return s +} + +// The compute type of the WorkSpace is not compatible with the application. +type ComputeNotCompatibleException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6164,7 +7934,7 @@ type AccessDeniedException struct { // 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 AccessDeniedException) String() string { +func (s ComputeNotCompatibleException) String() string { return awsutil.Prettify(s) } @@ -6173,23 +7943,23 @@ func (s AccessDeniedException) String() string { // 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 AccessDeniedException) GoString() string { +func (s ComputeNotCompatibleException) GoString() string { return s.String() } -func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { - return &AccessDeniedException{ +func newErrorComputeNotCompatibleException(v protocol.ResponseMetadata) error { + return &ComputeNotCompatibleException{ RespMetadata: v, } } // Code returns the exception type name. -func (s *AccessDeniedException) Code() string { - return "AccessDeniedException" +func (s *ComputeNotCompatibleException) Code() string { + return "ComputeNotCompatibleException" } // Message returns the exception's message. -func (s *AccessDeniedException) Message() string { +func (s *ComputeNotCompatibleException) Message() string { if s.Message_ != nil { return *s.Message_ } @@ -6197,48 +7967,30 @@ func (s *AccessDeniedException) Message() string { } // OrigErr always returns nil, satisfies awserr.Error interface. -func (s *AccessDeniedException) OrigErr() error { +func (s *ComputeNotCompatibleException) OrigErr() error { return nil } -func (s *AccessDeniedException) Error() string { +func (s *ComputeNotCompatibleException) Error() string { return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } // Status code returns the HTTP status code for the request's response error. -func (s *AccessDeniedException) StatusCode() int { +func (s *ComputeNotCompatibleException) StatusCode() int { return s.RespMetadata.StatusCode } // RequestID returns the service's response RequestID for request. -func (s *AccessDeniedException) RequestID() string { +func (s *ComputeNotCompatibleException) RequestID() string { return s.RespMetadata.RequestID } -// Describes a modification to the configuration of Bring Your Own License (BYOL) -// for the specified account. -type AccountModification struct { +// Describes the compute type of the bundle. +type ComputeType struct { _ struct{} `type:"structure"` - // The IP address range, specified as an IPv4 CIDR block, for the management - // network interface used for the account. - DedicatedTenancyManagementCidrRange *string `type:"string"` - - // The status of BYOL (whether BYOL is being enabled or disabled). - DedicatedTenancySupport *string `type:"string" enum:"DedicatedTenancySupportResultEnum"` - - // The error code that is returned if the configuration of BYOL cannot be modified. - ErrorCode *string `type:"string"` - - // The text of the error message that is returned if the configuration of BYOL - // cannot be modified. - ErrorMessage *string `type:"string"` - - // The state of the modification to the configuration of BYOL. - ModificationState *string `type:"string" enum:"DedicatedTenancyModificationStateEnum"` - - // The timestamp when the modification of the BYOL configuration was started. - StartTime *time.Time `type:"timestamp"` + // The compute type. + Name *string `type:"string" enum:"Compute"` } // String returns the string representation. @@ -6246,7 +7998,7 @@ type AccountModification struct { // 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 AccountModification) String() string { +func (s ComputeType) String() string { return awsutil.Prettify(s) } @@ -6255,58 +8007,31 @@ func (s AccountModification) String() string { // 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 AccountModification) GoString() string { +func (s ComputeType) GoString() string { return s.String() } -// SetDedicatedTenancyManagementCidrRange sets the DedicatedTenancyManagementCidrRange field's value. -func (s *AccountModification) SetDedicatedTenancyManagementCidrRange(v string) *AccountModification { - s.DedicatedTenancyManagementCidrRange = &v - return s -} - -// SetDedicatedTenancySupport sets the DedicatedTenancySupport field's value. -func (s *AccountModification) SetDedicatedTenancySupport(v string) *AccountModification { - s.DedicatedTenancySupport = &v - return s -} - -// SetErrorCode sets the ErrorCode field's value. -func (s *AccountModification) SetErrorCode(v string) *AccountModification { - s.ErrorCode = &v - return s -} - -// SetErrorMessage sets the ErrorMessage field's value. -func (s *AccountModification) SetErrorMessage(v string) *AccountModification { - s.ErrorMessage = &v +// SetName sets the Name field's value. +func (s *ComputeType) SetName(v string) *ComputeType { + s.Name = &v return s } -// SetModificationState sets the ModificationState field's value. -func (s *AccountModification) SetModificationState(v string) *AccountModification { - s.ModificationState = &v - return s -} +// Describes an Amazon Connect client add-in. +type ConnectClientAddIn struct { + _ struct{} `type:"structure"` -// SetStartTime sets the StartTime field's value. -func (s *AccountModification) SetStartTime(v time.Time) *AccountModification { - s.StartTime = &v - return s -} + // The client add-in identifier. + AddInId *string `min:"36" type:"string"` -type AssociateConnectionAliasInput struct { - _ struct{} `type:"structure"` + // The name of the client add in. + Name *string `min:"1" type:"string"` - // The identifier of the connection alias. - // - // AliasId is a required field - AliasId *string `min:"13" type:"string" required:"true"` + // The directory identifier for which the client add-in is configured. + ResourceId *string `min:"10" type:"string"` - // The identifier of the directory to associate the connection alias with. - // - // ResourceId is a required field - ResourceId *string `min:"1" type:"string" required:"true"` + // The endpoint URL of the client add-in. + URL *string `min:"1" type:"string"` } // String returns the string representation. @@ -6314,7 +8039,7 @@ type AssociateConnectionAliasInput struct { // 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 AssociateConnectionAliasInput) String() string { +func (s ConnectClientAddIn) String() string { return awsutil.Prettify(s) } @@ -6323,89 +8048,57 @@ func (s AssociateConnectionAliasInput) String() string { // 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 AssociateConnectionAliasInput) GoString() string { +func (s ConnectClientAddIn) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *AssociateConnectionAliasInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AssociateConnectionAliasInput"} - if s.AliasId == nil { - invalidParams.Add(request.NewErrParamRequired("AliasId")) - } - if s.AliasId != nil && len(*s.AliasId) < 13 { - invalidParams.Add(request.NewErrParamMinLen("AliasId", 13)) - } - if s.ResourceId == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceId")) - } - if s.ResourceId != nil && len(*s.ResourceId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetAliasId sets the AliasId field's value. -func (s *AssociateConnectionAliasInput) SetAliasId(v string) *AssociateConnectionAliasInput { - s.AliasId = &v - return s -} - -// SetResourceId sets the ResourceId field's value. -func (s *AssociateConnectionAliasInput) SetResourceId(v string) *AssociateConnectionAliasInput { - s.ResourceId = &v +// SetAddInId sets the AddInId field's value. +func (s *ConnectClientAddIn) SetAddInId(v string) *ConnectClientAddIn { + s.AddInId = &v return s } -type AssociateConnectionAliasOutput struct { - _ struct{} `type:"structure"` - - // The identifier of the connection alias association. You use the connection - // identifier in the DNS TXT record when you're configuring your DNS routing - // policies. - ConnectionIdentifier *string `min:"1" 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 AssociateConnectionAliasOutput) String() string { - return awsutil.Prettify(s) +// SetName sets the Name field's value. +func (s *ConnectClientAddIn) SetName(v string) *ConnectClientAddIn { + s.Name = &v + return 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 AssociateConnectionAliasOutput) GoString() string { - return s.String() +// SetResourceId sets the ResourceId field's value. +func (s *ConnectClientAddIn) SetResourceId(v string) *ConnectClientAddIn { + s.ResourceId = &v + return s } -// SetConnectionIdentifier sets the ConnectionIdentifier field's value. -func (s *AssociateConnectionAliasOutput) SetConnectionIdentifier(v string) *AssociateConnectionAliasOutput { - s.ConnectionIdentifier = &v +// SetURL sets the URL field's value. +func (s *ConnectClientAddIn) SetURL(v string) *ConnectClientAddIn { + s.URL = &v return s } -type AssociateIpGroupsInput struct { +// Describes a connection alias. Connection aliases are used for cross-Region +// redirection. For more information, see Cross-Region Redirection for Amazon +// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +type ConnectionAlias struct { _ struct{} `type:"structure"` - // The identifier of the directory. - // - // DirectoryId is a required field - DirectoryId *string `min:"10" type:"string" required:"true"` + // The identifier of the connection alias. + AliasId *string `min:"13" type:"string"` - // The identifiers of one or more IP access control groups. - // - // GroupIds is a required field - GroupIds []*string `type:"list" required:"true"` + // The association status of the connection alias. + Associations []*ConnectionAliasAssociation `min:"1" type:"list"` + + // The connection string specified for the connection alias. The connection + // string must be in the form of a fully qualified domain name (FQDN), such + // as www.example.com. + ConnectionString *string `min:"1" type:"string"` + + // The identifier of the Amazon Web Services account that owns the connection + // alias. + OwnerAccountId *string `type:"string"` + + // The current state of the connection alias. + State *string `type:"string" enum:"ConnectionAliasState"` } // String returns the string representation. @@ -6413,7 +8106,7 @@ type AssociateIpGroupsInput struct { // 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 AssociateIpGroupsInput) String() string { +func (s ConnectionAlias) String() string { return awsutil.Prettify(s) } @@ -6422,43 +8115,60 @@ func (s AssociateIpGroupsInput) String() string { // 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 AssociateIpGroupsInput) GoString() string { +func (s ConnectionAlias) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *AssociateIpGroupsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AssociateIpGroupsInput"} - if s.DirectoryId == nil { - invalidParams.Add(request.NewErrParamRequired("DirectoryId")) - } - if s.DirectoryId != nil && len(*s.DirectoryId) < 10 { - invalidParams.Add(request.NewErrParamMinLen("DirectoryId", 10)) - } - if s.GroupIds == nil { - invalidParams.Add(request.NewErrParamRequired("GroupIds")) - } +// SetAliasId sets the AliasId field's value. +func (s *ConnectionAlias) SetAliasId(v string) *ConnectionAlias { + s.AliasId = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetAssociations sets the Associations field's value. +func (s *ConnectionAlias) SetAssociations(v []*ConnectionAliasAssociation) *ConnectionAlias { + s.Associations = v + return s } -// SetDirectoryId sets the DirectoryId field's value. -func (s *AssociateIpGroupsInput) SetDirectoryId(v string) *AssociateIpGroupsInput { - s.DirectoryId = &v +// SetConnectionString sets the ConnectionString field's value. +func (s *ConnectionAlias) SetConnectionString(v string) *ConnectionAlias { + s.ConnectionString = &v return s } -// SetGroupIds sets the GroupIds field's value. -func (s *AssociateIpGroupsInput) SetGroupIds(v []*string) *AssociateIpGroupsInput { - s.GroupIds = v +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *ConnectionAlias) SetOwnerAccountId(v string) *ConnectionAlias { + s.OwnerAccountId = &v return s } -type AssociateIpGroupsOutput struct { +// SetState sets the State field's value. +func (s *ConnectionAlias) SetState(v string) *ConnectionAlias { + s.State = &v + return s +} + +// Describes a connection alias association that is used for cross-Region redirection. +// For more information, see Cross-Region Redirection for Amazon WorkSpaces +// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +type ConnectionAliasAssociation struct { _ struct{} `type:"structure"` + + // The identifier of the Amazon Web Services account that associated the connection + // alias with a directory. + AssociatedAccountId *string `type:"string"` + + // The association status of the connection alias. + AssociationStatus *string `type:"string" enum:"AssociationStatus"` + + // The identifier of the connection alias association. You use the connection + // identifier in the DNS TXT record when you're configuring your DNS routing + // policies. + ConnectionIdentifier *string `min:"1" type:"string"` + + // The identifier of the directory associated with a connection alias. + ResourceId *string `min:"1" type:"string"` } // String returns the string representation. @@ -6466,7 +8176,7 @@ type AssociateIpGroupsOutput struct { // 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 AssociateIpGroupsOutput) String() string { +func (s ConnectionAliasAssociation) String() string { return awsutil.Prettify(s) } @@ -6475,22 +8185,51 @@ func (s AssociateIpGroupsOutput) String() string { // 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 AssociateIpGroupsOutput) GoString() string { +func (s ConnectionAliasAssociation) GoString() string { return s.String() } -type AuthorizeIpRulesInput struct { +// SetAssociatedAccountId sets the AssociatedAccountId field's value. +func (s *ConnectionAliasAssociation) SetAssociatedAccountId(v string) *ConnectionAliasAssociation { + s.AssociatedAccountId = &v + return s +} + +// SetAssociationStatus sets the AssociationStatus field's value. +func (s *ConnectionAliasAssociation) SetAssociationStatus(v string) *ConnectionAliasAssociation { + s.AssociationStatus = &v + return s +} + +// SetConnectionIdentifier sets the ConnectionIdentifier field's value. +func (s *ConnectionAliasAssociation) SetConnectionIdentifier(v string) *ConnectionAliasAssociation { + s.ConnectionIdentifier = &v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *ConnectionAliasAssociation) SetResourceId(v string) *ConnectionAliasAssociation { + s.ResourceId = &v + return s +} + +// Describes the permissions for a connection alias. Connection aliases are +// used for cross-Region redirection. For more information, see Cross-Region +// Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +type ConnectionAliasPermission struct { _ struct{} `type:"structure"` - // The identifier of the group. + // Indicates whether the specified Amazon Web Services account is allowed to + // associate the connection alias with a directory. // - // GroupId is a required field - GroupId *string `type:"string" required:"true"` + // AllowAssociation is a required field + AllowAssociation *bool `type:"boolean" required:"true"` - // The rules to add to the group. + // The identifier of the Amazon Web Services account that the connection alias + // is shared with. // - // UserRules is a required field - UserRules []*IpRuleItem `type:"list" required:"true"` + // SharedAccountId is a required field + SharedAccountId *string `type:"string" required:"true"` } // String returns the string representation. @@ -6498,7 +8237,7 @@ type AuthorizeIpRulesInput struct { // 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 AuthorizeIpRulesInput) String() string { +func (s ConnectionAliasPermission) String() string { return awsutil.Prettify(s) } @@ -6507,18 +8246,18 @@ func (s AuthorizeIpRulesInput) String() string { // 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 AuthorizeIpRulesInput) GoString() string { +func (s ConnectionAliasPermission) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *AuthorizeIpRulesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AuthorizeIpRulesInput"} - if s.GroupId == nil { - invalidParams.Add(request.NewErrParamRequired("GroupId")) +func (s *ConnectionAliasPermission) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConnectionAliasPermission"} + if s.AllowAssociation == nil { + invalidParams.Add(request.NewErrParamRequired("AllowAssociation")) } - if s.UserRules == nil { - invalidParams.Add(request.NewErrParamRequired("UserRules")) + if s.SharedAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("SharedAccountId")) } if invalidParams.Len() > 0 { @@ -6527,51 +8266,41 @@ func (s *AuthorizeIpRulesInput) Validate() error { return nil } -// SetGroupId sets the GroupId field's value. -func (s *AuthorizeIpRulesInput) SetGroupId(v string) *AuthorizeIpRulesInput { - s.GroupId = &v +// SetAllowAssociation sets the AllowAssociation field's value. +func (s *ConnectionAliasPermission) SetAllowAssociation(v bool) *ConnectionAliasPermission { + s.AllowAssociation = &v return s } -// SetUserRules sets the UserRules field's value. -func (s *AuthorizeIpRulesInput) SetUserRules(v []*IpRuleItem) *AuthorizeIpRulesInput { - s.UserRules = v +// SetSharedAccountId sets the SharedAccountId field's value. +func (s *ConnectionAliasPermission) SetSharedAccountId(v string) *ConnectionAliasPermission { + s.SharedAccountId = &v return s } -type AuthorizeIpRulesOutput struct { +type CopyWorkspaceImageInput struct { _ struct{} `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 AuthorizeIpRulesOutput) String() string { - return awsutil.Prettify(s) -} + // A description of the image. + Description *string `min:"1" type:"string"` -// 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 AuthorizeIpRulesOutput) GoString() string { - return s.String() -} + // The name of the image. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` -// Describes the properties of the certificate-based authentication you want -// to use with your WorkSpaces. -type CertificateBasedAuthProperties struct { - _ struct{} `type:"structure"` + // The identifier of the source image. + // + // SourceImageId is a required field + SourceImageId *string `type:"string" required:"true"` - // The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager - // Private CA resource. - CertificateAuthorityArn *string `min:"5" type:"string"` + // The identifier of the source Region. + // + // SourceRegion is a required field + SourceRegion *string `min:"1" type:"string" required:"true"` - // The status of the certificate-based authentication properties. - Status *string `type:"string" enum:"CertificateBasedAuthStatusEnum"` + // The tags for the image. + Tags []*Tag `type:"list"` } // String returns the string representation. @@ -6579,7 +8308,7 @@ type CertificateBasedAuthProperties struct { // 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 CertificateBasedAuthProperties) String() string { +func (s CopyWorkspaceImageInput) String() string { return awsutil.Prettify(s) } @@ -6588,15 +8317,40 @@ func (s CertificateBasedAuthProperties) String() string { // 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 CertificateBasedAuthProperties) GoString() string { +func (s CopyWorkspaceImageInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CertificateBasedAuthProperties) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CertificateBasedAuthProperties"} - if s.CertificateAuthorityArn != nil && len(*s.CertificateAuthorityArn) < 5 { - invalidParams.Add(request.NewErrParamMinLen("CertificateAuthorityArn", 5)) +func (s *CopyWorkspaceImageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CopyWorkspaceImageInput"} + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.SourceImageId == nil { + invalidParams.Add(request.NewErrParamRequired("SourceImageId")) + } + if s.SourceRegion == nil { + invalidParams.Add(request.NewErrParamRequired("SourceRegion")) + } + if s.SourceRegion != nil && len(*s.SourceRegion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceRegion", 1)) + } + 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 { @@ -6605,32 +8359,41 @@ func (s *CertificateBasedAuthProperties) Validate() error { return nil } -// SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value. -func (s *CertificateBasedAuthProperties) SetCertificateAuthorityArn(v string) *CertificateBasedAuthProperties { - s.CertificateAuthorityArn = &v +// SetDescription sets the Description field's value. +func (s *CopyWorkspaceImageInput) SetDescription(v string) *CopyWorkspaceImageInput { + s.Description = &v return s } -// SetStatus sets the Status field's value. -func (s *CertificateBasedAuthProperties) SetStatus(v string) *CertificateBasedAuthProperties { - s.Status = &v +// SetName sets the Name field's value. +func (s *CopyWorkspaceImageInput) SetName(v string) *CopyWorkspaceImageInput { + s.Name = &v return s } -// Describes an Amazon WorkSpaces client. -type ClientProperties struct { - _ struct{} `type:"structure"` +// SetSourceImageId sets the SourceImageId field's value. +func (s *CopyWorkspaceImageInput) SetSourceImageId(v string) *CopyWorkspaceImageInput { + s.SourceImageId = &v + return s +} - // Specifies whether users can upload diagnostic log files of Amazon WorkSpaces - // client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces - // client. When enabled, the log files will be sent to WorkSpaces automatically - // and will be applied to all users in the specified directory. - LogUploadEnabled *string `type:"string" enum:"LogUploadEnum"` +// SetSourceRegion sets the SourceRegion field's value. +func (s *CopyWorkspaceImageInput) SetSourceRegion(v string) *CopyWorkspaceImageInput { + s.SourceRegion = &v + return s +} - // Specifies whether users can cache their credentials on the Amazon WorkSpaces - // client. When enabled, users can choose to reconnect to their WorkSpaces without - // re-entering their credentials. - ReconnectEnabled *string `type:"string" enum:"ReconnectEnum"` +// SetTags sets the Tags field's value. +func (s *CopyWorkspaceImageInput) SetTags(v []*Tag) *CopyWorkspaceImageInput { + s.Tags = v + return s +} + +type CopyWorkspaceImageOutput struct { + _ struct{} `type:"structure"` + + // The identifier of the image. + ImageId *string `type:"string"` } // String returns the string representation. @@ -6638,7 +8401,7 @@ type ClientProperties struct { // 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 ClientProperties) String() string { +func (s CopyWorkspaceImageOutput) String() string { return awsutil.Prettify(s) } @@ -6647,31 +8410,33 @@ func (s ClientProperties) String() string { // 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 ClientProperties) GoString() string { +func (s CopyWorkspaceImageOutput) GoString() string { return s.String() } -// SetLogUploadEnabled sets the LogUploadEnabled field's value. -func (s *ClientProperties) SetLogUploadEnabled(v string) *ClientProperties { - s.LogUploadEnabled = &v - return s -} - -// SetReconnectEnabled sets the ReconnectEnabled field's value. -func (s *ClientProperties) SetReconnectEnabled(v string) *ClientProperties { - s.ReconnectEnabled = &v +// SetImageId sets the ImageId field's value. +func (s *CopyWorkspaceImageOutput) SetImageId(v string) *CopyWorkspaceImageOutput { + s.ImageId = &v return s } -// Information about the Amazon WorkSpaces client. -type ClientPropertiesResult struct { +type CreateConnectClientAddInInput struct { _ struct{} `type:"structure"` - // Information about the Amazon WorkSpaces client. - ClientProperties *ClientProperties `type:"structure"` + // The name of the client add-in. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` - // The resource identifier, in the form of a directory ID. - ResourceId *string `min:"1" type:"string"` + // The directory identifier for which to configure the client add-in. + // + // ResourceId is a required field + ResourceId *string `min:"10" type:"string" required:"true"` + + // The endpoint URL of the Amazon Connect client add-in. + // + // URL is a required field + URL *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -6679,7 +8444,7 @@ type ClientPropertiesResult struct { // 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 ClientPropertiesResult) String() string { +func (s CreateConnectClientAddInInput) String() string { return awsutil.Prettify(s) } @@ -6688,28 +8453,61 @@ func (s ClientPropertiesResult) String() string { // 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 ClientPropertiesResult) GoString() string { +func (s CreateConnectClientAddInInput) GoString() string { return s.String() } -// SetClientProperties sets the ClientProperties field's value. -func (s *ClientPropertiesResult) SetClientProperties(v *ClientProperties) *ClientPropertiesResult { - s.ClientProperties = v +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateConnectClientAddInInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateConnectClientAddInInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ResourceId == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceId")) + } + if s.ResourceId != nil && len(*s.ResourceId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("ResourceId", 10)) + } + if s.URL == nil { + invalidParams.Add(request.NewErrParamRequired("URL")) + } + if s.URL != nil && len(*s.URL) < 1 { + invalidParams.Add(request.NewErrParamMinLen("URL", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *CreateConnectClientAddInInput) SetName(v string) *CreateConnectClientAddInInput { + s.Name = &v return s } // SetResourceId sets the ResourceId field's value. -func (s *ClientPropertiesResult) SetResourceId(v string) *ClientPropertiesResult { +func (s *CreateConnectClientAddInInput) SetResourceId(v string) *CreateConnectClientAddInInput { s.ResourceId = &v return s } -// Describes the compute type of the bundle. -type ComputeType struct { +// SetURL sets the URL field's value. +func (s *CreateConnectClientAddInInput) SetURL(v string) *CreateConnectClientAddInInput { + s.URL = &v + return s +} + +type CreateConnectClientAddInOutput struct { _ struct{} `type:"structure"` - // The compute type. - Name *string `type:"string" enum:"Compute"` + // The client add-in identifier. + AddInId *string `min:"36" type:"string"` } // String returns the string representation. @@ -6717,7 +8515,7 @@ type ComputeType struct { // 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 ComputeType) String() string { +func (s CreateConnectClientAddInOutput) String() string { return awsutil.Prettify(s) } @@ -6726,31 +8524,32 @@ func (s ComputeType) String() string { // 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 ComputeType) GoString() string { +func (s CreateConnectClientAddInOutput) GoString() string { return s.String() } -// SetName sets the Name field's value. -func (s *ComputeType) SetName(v string) *ComputeType { - s.Name = &v +// SetAddInId sets the AddInId field's value. +func (s *CreateConnectClientAddInOutput) SetAddInId(v string) *CreateConnectClientAddInOutput { + s.AddInId = &v return s } -// Describes an Amazon Connect client add-in. -type ConnectClientAddIn struct { +type CreateConnectionAliasInput struct { _ struct{} `type:"structure"` - // The client add-in identifier. - AddInId *string `min:"36" type:"string"` - - // The name of the client add in. - Name *string `min:"1" type:"string"` - - // The directory identifier for which the client add-in is configured. - ResourceId *string `min:"10" type:"string"` + // A connection string in the form of a fully qualified domain name (FQDN), + // such as www.example.com. + // + // After you create a connection string, it is always associated to your Amazon + // Web Services account. You cannot recreate the same connection string with + // a different account, even if you delete all instances of it from the original + // account. The connection string is globally reserved for your account. + // + // ConnectionString is a required field + ConnectionString *string `min:"1" type:"string" required:"true"` - // The endpoint URL of the client add-in. - URL *string `min:"1" type:"string"` + // The tags to associate with the connection alias. + Tags []*Tag `type:"list"` } // String returns the string representation. @@ -6758,7 +8557,7 @@ type ConnectClientAddIn struct { // 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 ConnectClientAddIn) String() string { +func (s CreateConnectionAliasInput) String() string { return awsutil.Prettify(s) } @@ -6767,57 +8566,53 @@ func (s ConnectClientAddIn) String() string { // 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 ConnectClientAddIn) GoString() string { +func (s CreateConnectionAliasInput) GoString() string { return s.String() } -// SetAddInId sets the AddInId field's value. -func (s *ConnectClientAddIn) SetAddInId(v string) *ConnectClientAddIn { - s.AddInId = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateConnectionAliasInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateConnectionAliasInput"} + if s.ConnectionString == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectionString")) + } + if s.ConnectionString != nil && len(*s.ConnectionString) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConnectionString", 1)) + } + 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)) + } + } + } -// SetName sets the Name field's value. -func (s *ConnectClientAddIn) SetName(v string) *ConnectClientAddIn { - s.Name = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetResourceId sets the ResourceId field's value. -func (s *ConnectClientAddIn) SetResourceId(v string) *ConnectClientAddIn { - s.ResourceId = &v +// SetConnectionString sets the ConnectionString field's value. +func (s *CreateConnectionAliasInput) SetConnectionString(v string) *CreateConnectionAliasInput { + s.ConnectionString = &v return s } -// SetURL sets the URL field's value. -func (s *ConnectClientAddIn) SetURL(v string) *ConnectClientAddIn { - s.URL = &v +// SetTags sets the Tags field's value. +func (s *CreateConnectionAliasInput) SetTags(v []*Tag) *CreateConnectionAliasInput { + s.Tags = v return s } -// Describes a connection alias. Connection aliases are used for cross-Region -// redirection. For more information, see Cross-Region Redirection for Amazon -// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). -type ConnectionAlias struct { +type CreateConnectionAliasOutput struct { _ struct{} `type:"structure"` - - // The identifier of the connection alias. - AliasId *string `min:"13" type:"string"` - - // The association status of the connection alias. - Associations []*ConnectionAliasAssociation `min:"1" type:"list"` - - // The connection string specified for the connection alias. The connection - // string must be in the form of a fully qualified domain name (FQDN), such - // as www.example.com. - ConnectionString *string `min:"1" type:"string"` - - // The identifier of the Amazon Web Services account that owns the connection - // alias. - OwnerAccountId *string `type:"string"` - - // The current state of the connection alias. - State *string `type:"string" enum:"ConnectionAliasState"` + + // The identifier of the connection alias. + AliasId *string `min:"13" type:"string"` } // String returns the string representation. @@ -6825,7 +8620,7 @@ type ConnectionAlias struct { // 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 ConnectionAlias) String() string { +func (s CreateConnectionAliasOutput) String() string { return awsutil.Prettify(s) } @@ -6834,60 +8629,32 @@ func (s ConnectionAlias) String() string { // 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 ConnectionAlias) GoString() string { +func (s CreateConnectionAliasOutput) GoString() string { return s.String() } // SetAliasId sets the AliasId field's value. -func (s *ConnectionAlias) SetAliasId(v string) *ConnectionAlias { +func (s *CreateConnectionAliasOutput) SetAliasId(v string) *CreateConnectionAliasOutput { s.AliasId = &v return s } -// SetAssociations sets the Associations field's value. -func (s *ConnectionAlias) SetAssociations(v []*ConnectionAliasAssociation) *ConnectionAlias { - s.Associations = v - return s -} - -// SetConnectionString sets the ConnectionString field's value. -func (s *ConnectionAlias) SetConnectionString(v string) *ConnectionAlias { - s.ConnectionString = &v - return s -} - -// SetOwnerAccountId sets the OwnerAccountId field's value. -func (s *ConnectionAlias) SetOwnerAccountId(v string) *ConnectionAlias { - s.OwnerAccountId = &v - return s -} - -// SetState sets the State field's value. -func (s *ConnectionAlias) SetState(v string) *ConnectionAlias { - s.State = &v - return s -} - -// Describes a connection alias association that is used for cross-Region redirection. -// For more information, see Cross-Region Redirection for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). -type ConnectionAliasAssociation struct { +type CreateIpGroupInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Web Services account that associated the connection - // alias with a directory. - AssociatedAccountId *string `type:"string"` + // The description of the group. + GroupDesc *string `type:"string"` - // The association status of the connection alias. - AssociationStatus *string `type:"string" enum:"AssociationStatus"` + // The name of the group. + // + // GroupName is a required field + GroupName *string `type:"string" required:"true"` - // The identifier of the connection alias association. You use the connection - // identifier in the DNS TXT record when you're configuring your DNS routing - // policies. - ConnectionIdentifier *string `min:"1" type:"string"` + // The tags. Each WorkSpaces resource can have a maximum of 50 tags. + Tags []*Tag `type:"list"` - // The identifier of the directory associated with a connection alias. - ResourceId *string `min:"1" type:"string"` + // The rules to add to the group. + UserRules []*IpRuleItem `type:"list"` } // String returns the string representation. @@ -6895,7 +8662,7 @@ type ConnectionAliasAssociation struct { // 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 ConnectionAliasAssociation) String() string { +func (s CreateIpGroupInput) String() string { return awsutil.Prettify(s) } @@ -6904,51 +8671,62 @@ func (s ConnectionAliasAssociation) String() string { // 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 ConnectionAliasAssociation) GoString() string { +func (s CreateIpGroupInput) GoString() string { return s.String() } -// SetAssociatedAccountId sets the AssociatedAccountId field's value. -func (s *ConnectionAliasAssociation) SetAssociatedAccountId(v string) *ConnectionAliasAssociation { - s.AssociatedAccountId = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateIpGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateIpGroupInput"} + if s.GroupName == nil { + invalidParams.Add(request.NewErrParamRequired("GroupName")) + } + 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 +} + +// SetGroupDesc sets the GroupDesc field's value. +func (s *CreateIpGroupInput) SetGroupDesc(v string) *CreateIpGroupInput { + s.GroupDesc = &v return s } -// SetAssociationStatus sets the AssociationStatus field's value. -func (s *ConnectionAliasAssociation) SetAssociationStatus(v string) *ConnectionAliasAssociation { - s.AssociationStatus = &v +// SetGroupName sets the GroupName field's value. +func (s *CreateIpGroupInput) SetGroupName(v string) *CreateIpGroupInput { + s.GroupName = &v return s } -// SetConnectionIdentifier sets the ConnectionIdentifier field's value. -func (s *ConnectionAliasAssociation) SetConnectionIdentifier(v string) *ConnectionAliasAssociation { - s.ConnectionIdentifier = &v +// SetTags sets the Tags field's value. +func (s *CreateIpGroupInput) SetTags(v []*Tag) *CreateIpGroupInput { + s.Tags = v return s } -// SetResourceId sets the ResourceId field's value. -func (s *ConnectionAliasAssociation) SetResourceId(v string) *ConnectionAliasAssociation { - s.ResourceId = &v +// SetUserRules sets the UserRules field's value. +func (s *CreateIpGroupInput) SetUserRules(v []*IpRuleItem) *CreateIpGroupInput { + s.UserRules = v return s } -// Describes the permissions for a connection alias. Connection aliases are -// used for cross-Region redirection. For more information, see Cross-Region -// Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). -type ConnectionAliasPermission struct { +type CreateIpGroupOutput struct { _ struct{} `type:"structure"` - // Indicates whether the specified Amazon Web Services account is allowed to - // associate the connection alias with a directory. - // - // AllowAssociation is a required field - AllowAssociation *bool `type:"boolean" required:"true"` - - // The identifier of the Amazon Web Services account that the connection alias - // is shared with. - // - // SharedAccountId is a required field - SharedAccountId *string `type:"string" required:"true"` + // The identifier of the group. + GroupId *string `type:"string"` } // String returns the string representation. @@ -6956,7 +8734,7 @@ type ConnectionAliasPermission struct { // 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 ConnectionAliasPermission) String() string { +func (s CreateIpGroupOutput) String() string { return awsutil.Prettify(s) } @@ -6965,61 +8743,28 @@ func (s ConnectionAliasPermission) String() string { // 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 ConnectionAliasPermission) GoString() string { +func (s CreateIpGroupOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ConnectionAliasPermission) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ConnectionAliasPermission"} - if s.AllowAssociation == nil { - invalidParams.Add(request.NewErrParamRequired("AllowAssociation")) - } - if s.SharedAccountId == nil { - invalidParams.Add(request.NewErrParamRequired("SharedAccountId")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetAllowAssociation sets the AllowAssociation field's value. -func (s *ConnectionAliasPermission) SetAllowAssociation(v bool) *ConnectionAliasPermission { - s.AllowAssociation = &v - return s -} - -// SetSharedAccountId sets the SharedAccountId field's value. -func (s *ConnectionAliasPermission) SetSharedAccountId(v string) *ConnectionAliasPermission { - s.SharedAccountId = &v +// SetGroupId sets the GroupId field's value. +func (s *CreateIpGroupOutput) SetGroupId(v string) *CreateIpGroupOutput { + s.GroupId = &v return s } -type CopyWorkspaceImageInput struct { +type CreateStandbyWorkspacesInput struct { _ struct{} `type:"structure"` - // A description of the image. - Description *string `min:"1" type:"string"` - - // The name of the image. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` - - // The identifier of the source image. + // The Region of the primary WorkSpace. // - // SourceImageId is a required field - SourceImageId *string `type:"string" required:"true"` + // PrimaryRegion is a required field + PrimaryRegion *string `min:"1" type:"string" required:"true"` - // The identifier of the source Region. + // Information about the standby WorkSpace to be created. // - // SourceRegion is a required field - SourceRegion *string `min:"1" type:"string" required:"true"` - - // The tags for the image. - Tags []*Tag `type:"list"` + // StandbyWorkspaces is a required field + StandbyWorkspaces []*StandbyWorkspace `type:"list" required:"true"` } // String returns the string representation. @@ -7027,7 +8772,7 @@ type CopyWorkspaceImageInput struct { // 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 CopyWorkspaceImageInput) String() string { +func (s CreateStandbyWorkspacesInput) String() string { return awsutil.Prettify(s) } @@ -7036,38 +8781,29 @@ func (s CopyWorkspaceImageInput) String() string { // 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 CopyWorkspaceImageInput) GoString() string { +func (s CreateStandbyWorkspacesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CopyWorkspaceImageInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CopyWorkspaceImageInput"} - if s.Description != nil && len(*s.Description) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Description", 1)) - } - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } - if s.SourceImageId == nil { - invalidParams.Add(request.NewErrParamRequired("SourceImageId")) +func (s *CreateStandbyWorkspacesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateStandbyWorkspacesInput"} + if s.PrimaryRegion == nil { + invalidParams.Add(request.NewErrParamRequired("PrimaryRegion")) } - if s.SourceRegion == nil { - invalidParams.Add(request.NewErrParamRequired("SourceRegion")) + if s.PrimaryRegion != nil && len(*s.PrimaryRegion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PrimaryRegion", 1)) } - if s.SourceRegion != nil && len(*s.SourceRegion) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SourceRegion", 1)) + if s.StandbyWorkspaces == nil { + invalidParams.Add(request.NewErrParamRequired("StandbyWorkspaces")) } - if s.Tags != nil { - for i, v := range s.Tags { + if s.StandbyWorkspaces != nil { + for i, v := range s.StandbyWorkspaces { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "StandbyWorkspaces", i), err.(request.ErrInvalidParams)) } } } @@ -7078,41 +8814,26 @@ func (s *CopyWorkspaceImageInput) Validate() error { return nil } -// SetDescription sets the Description field's value. -func (s *CopyWorkspaceImageInput) SetDescription(v string) *CopyWorkspaceImageInput { - s.Description = &v - return s -} - -// SetName sets the Name field's value. -func (s *CopyWorkspaceImageInput) SetName(v string) *CopyWorkspaceImageInput { - s.Name = &v - return s -} - -// SetSourceImageId sets the SourceImageId field's value. -func (s *CopyWorkspaceImageInput) SetSourceImageId(v string) *CopyWorkspaceImageInput { - s.SourceImageId = &v - return s -} - -// SetSourceRegion sets the SourceRegion field's value. -func (s *CopyWorkspaceImageInput) SetSourceRegion(v string) *CopyWorkspaceImageInput { - s.SourceRegion = &v +// SetPrimaryRegion sets the PrimaryRegion field's value. +func (s *CreateStandbyWorkspacesInput) SetPrimaryRegion(v string) *CreateStandbyWorkspacesInput { + s.PrimaryRegion = &v return s } -// SetTags sets the Tags field's value. -func (s *CopyWorkspaceImageInput) SetTags(v []*Tag) *CopyWorkspaceImageInput { - s.Tags = v +// SetStandbyWorkspaces sets the StandbyWorkspaces field's value. +func (s *CreateStandbyWorkspacesInput) SetStandbyWorkspaces(v []*StandbyWorkspace) *CreateStandbyWorkspacesInput { + s.StandbyWorkspaces = v return s } -type CopyWorkspaceImageOutput struct { +type CreateStandbyWorkspacesOutput struct { _ struct{} `type:"structure"` - // The identifier of the image. - ImageId *string `type:"string"` + // Information about the standby WorkSpace that could not be created. + FailedStandbyRequests []*FailedCreateStandbyWorkspacesRequest `type:"list"` + + // Information about the standby WorkSpace that was created. + PendingStandbyRequests []*PendingCreateStandbyWorkspacesRequest `type:"list"` } // String returns the string representation. @@ -7120,7 +8841,7 @@ type CopyWorkspaceImageOutput struct { // 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 CopyWorkspaceImageOutput) String() string { +func (s CreateStandbyWorkspacesOutput) String() string { return awsutil.Prettify(s) } @@ -7129,33 +8850,36 @@ func (s CopyWorkspaceImageOutput) String() string { // 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 CopyWorkspaceImageOutput) GoString() string { +func (s CreateStandbyWorkspacesOutput) GoString() string { return s.String() } -// SetImageId sets the ImageId field's value. -func (s *CopyWorkspaceImageOutput) SetImageId(v string) *CopyWorkspaceImageOutput { - s.ImageId = &v +// SetFailedStandbyRequests sets the FailedStandbyRequests field's value. +func (s *CreateStandbyWorkspacesOutput) SetFailedStandbyRequests(v []*FailedCreateStandbyWorkspacesRequest) *CreateStandbyWorkspacesOutput { + s.FailedStandbyRequests = v return s } -type CreateConnectClientAddInInput struct { - _ struct{} `type:"structure"` +// SetPendingStandbyRequests sets the PendingStandbyRequests field's value. +func (s *CreateStandbyWorkspacesOutput) SetPendingStandbyRequests(v []*PendingCreateStandbyWorkspacesRequest) *CreateStandbyWorkspacesOutput { + s.PendingStandbyRequests = v + return s +} - // The name of the client add-in. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` +type CreateTagsInput struct { + _ struct{} `type:"structure"` - // The directory identifier for which to configure the client add-in. + // The identifier of the WorkSpaces resource. The supported resource types are + // WorkSpaces, registered directories, images, custom bundles, IP access control + // groups, and connection aliases. // // ResourceId is a required field - ResourceId *string `min:"10" type:"string" required:"true"` + ResourceId *string `min:"1" type:"string" required:"true"` - // The endpoint URL of the Amazon Connect client add-in. + // The tags. Each WorkSpaces resource can have a maximum of 50 tags. // - // URL is a required field - URL *string `min:"1" type:"string" required:"true"` + // Tags is a required field + Tags []*Tag `type:"list" required:"true"` } // String returns the string representation. @@ -7163,7 +8887,7 @@ type CreateConnectClientAddInInput struct { // 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 CreateConnectClientAddInInput) String() string { +func (s CreateTagsInput) String() string { return awsutil.Prettify(s) } @@ -7172,30 +8896,31 @@ func (s CreateConnectClientAddInInput) String() string { // 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 CreateConnectClientAddInInput) GoString() string { +func (s CreateTagsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateConnectClientAddInInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateConnectClientAddInInput"} - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } +func (s *CreateTagsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateTagsInput"} if s.ResourceId == nil { invalidParams.Add(request.NewErrParamRequired("ResourceId")) } - if s.ResourceId != nil && len(*s.ResourceId) < 10 { - invalidParams.Add(request.NewErrParamMinLen("ResourceId", 10)) + if s.ResourceId != nil && len(*s.ResourceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1)) } - if s.URL == nil { - invalidParams.Add(request.NewErrParamRequired("URL")) + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) } - if s.URL != nil && len(*s.URL) < 1 { - invalidParams.Add(request.NewErrParamMinLen("URL", 1)) + 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 { @@ -7204,29 +8929,20 @@ func (s *CreateConnectClientAddInInput) Validate() error { return nil } -// SetName sets the Name field's value. -func (s *CreateConnectClientAddInInput) SetName(v string) *CreateConnectClientAddInInput { - s.Name = &v - return s -} - // SetResourceId sets the ResourceId field's value. -func (s *CreateConnectClientAddInInput) SetResourceId(v string) *CreateConnectClientAddInInput { +func (s *CreateTagsInput) SetResourceId(v string) *CreateTagsInput { s.ResourceId = &v return s } -// SetURL sets the URL field's value. -func (s *CreateConnectClientAddInInput) SetURL(v string) *CreateConnectClientAddInInput { - s.URL = &v +// SetTags sets the Tags field's value. +func (s *CreateTagsInput) SetTags(v []*Tag) *CreateTagsInput { + s.Tags = v return s } -type CreateConnectClientAddInOutput struct { +type CreateTagsOutput struct { _ struct{} `type:"structure"` - - // The client add-in identifier. - AddInId *string `min:"36" type:"string"` } // String returns the string representation. @@ -7234,7 +8950,7 @@ type CreateConnectClientAddInOutput struct { // 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 CreateConnectClientAddInOutput) String() string { +func (s CreateTagsOutput) String() string { return awsutil.Prettify(s) } @@ -7243,31 +8959,32 @@ func (s CreateConnectClientAddInOutput) String() string { // 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 CreateConnectClientAddInOutput) GoString() string { +func (s CreateTagsOutput) GoString() string { return s.String() } -// SetAddInId sets the AddInId field's value. -func (s *CreateConnectClientAddInOutput) SetAddInId(v string) *CreateConnectClientAddInOutput { - s.AddInId = &v - return s -} - -type CreateConnectionAliasInput struct { +type CreateUpdatedWorkspaceImageInput struct { _ struct{} `type:"structure"` - // A connection string in the form of a fully qualified domain name (FQDN), - // such as www.example.com. + // A description of whether updates for the WorkSpace image are available. // - // After you create a connection string, it is always associated to your Amazon - // Web Services account. You cannot recreate the same connection string with - // a different account, even if you delete all instances of it from the original - // account. The connection string is globally reserved for your account. + // Description is a required field + Description *string `min:"1" type:"string" required:"true"` + + // The name of the new updated WorkSpace image. // - // ConnectionString is a required field - ConnectionString *string `min:"1" type:"string" required:"true"` + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` - // The tags to associate with the connection alias. + // The identifier of the source WorkSpace image. + // + // SourceImageId is a required field + SourceImageId *string `type:"string" required:"true"` + + // The tags that you want to add to the new updated WorkSpace image. + // + // To add tags at the same time when you're creating the updated image, you + // must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags. Tags []*Tag `type:"list"` } @@ -7276,7 +8993,7 @@ type CreateConnectionAliasInput struct { // 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 CreateConnectionAliasInput) String() string { +func (s CreateUpdatedWorkspaceImageInput) String() string { return awsutil.Prettify(s) } @@ -7285,18 +9002,27 @@ func (s CreateConnectionAliasInput) String() string { // 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 CreateConnectionAliasInput) GoString() string { +func (s CreateUpdatedWorkspaceImageInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateConnectionAliasInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateConnectionAliasInput"} - if s.ConnectionString == nil { - invalidParams.Add(request.NewErrParamRequired("ConnectionString")) +func (s *CreateUpdatedWorkspaceImageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateUpdatedWorkspaceImageInput"} + if s.Description == nil { + invalidParams.Add(request.NewErrParamRequired("Description")) } - if s.ConnectionString != nil && len(*s.ConnectionString) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ConnectionString", 1)) + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.SourceImageId == nil { + invalidParams.Add(request.NewErrParamRequired("SourceImageId")) } if s.Tags != nil { for i, v := range s.Tags { @@ -7315,23 +9041,35 @@ func (s *CreateConnectionAliasInput) Validate() error { return nil } -// SetConnectionString sets the ConnectionString field's value. -func (s *CreateConnectionAliasInput) SetConnectionString(v string) *CreateConnectionAliasInput { - s.ConnectionString = &v +// SetDescription sets the Description field's value. +func (s *CreateUpdatedWorkspaceImageInput) SetDescription(v string) *CreateUpdatedWorkspaceImageInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateUpdatedWorkspaceImageInput) SetName(v string) *CreateUpdatedWorkspaceImageInput { + s.Name = &v + return s +} + +// SetSourceImageId sets the SourceImageId field's value. +func (s *CreateUpdatedWorkspaceImageInput) SetSourceImageId(v string) *CreateUpdatedWorkspaceImageInput { + s.SourceImageId = &v return s } // SetTags sets the Tags field's value. -func (s *CreateConnectionAliasInput) SetTags(v []*Tag) *CreateConnectionAliasInput { +func (s *CreateUpdatedWorkspaceImageInput) SetTags(v []*Tag) *CreateUpdatedWorkspaceImageInput { s.Tags = v return s } -type CreateConnectionAliasOutput struct { +type CreateUpdatedWorkspaceImageOutput struct { _ struct{} `type:"structure"` - // The identifier of the connection alias. - AliasId *string `min:"13" type:"string"` + // The identifier of the new updated WorkSpace image. + ImageId *string `type:"string"` } // String returns the string representation. @@ -7339,7 +9077,7 @@ type CreateConnectionAliasOutput struct { // 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 CreateConnectionAliasOutput) String() string { +func (s CreateUpdatedWorkspaceImageOutput) String() string { return awsutil.Prettify(s) } @@ -7348,32 +9086,52 @@ func (s CreateConnectionAliasOutput) String() string { // 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 CreateConnectionAliasOutput) GoString() string { +func (s CreateUpdatedWorkspaceImageOutput) GoString() string { return s.String() } -// SetAliasId sets the AliasId field's value. -func (s *CreateConnectionAliasOutput) SetAliasId(v string) *CreateConnectionAliasOutput { - s.AliasId = &v +// SetImageId sets the ImageId field's value. +func (s *CreateUpdatedWorkspaceImageOutput) SetImageId(v string) *CreateUpdatedWorkspaceImageOutput { + s.ImageId = &v return s } -type CreateIpGroupInput struct { +type CreateWorkspaceBundleInput struct { _ struct{} `type:"structure"` - // The description of the group. - GroupDesc *string `type:"string"` + // The description of the bundle. + // + // BundleDescription is a required field + BundleDescription *string `min:"1" type:"string" required:"true"` - // The name of the group. + // The name of the bundle. // - // GroupName is a required field - GroupName *string `type:"string" required:"true"` + // BundleName is a required field + BundleName *string `min:"1" type:"string" required:"true"` - // The tags. Each WorkSpaces resource can have a maximum of 50 tags. + // Describes the compute type of the bundle. + // + // ComputeType is a required field + ComputeType *ComputeType `type:"structure" required:"true"` + + // The identifier of the image that is used to create the bundle. + // + // ImageId is a required field + ImageId *string `type:"string" required:"true"` + + // Describes the root volume for a WorkSpace bundle. + RootStorage *RootStorage `type:"structure"` + + // The tags associated with the bundle. + // + // To add tags at the same time when you're creating the bundle, you must create + // an IAM policy that grants your IAM user permissions to use workspaces:CreateTags. Tags []*Tag `type:"list"` - // The rules to add to the group. - UserRules []*IpRuleItem `type:"list"` + // Describes the user volume for a WorkSpace bundle. + // + // UserStorage is a required field + UserStorage *UserStorage `type:"structure" required:"true"` } // String returns the string representation. @@ -7381,7 +9139,7 @@ type CreateIpGroupInput struct { // 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 CreateIpGroupInput) String() string { +func (s CreateWorkspaceBundleInput) String() string { return awsutil.Prettify(s) } @@ -7390,15 +9148,38 @@ func (s CreateIpGroupInput) String() string { // 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 CreateIpGroupInput) GoString() string { +func (s CreateWorkspaceBundleInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateIpGroupInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateIpGroupInput"} - if s.GroupName == nil { - invalidParams.Add(request.NewErrParamRequired("GroupName")) +func (s *CreateWorkspaceBundleInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWorkspaceBundleInput"} + if s.BundleDescription == nil { + invalidParams.Add(request.NewErrParamRequired("BundleDescription")) + } + if s.BundleDescription != nil && len(*s.BundleDescription) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BundleDescription", 1)) + } + if s.BundleName == nil { + invalidParams.Add(request.NewErrParamRequired("BundleName")) + } + if s.BundleName != nil && len(*s.BundleName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BundleName", 1)) + } + if s.ComputeType == nil { + invalidParams.Add(request.NewErrParamRequired("ComputeType")) + } + if s.ImageId == nil { + invalidParams.Add(request.NewErrParamRequired("ImageId")) + } + if s.UserStorage == nil { + invalidParams.Add(request.NewErrParamRequired("UserStorage")) + } + if s.RootStorage != nil { + if err := s.RootStorage.Validate(); err != nil { + invalidParams.AddNested("RootStorage", err.(request.ErrInvalidParams)) + } } if s.Tags != nil { for i, v := range s.Tags { @@ -7410,6 +9191,11 @@ func (s *CreateIpGroupInput) Validate() error { } } } + if s.UserStorage != nil { + if err := s.UserStorage.Validate(); err != nil { + invalidParams.AddNested("UserStorage", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -7417,35 +9203,53 @@ func (s *CreateIpGroupInput) Validate() error { return nil } -// SetGroupDesc sets the GroupDesc field's value. -func (s *CreateIpGroupInput) SetGroupDesc(v string) *CreateIpGroupInput { - s.GroupDesc = &v +// SetBundleDescription sets the BundleDescription field's value. +func (s *CreateWorkspaceBundleInput) SetBundleDescription(v string) *CreateWorkspaceBundleInput { + s.BundleDescription = &v return s } -// SetGroupName sets the GroupName field's value. -func (s *CreateIpGroupInput) SetGroupName(v string) *CreateIpGroupInput { - s.GroupName = &v +// SetBundleName sets the BundleName field's value. +func (s *CreateWorkspaceBundleInput) SetBundleName(v string) *CreateWorkspaceBundleInput { + s.BundleName = &v + return s +} + +// SetComputeType sets the ComputeType field's value. +func (s *CreateWorkspaceBundleInput) SetComputeType(v *ComputeType) *CreateWorkspaceBundleInput { + s.ComputeType = v + return s +} + +// SetImageId sets the ImageId field's value. +func (s *CreateWorkspaceBundleInput) SetImageId(v string) *CreateWorkspaceBundleInput { + s.ImageId = &v + return s +} + +// SetRootStorage sets the RootStorage field's value. +func (s *CreateWorkspaceBundleInput) SetRootStorage(v *RootStorage) *CreateWorkspaceBundleInput { + s.RootStorage = v return s } // SetTags sets the Tags field's value. -func (s *CreateIpGroupInput) SetTags(v []*Tag) *CreateIpGroupInput { +func (s *CreateWorkspaceBundleInput) SetTags(v []*Tag) *CreateWorkspaceBundleInput { s.Tags = v return s } -// SetUserRules sets the UserRules field's value. -func (s *CreateIpGroupInput) SetUserRules(v []*IpRuleItem) *CreateIpGroupInput { - s.UserRules = v +// SetUserStorage sets the UserStorage field's value. +func (s *CreateWorkspaceBundleInput) SetUserStorage(v *UserStorage) *CreateWorkspaceBundleInput { + s.UserStorage = v return s } -type CreateIpGroupOutput struct { +type CreateWorkspaceBundleOutput struct { _ struct{} `type:"structure"` - // The identifier of the group. - GroupId *string `type:"string"` + // Describes a WorkSpace bundle. + WorkspaceBundle *WorkspaceBundle `type:"structure"` } // String returns the string representation. @@ -7453,7 +9257,7 @@ type CreateIpGroupOutput struct { // 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 CreateIpGroupOutput) String() string { +func (s CreateWorkspaceBundleOutput) String() string { return awsutil.Prettify(s) } @@ -7462,28 +9266,38 @@ func (s CreateIpGroupOutput) String() string { // 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 CreateIpGroupOutput) GoString() string { +func (s CreateWorkspaceBundleOutput) GoString() string { return s.String() } -// SetGroupId sets the GroupId field's value. -func (s *CreateIpGroupOutput) SetGroupId(v string) *CreateIpGroupOutput { - s.GroupId = &v +// SetWorkspaceBundle sets the WorkspaceBundle field's value. +func (s *CreateWorkspaceBundleOutput) SetWorkspaceBundle(v *WorkspaceBundle) *CreateWorkspaceBundleOutput { + s.WorkspaceBundle = v return s } -type CreateStandbyWorkspacesInput struct { +type CreateWorkspaceImageInput struct { _ struct{} `type:"structure"` - // The Region of the primary WorkSpace. + // The description of the new WorkSpace image. // - // PrimaryRegion is a required field - PrimaryRegion *string `min:"1" type:"string" required:"true"` + // Description is a required field + Description *string `min:"1" type:"string" required:"true"` - // Information about the standby WorkSpace to be created. + // The name of the new WorkSpace image. // - // StandbyWorkspaces is a required field - StandbyWorkspaces []*StandbyWorkspace `type:"list" required:"true"` + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The tags that you want to add to the new WorkSpace image. To add tags when + // you're creating the image, you must create an IAM policy that grants your + // IAM user permission to use workspaces:CreateTags. + Tags []*Tag `type:"list"` + + // The identifier of the source WorkSpace + // + // WorkspaceId is a required field + WorkspaceId *string `type:"string" required:"true"` } // String returns the string representation. @@ -7491,7 +9305,7 @@ type CreateStandbyWorkspacesInput struct { // 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 CreateStandbyWorkspacesInput) String() string { +func (s CreateWorkspaceImageInput) String() string { return awsutil.Prettify(s) } @@ -7500,29 +9314,35 @@ func (s CreateStandbyWorkspacesInput) String() string { // 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 CreateStandbyWorkspacesInput) GoString() string { +func (s CreateWorkspaceImageInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateStandbyWorkspacesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateStandbyWorkspacesInput"} - if s.PrimaryRegion == nil { - invalidParams.Add(request.NewErrParamRequired("PrimaryRegion")) +func (s *CreateWorkspaceImageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWorkspaceImageInput"} + if s.Description == nil { + invalidParams.Add(request.NewErrParamRequired("Description")) } - if s.PrimaryRegion != nil && len(*s.PrimaryRegion) < 1 { - invalidParams.Add(request.NewErrParamMinLen("PrimaryRegion", 1)) + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) } - if s.StandbyWorkspaces == nil { - invalidParams.Add(request.NewErrParamRequired("StandbyWorkspaces")) + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) } - if s.StandbyWorkspaces != nil { - for i, v := range s.StandbyWorkspaces { + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.WorkspaceId == nil { + invalidParams.Add(request.NewErrParamRequired("WorkspaceId")) + } + 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]", "StandbyWorkspaces", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) } } } @@ -7533,26 +9353,58 @@ func (s *CreateStandbyWorkspacesInput) Validate() error { return nil } -// SetPrimaryRegion sets the PrimaryRegion field's value. -func (s *CreateStandbyWorkspacesInput) SetPrimaryRegion(v string) *CreateStandbyWorkspacesInput { - s.PrimaryRegion = &v +// SetDescription sets the Description field's value. +func (s *CreateWorkspaceImageInput) SetDescription(v string) *CreateWorkspaceImageInput { + s.Description = &v return s } -// SetStandbyWorkspaces sets the StandbyWorkspaces field's value. -func (s *CreateStandbyWorkspacesInput) SetStandbyWorkspaces(v []*StandbyWorkspace) *CreateStandbyWorkspacesInput { - s.StandbyWorkspaces = v +// SetName sets the Name field's value. +func (s *CreateWorkspaceImageInput) SetName(v string) *CreateWorkspaceImageInput { + s.Name = &v return s } -type CreateStandbyWorkspacesOutput struct { +// SetTags sets the Tags field's value. +func (s *CreateWorkspaceImageInput) SetTags(v []*Tag) *CreateWorkspaceImageInput { + s.Tags = v + return s +} + +// SetWorkspaceId sets the WorkspaceId field's value. +func (s *CreateWorkspaceImageInput) SetWorkspaceId(v string) *CreateWorkspaceImageInput { + s.WorkspaceId = &v + return s +} + +type CreateWorkspaceImageOutput struct { _ struct{} `type:"structure"` - // Information about the standby WorkSpace that could not be created. - FailedStandbyRequests []*FailedCreateStandbyWorkspacesRequest `type:"list"` + // The date when the image was created. + Created *time.Time `type:"timestamp"` - // Information about the standby WorkSpace that was created. - PendingStandbyRequests []*PendingCreateStandbyWorkspacesRequest `type:"list"` + // The description of the image. + Description *string `min:"1" type:"string"` + + // The identifier of the new WorkSpace image. + ImageId *string `type:"string"` + + // The name of the image. + Name *string `min:"1" type:"string"` + + // The operating system that the image is running. + OperatingSystem *OperatingSystem `type:"structure"` + + // The identifier of the Amazon Web Services account that owns the image. + OwnerAccountId *string `type:"string"` + + // Specifies whether the image is running on dedicated hardware. When Bring + // Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more + // information, see Bring Your Own Windows Desktop Images. (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.htm). + RequiredTenancy *string `type:"string" enum:"WorkspaceImageRequiredTenancy"` + + // The availability status of the image. + State *string `type:"string" enum:"WorkspaceImageState"` } // String returns the string representation. @@ -7560,7 +9412,7 @@ type CreateStandbyWorkspacesOutput struct { // 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 CreateStandbyWorkspacesOutput) String() string { +func (s CreateWorkspaceImageOutput) String() string { return awsutil.Prettify(s) } @@ -7569,36 +9421,65 @@ func (s CreateStandbyWorkspacesOutput) String() string { // 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 CreateStandbyWorkspacesOutput) GoString() string { +func (s CreateWorkspaceImageOutput) GoString() string { return s.String() } -// SetFailedStandbyRequests sets the FailedStandbyRequests field's value. -func (s *CreateStandbyWorkspacesOutput) SetFailedStandbyRequests(v []*FailedCreateStandbyWorkspacesRequest) *CreateStandbyWorkspacesOutput { - s.FailedStandbyRequests = v +// SetCreated sets the Created field's value. +func (s *CreateWorkspaceImageOutput) SetCreated(v time.Time) *CreateWorkspaceImageOutput { + s.Created = &v return s } -// SetPendingStandbyRequests sets the PendingStandbyRequests field's value. -func (s *CreateStandbyWorkspacesOutput) SetPendingStandbyRequests(v []*PendingCreateStandbyWorkspacesRequest) *CreateStandbyWorkspacesOutput { - s.PendingStandbyRequests = v +// SetDescription sets the Description field's value. +func (s *CreateWorkspaceImageOutput) SetDescription(v string) *CreateWorkspaceImageOutput { + s.Description = &v return s } -type CreateTagsInput struct { - _ struct{} `type:"structure"` +// SetImageId sets the ImageId field's value. +func (s *CreateWorkspaceImageOutput) SetImageId(v string) *CreateWorkspaceImageOutput { + s.ImageId = &v + return s +} - // The identifier of the WorkSpaces resource. The supported resource types are - // WorkSpaces, registered directories, images, custom bundles, IP access control - // groups, and connection aliases. - // - // ResourceId is a required field - ResourceId *string `min:"1" type:"string" required:"true"` +// SetName sets the Name field's value. +func (s *CreateWorkspaceImageOutput) SetName(v string) *CreateWorkspaceImageOutput { + s.Name = &v + return s +} - // The tags. Each WorkSpaces resource can have a maximum of 50 tags. +// SetOperatingSystem sets the OperatingSystem field's value. +func (s *CreateWorkspaceImageOutput) SetOperatingSystem(v *OperatingSystem) *CreateWorkspaceImageOutput { + s.OperatingSystem = v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *CreateWorkspaceImageOutput) SetOwnerAccountId(v string) *CreateWorkspaceImageOutput { + s.OwnerAccountId = &v + return s +} + +// SetRequiredTenancy sets the RequiredTenancy field's value. +func (s *CreateWorkspaceImageOutput) SetRequiredTenancy(v string) *CreateWorkspaceImageOutput { + s.RequiredTenancy = &v + return s +} + +// SetState sets the State field's value. +func (s *CreateWorkspaceImageOutput) SetState(v string) *CreateWorkspaceImageOutput { + s.State = &v + return s +} + +type CreateWorkspacesInput struct { + _ struct{} `type:"structure"` + + // The WorkSpaces to create. You can specify up to 25 WorkSpaces. // - // Tags is a required field - Tags []*Tag `type:"list" required:"true"` + // Workspaces is a required field + Workspaces []*WorkspaceRequest `min:"1" type:"list" required:"true"` } // String returns the string representation. @@ -7606,7 +9487,7 @@ type CreateTagsInput struct { // 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 CreateTagsInput) String() string { +func (s CreateWorkspacesInput) String() string { return awsutil.Prettify(s) } @@ -7614,30 +9495,27 @@ func (s CreateTagsInput) String() string { // // 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 CreateTagsInput) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *CreateTagsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateTagsInput"} - if s.ResourceId == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceId")) - } - if s.ResourceId != nil && len(*s.ResourceId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1)) +// value will be replaced with "sensitive". +func (s CreateWorkspacesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateWorkspacesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWorkspacesInput"} + if s.Workspaces == nil { + invalidParams.Add(request.NewErrParamRequired("Workspaces")) } - if s.Tags == nil { - invalidParams.Add(request.NewErrParamRequired("Tags")) + if s.Workspaces != nil && len(s.Workspaces) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Workspaces", 1)) } - if s.Tags != nil { - for i, v := range s.Tags { + if s.Workspaces != nil { + for i, v := range s.Workspaces { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Workspaces", i), err.(request.ErrInvalidParams)) } } } @@ -7648,20 +9526,24 @@ func (s *CreateTagsInput) Validate() error { return nil } -// SetResourceId sets the ResourceId field's value. -func (s *CreateTagsInput) SetResourceId(v string) *CreateTagsInput { - s.ResourceId = &v - return s -} - -// SetTags sets the Tags field's value. -func (s *CreateTagsInput) SetTags(v []*Tag) *CreateTagsInput { - s.Tags = v +// SetWorkspaces sets the Workspaces field's value. +func (s *CreateWorkspacesInput) SetWorkspaces(v []*WorkspaceRequest) *CreateWorkspacesInput { + s.Workspaces = v return s } -type CreateTagsOutput struct { +type CreateWorkspacesOutput struct { _ struct{} `type:"structure"` + + // Information about the WorkSpaces that could not be created. + FailedRequests []*FailedCreateWorkspaceRequest `type:"list"` + + // Information about the WorkSpaces that were created. + // + // Because this operation is asynchronous, the identifier returned is not immediately + // available for use with other operations. For example, if you call DescribeWorkspaces + // before the WorkSpace is created, the information returned can be incomplete. + PendingRequests []*Workspace `type:"list"` } // String returns the string representation. @@ -7669,7 +9551,7 @@ type CreateTagsOutput struct { // 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 CreateTagsOutput) String() string { +func (s CreateWorkspacesOutput) String() string { return awsutil.Prettify(s) } @@ -7678,33 +9560,63 @@ func (s CreateTagsOutput) String() string { // 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 CreateTagsOutput) GoString() string { +func (s CreateWorkspacesOutput) GoString() string { return s.String() } -type CreateUpdatedWorkspaceImageInput struct { +// SetFailedRequests sets the FailedRequests field's value. +func (s *CreateWorkspacesOutput) SetFailedRequests(v []*FailedCreateWorkspaceRequest) *CreateWorkspacesOutput { + s.FailedRequests = v + return s +} + +// SetPendingRequests sets the PendingRequests field's value. +func (s *CreateWorkspacesOutput) SetPendingRequests(v []*Workspace) *CreateWorkspacesOutput { + s.PendingRequests = v + return s +} + +// Returns default client branding attributes that were imported. These attributes +// display on the client login screen. +// +// Client branding attributes are public facing. Ensure that you don't include +// sensitive information. +type DefaultClientBrandingAttributes struct { _ struct{} `type:"structure"` - // A description of whether updates for the WorkSpace image are available. - // - // Description is a required field - Description *string `min:"1" type:"string" required:"true"` + // The forgotten password link. This is the web address that users can go to + // if they forget the password for their WorkSpace. + ForgotPasswordLink *string `min:"1" type:"string"` - // The name of the new updated WorkSpace image. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` + // The login message. Specified as a key value pair, in which the key is a locale + // and the value is the localized message for that locale. The only key supported + // is en_US. The HTML tags supported include the following: a, b, blockquote, + // br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, + // strong, sub, sup, u, ul. + LoginMessage map[string]*string `type:"map"` - // The identifier of the source WorkSpace image. + // The logo. The only image format accepted is a binary data object that is + // converted from a .png file. + LogoUrl *string `min:"1" type:"string"` + + // The support email. The company's customer support email address. // - // SourceImageId is a required field - SourceImageId *string `type:"string" required:"true"` + // * In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, + // but not both. + // + // * The default email is workspaces-feedback@amazon.com. + SupportEmail *string `min:"6" type:"string"` - // The tags that you want to add to the new updated WorkSpace image. + // The support link. The link for the company's customer support page for their + // WorkSpace. // - // To add tags at the same time when you're creating the updated image, you - // must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags. - Tags []*Tag `type:"list"` + // * In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive.You can specify one parameter for each platform type, + // but not both. + // + // * The default support link is workspaces-feedback@amazon.com. + SupportLink *string `min:"1" type:"string"` } // String returns the string representation. @@ -7712,7 +9624,7 @@ type CreateUpdatedWorkspaceImageInput struct { // 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 CreateUpdatedWorkspaceImageInput) String() string { +func (s DefaultClientBrandingAttributes) String() string { return awsutil.Prettify(s) } @@ -7721,136 +9633,82 @@ func (s CreateUpdatedWorkspaceImageInput) String() string { // 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 CreateUpdatedWorkspaceImageInput) GoString() string { +func (s DefaultClientBrandingAttributes) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *CreateUpdatedWorkspaceImageInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateUpdatedWorkspaceImageInput"} - if s.Description == nil { - invalidParams.Add(request.NewErrParamRequired("Description")) - } - if s.Description != nil && len(*s.Description) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Description", 1)) - } - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } - if s.SourceImageId == nil { - invalidParams.Add(request.NewErrParamRequired("SourceImageId")) - } - 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 -} - -// SetDescription sets the Description field's value. -func (s *CreateUpdatedWorkspaceImageInput) SetDescription(v string) *CreateUpdatedWorkspaceImageInput { - s.Description = &v +// SetForgotPasswordLink sets the ForgotPasswordLink field's value. +func (s *DefaultClientBrandingAttributes) SetForgotPasswordLink(v string) *DefaultClientBrandingAttributes { + s.ForgotPasswordLink = &v return s } -// SetName sets the Name field's value. -func (s *CreateUpdatedWorkspaceImageInput) SetName(v string) *CreateUpdatedWorkspaceImageInput { - s.Name = &v +// SetLoginMessage sets the LoginMessage field's value. +func (s *DefaultClientBrandingAttributes) SetLoginMessage(v map[string]*string) *DefaultClientBrandingAttributes { + s.LoginMessage = v return s } -// SetSourceImageId sets the SourceImageId field's value. -func (s *CreateUpdatedWorkspaceImageInput) SetSourceImageId(v string) *CreateUpdatedWorkspaceImageInput { - s.SourceImageId = &v +// SetLogoUrl sets the LogoUrl field's value. +func (s *DefaultClientBrandingAttributes) SetLogoUrl(v string) *DefaultClientBrandingAttributes { + s.LogoUrl = &v return s } -// SetTags sets the Tags field's value. -func (s *CreateUpdatedWorkspaceImageInput) SetTags(v []*Tag) *CreateUpdatedWorkspaceImageInput { - s.Tags = v +// SetSupportEmail sets the SupportEmail field's value. +func (s *DefaultClientBrandingAttributes) SetSupportEmail(v string) *DefaultClientBrandingAttributes { + s.SupportEmail = &v return s } -type CreateUpdatedWorkspaceImageOutput struct { - _ struct{} `type:"structure"` - - // The identifier of the new updated WorkSpace image. - ImageId *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 CreateUpdatedWorkspaceImageOutput) 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 CreateUpdatedWorkspaceImageOutput) GoString() string { - return s.String() -} - -// SetImageId sets the ImageId field's value. -func (s *CreateUpdatedWorkspaceImageOutput) SetImageId(v string) *CreateUpdatedWorkspaceImageOutput { - s.ImageId = &v +// SetSupportLink sets the SupportLink field's value. +func (s *DefaultClientBrandingAttributes) SetSupportLink(v string) *DefaultClientBrandingAttributes { + s.SupportLink = &v return s } -type CreateWorkspaceBundleInput struct { +// The default client branding attributes to be imported. These attributes display +// on the client login screen. +// +// Client branding attributes are public facing. Ensure that you do not include +// sensitive information. +type DefaultImportClientBrandingAttributes struct { _ struct{} `type:"structure"` - // The description of the bundle. - // - // BundleDescription is a required field - BundleDescription *string `min:"1" type:"string" required:"true"` + // The forgotten password link. This is the web address that users can go to + // if they forget the password for their WorkSpace. + ForgotPasswordLink *string `min:"1" type:"string"` - // The name of the bundle. - // - // BundleName is a required field - BundleName *string `min:"1" type:"string" required:"true"` + // The login message. Specified as a key value pair, in which the key is a locale + // and the value is the localized message for that locale. The only key supported + // is en_US. The HTML tags supported include the following: a, b, blockquote, + // br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, + // strong, sub, sup, u, ul. + LoginMessage map[string]*string `type:"map"` - // Describes the compute type of the bundle. - // - // ComputeType is a required field - ComputeType *ComputeType `type:"structure" required:"true"` + // The logo. The only image format accepted is a binary data object that is + // converted from a .png file. + // Logo is automatically base64 encoded/decoded by the SDK. + Logo []byte `min:"1" type:"blob"` - // The identifier of the image that is used to create the bundle. + // The support email. The company's customer support email address. // - // ImageId is a required field - ImageId *string `type:"string" required:"true"` - - // Describes the root volume for a WorkSpace bundle. - RootStorage *RootStorage `type:"structure"` - - // The tags associated with the bundle. + // * In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, + // but not both. // - // To add tags at the same time when you're creating the bundle, you must create - // an IAM policy that grants your IAM user permissions to use workspaces:CreateTags. - Tags []*Tag `type:"list"` + // * The default email is workspaces-feedback@amazon.com. + SupportEmail *string `min:"6" type:"string"` - // Describes the user volume for a WorkSpace bundle. + // The support link. The link for the company's customer support page for their + // WorkSpace. // - // UserStorage is a required field - UserStorage *UserStorage `type:"structure" required:"true"` + // * In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, + // but not both. + // + // * The default support link is workspaces-feedback@amazon.com. + SupportLink *string `min:"1" type:"string"` } // String returns the string representation. @@ -7858,7 +9716,7 @@ type CreateWorkspaceBundleInput struct { // 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 CreateWorkspaceBundleInput) String() string { +func (s DefaultImportClientBrandingAttributes) String() string { return awsutil.Prettify(s) } @@ -7867,53 +9725,24 @@ func (s CreateWorkspaceBundleInput) String() string { // 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 CreateWorkspaceBundleInput) GoString() string { +func (s DefaultImportClientBrandingAttributes) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateWorkspaceBundleInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateWorkspaceBundleInput"} - if s.BundleDescription == nil { - invalidParams.Add(request.NewErrParamRequired("BundleDescription")) - } - if s.BundleDescription != nil && len(*s.BundleDescription) < 1 { - invalidParams.Add(request.NewErrParamMinLen("BundleDescription", 1)) - } - if s.BundleName == nil { - invalidParams.Add(request.NewErrParamRequired("BundleName")) - } - if s.BundleName != nil && len(*s.BundleName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("BundleName", 1)) - } - if s.ComputeType == nil { - invalidParams.Add(request.NewErrParamRequired("ComputeType")) - } - if s.ImageId == nil { - invalidParams.Add(request.NewErrParamRequired("ImageId")) - } - if s.UserStorage == nil { - invalidParams.Add(request.NewErrParamRequired("UserStorage")) +func (s *DefaultImportClientBrandingAttributes) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DefaultImportClientBrandingAttributes"} + if s.ForgotPasswordLink != nil && len(*s.ForgotPasswordLink) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForgotPasswordLink", 1)) } - if s.RootStorage != nil { - if err := s.RootStorage.Validate(); err != nil { - invalidParams.AddNested("RootStorage", err.(request.ErrInvalidParams)) - } + if s.Logo != nil && len(s.Logo) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Logo", 1)) } - 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 s.SupportEmail != nil && len(*s.SupportEmail) < 6 { + invalidParams.Add(request.NewErrParamMinLen("SupportEmail", 6)) } - if s.UserStorage != nil { - if err := s.UserStorage.Validate(); err != nil { - invalidParams.AddNested("UserStorage", err.(request.ErrInvalidParams)) - } + if s.SupportLink != nil && len(*s.SupportLink) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SupportLink", 1)) } if invalidParams.Len() > 0 { @@ -7922,101 +9751,70 @@ func (s *CreateWorkspaceBundleInput) Validate() error { return nil } -// SetBundleDescription sets the BundleDescription field's value. -func (s *CreateWorkspaceBundleInput) SetBundleDescription(v string) *CreateWorkspaceBundleInput { - s.BundleDescription = &v - return s -} - -// SetBundleName sets the BundleName field's value. -func (s *CreateWorkspaceBundleInput) SetBundleName(v string) *CreateWorkspaceBundleInput { - s.BundleName = &v - return s -} - -// SetComputeType sets the ComputeType field's value. -func (s *CreateWorkspaceBundleInput) SetComputeType(v *ComputeType) *CreateWorkspaceBundleInput { - s.ComputeType = v +// SetForgotPasswordLink sets the ForgotPasswordLink field's value. +func (s *DefaultImportClientBrandingAttributes) SetForgotPasswordLink(v string) *DefaultImportClientBrandingAttributes { + s.ForgotPasswordLink = &v return s } -// SetImageId sets the ImageId field's value. -func (s *CreateWorkspaceBundleInput) SetImageId(v string) *CreateWorkspaceBundleInput { - s.ImageId = &v +// SetLoginMessage sets the LoginMessage field's value. +func (s *DefaultImportClientBrandingAttributes) SetLoginMessage(v map[string]*string) *DefaultImportClientBrandingAttributes { + s.LoginMessage = v return s } -// SetRootStorage sets the RootStorage field's value. -func (s *CreateWorkspaceBundleInput) SetRootStorage(v *RootStorage) *CreateWorkspaceBundleInput { - s.RootStorage = v +// SetLogo sets the Logo field's value. +func (s *DefaultImportClientBrandingAttributes) SetLogo(v []byte) *DefaultImportClientBrandingAttributes { + s.Logo = v return s } -// SetTags sets the Tags field's value. -func (s *CreateWorkspaceBundleInput) SetTags(v []*Tag) *CreateWorkspaceBundleInput { - s.Tags = v +// SetSupportEmail sets the SupportEmail field's value. +func (s *DefaultImportClientBrandingAttributes) SetSupportEmail(v string) *DefaultImportClientBrandingAttributes { + s.SupportEmail = &v return s } -// SetUserStorage sets the UserStorage field's value. -func (s *CreateWorkspaceBundleInput) SetUserStorage(v *UserStorage) *CreateWorkspaceBundleInput { - s.UserStorage = v +// SetSupportLink sets the SupportLink field's value. +func (s *DefaultImportClientBrandingAttributes) SetSupportLink(v string) *DefaultImportClientBrandingAttributes { + s.SupportLink = &v return s } -type CreateWorkspaceBundleOutput struct { +// Describes the default values that are used to create WorkSpaces. For more +// information, see Update Directory Details for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html). +type DefaultWorkspaceCreationProperties struct { _ struct{} `type:"structure"` - // Describes a WorkSpace bundle. - WorkspaceBundle *WorkspaceBundle `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 CreateWorkspaceBundleOutput) 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 CreateWorkspaceBundleOutput) GoString() string { - return s.String() -} - -// SetWorkspaceBundle sets the WorkspaceBundle field's value. -func (s *CreateWorkspaceBundleOutput) SetWorkspaceBundle(v *WorkspaceBundle) *CreateWorkspaceBundleOutput { - s.WorkspaceBundle = v - return s -} + // The identifier of the default security group to apply to WorkSpaces when + // they are created. For more information, see Security Groups for Your WorkSpaces + // (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html). + CustomSecurityGroupId *string `min:"11" type:"string"` -type CreateWorkspaceImageInput struct { - _ struct{} `type:"structure"` + // The organizational unit (OU) in the directory for the WorkSpace machine accounts. + DefaultOu *string `type:"string"` - // The description of the new WorkSpace image. - // - // Description is a required field - Description *string `min:"1" type:"string" required:"true"` + // Specifies whether to automatically assign an Elastic public IP address to + // WorkSpaces in this directory by default. If enabled, the Elastic public IP + // address allows outbound internet access from your WorkSpaces when you’re + // using an internet gateway in the Amazon VPC in which your WorkSpaces are + // located. If you're using a Network Address Translation (NAT) gateway for + // outbound internet access from your VPC, or if your WorkSpaces are in public + // subnets and you manually assign them Elastic IP addresses, you should disable + // this setting. This setting applies to new WorkSpaces that you launch or to + // existing WorkSpaces that you rebuild. For more information, see Configure + // a VPC for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html). + EnableInternetAccess *bool `type:"boolean"` - // The name of the new WorkSpace image. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` + // Specifies whether maintenance mode is enabled for WorkSpaces. For more information, + // see WorkSpace Maintenance (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html). + EnableMaintenanceMode *bool `type:"boolean"` - // The tags that you want to add to the new WorkSpace image. To add tags when - // you're creating the image, you must create an IAM policy that grants your - // IAM user permission to use workspaces:CreateTags. - Tags []*Tag `type:"list"` + // Specifies whether the directory is enabled for Amazon WorkDocs. + EnableWorkDocs *bool `type:"boolean"` - // The identifier of the source WorkSpace - // - // WorkspaceId is a required field - WorkspaceId *string `type:"string" required:"true"` + // Specifies whether WorkSpace users are local administrators on their WorkSpaces. + UserEnabledAsLocalAdministrator *bool `type:"boolean"` } // String returns the string representation. @@ -8024,7 +9822,7 @@ type CreateWorkspaceImageInput struct { // 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 CreateWorkspaceImageInput) String() string { +func (s DefaultWorkspaceCreationProperties) String() string { return awsutil.Prettify(s) } @@ -8033,97 +9831,59 @@ func (s CreateWorkspaceImageInput) String() string { // 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 CreateWorkspaceImageInput) GoString() string { +func (s DefaultWorkspaceCreationProperties) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *CreateWorkspaceImageInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateWorkspaceImageInput"} - if s.Description == nil { - invalidParams.Add(request.NewErrParamRequired("Description")) - } - if s.Description != nil && len(*s.Description) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Description", 1)) - } - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } - if s.WorkspaceId == nil { - invalidParams.Add(request.NewErrParamRequired("WorkspaceId")) - } - 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 +// SetCustomSecurityGroupId sets the CustomSecurityGroupId field's value. +func (s *DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId(v string) *DefaultWorkspaceCreationProperties { + s.CustomSecurityGroupId = &v + return s } -// SetDescription sets the Description field's value. -func (s *CreateWorkspaceImageInput) SetDescription(v string) *CreateWorkspaceImageInput { - s.Description = &v +// SetDefaultOu sets the DefaultOu field's value. +func (s *DefaultWorkspaceCreationProperties) SetDefaultOu(v string) *DefaultWorkspaceCreationProperties { + s.DefaultOu = &v return s } -// SetName sets the Name field's value. -func (s *CreateWorkspaceImageInput) SetName(v string) *CreateWorkspaceImageInput { - s.Name = &v +// SetEnableInternetAccess sets the EnableInternetAccess field's value. +func (s *DefaultWorkspaceCreationProperties) SetEnableInternetAccess(v bool) *DefaultWorkspaceCreationProperties { + s.EnableInternetAccess = &v return s } -// SetTags sets the Tags field's value. -func (s *CreateWorkspaceImageInput) SetTags(v []*Tag) *CreateWorkspaceImageInput { - s.Tags = v +// SetEnableMaintenanceMode sets the EnableMaintenanceMode field's value. +func (s *DefaultWorkspaceCreationProperties) SetEnableMaintenanceMode(v bool) *DefaultWorkspaceCreationProperties { + s.EnableMaintenanceMode = &v return s } -// SetWorkspaceId sets the WorkspaceId field's value. -func (s *CreateWorkspaceImageInput) SetWorkspaceId(v string) *CreateWorkspaceImageInput { - s.WorkspaceId = &v +// SetEnableWorkDocs sets the EnableWorkDocs field's value. +func (s *DefaultWorkspaceCreationProperties) SetEnableWorkDocs(v bool) *DefaultWorkspaceCreationProperties { + s.EnableWorkDocs = &v return s } -type CreateWorkspaceImageOutput struct { - _ struct{} `type:"structure"` - - // The date when the image was created. - Created *time.Time `type:"timestamp"` - - // The description of the image. - Description *string `min:"1" type:"string"` - - // The identifier of the new WorkSpace image. - ImageId *string `type:"string"` - - // The name of the image. - Name *string `min:"1" type:"string"` - - // The operating system that the image is running. - OperatingSystem *OperatingSystem `type:"structure"` +// SetUserEnabledAsLocalAdministrator sets the UserEnabledAsLocalAdministrator field's value. +func (s *DefaultWorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator(v bool) *DefaultWorkspaceCreationProperties { + s.UserEnabledAsLocalAdministrator = &v + return s +} - // The identifier of the Amazon Web Services account that owns the image. - OwnerAccountId *string `type:"string"` +type DeleteClientBrandingInput struct { + _ struct{} `type:"structure"` - // Specifies whether the image is running on dedicated hardware. When Bring - // Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more - // information, see Bring Your Own Windows Desktop Images. (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.htm). - RequiredTenancy *string `type:"string" enum:"WorkspaceImageRequiredTenancy"` + // The device type for which you want to delete client branding. + // + // Platforms is a required field + Platforms []*string `min:"1" type:"list" required:"true" enum:"ClientDeviceType"` - // The availability status of the image. - State *string `type:"string" enum:"WorkspaceImageState"` + // The directory identifier of the WorkSpace for which you want to delete client + // branding. + // + // ResourceId is a required field + ResourceId *string `min:"10" type:"string" required:"true"` } // String returns the string representation. @@ -8131,7 +9891,7 @@ type CreateWorkspaceImageOutput struct { // 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 CreateWorkspaceImageOutput) String() string { +func (s DeleteClientBrandingInput) String() string { return awsutil.Prettify(s) } @@ -8140,65 +9900,78 @@ func (s CreateWorkspaceImageOutput) String() string { // 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 CreateWorkspaceImageOutput) GoString() string { +func (s DeleteClientBrandingInput) GoString() string { return s.String() } -// SetCreated sets the Created field's value. -func (s *CreateWorkspaceImageOutput) SetCreated(v time.Time) *CreateWorkspaceImageOutput { - s.Created = &v - return s -} - -// SetDescription sets the Description field's value. -func (s *CreateWorkspaceImageOutput) SetDescription(v string) *CreateWorkspaceImageOutput { - s.Description = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteClientBrandingInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteClientBrandingInput"} + if s.Platforms == nil { + invalidParams.Add(request.NewErrParamRequired("Platforms")) + } + if s.Platforms != nil && len(s.Platforms) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Platforms", 1)) + } + if s.ResourceId == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceId")) + } + if s.ResourceId != nil && len(*s.ResourceId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("ResourceId", 10)) + } -// SetImageId sets the ImageId field's value. -func (s *CreateWorkspaceImageOutput) SetImageId(v string) *CreateWorkspaceImageOutput { - s.ImageId = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetName sets the Name field's value. -func (s *CreateWorkspaceImageOutput) SetName(v string) *CreateWorkspaceImageOutput { - s.Name = &v +// SetPlatforms sets the Platforms field's value. +func (s *DeleteClientBrandingInput) SetPlatforms(v []*string) *DeleteClientBrandingInput { + s.Platforms = v return s } -// SetOperatingSystem sets the OperatingSystem field's value. -func (s *CreateWorkspaceImageOutput) SetOperatingSystem(v *OperatingSystem) *CreateWorkspaceImageOutput { - s.OperatingSystem = v +// SetResourceId sets the ResourceId field's value. +func (s *DeleteClientBrandingInput) SetResourceId(v string) *DeleteClientBrandingInput { + s.ResourceId = &v return s } -// SetOwnerAccountId sets the OwnerAccountId field's value. -func (s *CreateWorkspaceImageOutput) SetOwnerAccountId(v string) *CreateWorkspaceImageOutput { - s.OwnerAccountId = &v - return s +type DeleteClientBrandingOutput struct { + _ struct{} `type:"structure"` } -// SetRequiredTenancy sets the RequiredTenancy field's value. -func (s *CreateWorkspaceImageOutput) SetRequiredTenancy(v string) *CreateWorkspaceImageOutput { - s.RequiredTenancy = &v - return s +// 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 DeleteClientBrandingOutput) String() string { + return awsutil.Prettify(s) } -// SetState sets the State field's value. -func (s *CreateWorkspaceImageOutput) SetState(v string) *CreateWorkspaceImageOutput { - s.State = &v - return 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 DeleteClientBrandingOutput) GoString() string { + return s.String() } -type CreateWorkspacesInput struct { +type DeleteConnectClientAddInInput struct { _ struct{} `type:"structure"` - // The WorkSpaces to create. You can specify up to 25 WorkSpaces. + // The identifier of the client add-in to delete. // - // Workspaces is a required field - Workspaces []*WorkspaceRequest `min:"1" type:"list" required:"true"` + // AddInId is a required field + AddInId *string `min:"36" type:"string" required:"true"` + + // The directory identifier for which the client add-in is configured. + // + // ResourceId is a required field + ResourceId *string `min:"10" type:"string" required:"true"` } // String returns the string representation. @@ -8206,7 +9979,7 @@ type CreateWorkspacesInput struct { // 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 CreateWorkspacesInput) String() string { +func (s DeleteConnectClientAddInInput) String() string { return awsutil.Prettify(s) } @@ -8215,28 +9988,24 @@ func (s CreateWorkspacesInput) String() string { // 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 CreateWorkspacesInput) GoString() string { +func (s DeleteConnectClientAddInInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateWorkspacesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateWorkspacesInput"} - if s.Workspaces == nil { - invalidParams.Add(request.NewErrParamRequired("Workspaces")) +func (s *DeleteConnectClientAddInInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteConnectClientAddInInput"} + if s.AddInId == nil { + invalidParams.Add(request.NewErrParamRequired("AddInId")) } - if s.Workspaces != nil && len(s.Workspaces) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Workspaces", 1)) + if s.AddInId != nil && len(*s.AddInId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AddInId", 36)) } - if s.Workspaces != nil { - for i, v := range s.Workspaces { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Workspaces", i), err.(request.ErrInvalidParams)) - } - } + if s.ResourceId == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceId")) + } + if s.ResourceId != nil && len(*s.ResourceId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("ResourceId", 10)) } if invalidParams.Len() > 0 { @@ -8245,24 +10014,20 @@ func (s *CreateWorkspacesInput) Validate() error { return nil } -// SetWorkspaces sets the Workspaces field's value. -func (s *CreateWorkspacesInput) SetWorkspaces(v []*WorkspaceRequest) *CreateWorkspacesInput { - s.Workspaces = v +// SetAddInId sets the AddInId field's value. +func (s *DeleteConnectClientAddInInput) SetAddInId(v string) *DeleteConnectClientAddInInput { + s.AddInId = &v return s } -type CreateWorkspacesOutput struct { - _ struct{} `type:"structure"` - - // Information about the WorkSpaces that could not be created. - FailedRequests []*FailedCreateWorkspaceRequest `type:"list"` +// SetResourceId sets the ResourceId field's value. +func (s *DeleteConnectClientAddInInput) SetResourceId(v string) *DeleteConnectClientAddInInput { + s.ResourceId = &v + return s +} - // Information about the WorkSpaces that were created. - // - // Because this operation is asynchronous, the identifier returned is not immediately - // available for use with other operations. For example, if you call DescribeWorkspaces - // before the WorkSpace is created, the information returned can be incomplete. - PendingRequests []*Workspace `type:"list"` +type DeleteConnectClientAddInOutput struct { + _ struct{} `type:"structure"` } // String returns the string representation. @@ -8270,7 +10035,7 @@ type CreateWorkspacesOutput struct { // 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 CreateWorkspacesOutput) String() string { +func (s DeleteConnectClientAddInOutput) String() string { return awsutil.Prettify(s) } @@ -8279,63 +10044,61 @@ func (s CreateWorkspacesOutput) String() string { // 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 CreateWorkspacesOutput) GoString() string { +func (s DeleteConnectClientAddInOutput) GoString() string { return s.String() } -// SetFailedRequests sets the FailedRequests field's value. -func (s *CreateWorkspacesOutput) SetFailedRequests(v []*FailedCreateWorkspaceRequest) *CreateWorkspacesOutput { - s.FailedRequests = v - return s -} +type DeleteConnectionAliasInput struct { + _ struct{} `type:"structure"` -// SetPendingRequests sets the PendingRequests field's value. -func (s *CreateWorkspacesOutput) SetPendingRequests(v []*Workspace) *CreateWorkspacesOutput { - s.PendingRequests = v - return s + // The identifier of the connection alias to delete. + // + // AliasId is a required field + AliasId *string `min:"13" type:"string" required:"true"` } -// Returns default client branding attributes that were imported. These attributes -// display on the client login screen. +// String returns the string representation. // -// Client branding attributes are public facing. Ensure that you don't include -// sensitive information. -type DefaultClientBrandingAttributes struct { - _ struct{} `type:"structure"` - - // The forgotten password link. This is the web address that users can go to - // if they forget the password for their WorkSpace. - ForgotPasswordLink *string `min:"1" type:"string"` - - // The login message. Specified as a key value pair, in which the key is a locale - // and the value is the localized message for that locale. The only key supported - // is en_US. The HTML tags supported include the following: a, b, blockquote, - // br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, - // strong, sub, sup, u, ul. - LoginMessage map[string]*string `type:"map"` +// 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 DeleteConnectionAliasInput) String() string { + return awsutil.Prettify(s) +} - // The logo. The only image format accepted is a binary data object that is - // converted from a .png file. - LogoUrl *string `min:"1" type:"string"` +// 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 DeleteConnectionAliasInput) GoString() string { + return s.String() +} - // The support email. The company's customer support email address. - // - // * In each platform type, the SupportEmail and SupportLink parameters are - // mutually exclusive. You can specify one parameter for each platform type, - // but not both. - // - // * The default email is workspaces-feedback@amazon.com. - SupportEmail *string `min:"6" type:"string"` +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteConnectionAliasInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteConnectionAliasInput"} + if s.AliasId == nil { + invalidParams.Add(request.NewErrParamRequired("AliasId")) + } + if s.AliasId != nil && len(*s.AliasId) < 13 { + invalidParams.Add(request.NewErrParamMinLen("AliasId", 13)) + } - // The support link. The link for the company's customer support page for their - // WorkSpace. - // - // * In each platform type, the SupportEmail and SupportLink parameters are - // mutually exclusive.You can specify one parameter for each platform type, - // but not both. - // - // * The default support link is workspaces-feedback@amazon.com. - SupportLink *string `min:"1" type:"string"` + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAliasId sets the AliasId field's value. +func (s *DeleteConnectionAliasInput) SetAliasId(v string) *DeleteConnectionAliasInput { + s.AliasId = &v + return s +} + +type DeleteConnectionAliasOutput struct { + _ struct{} `type:"structure"` } // String returns the string representation. @@ -8343,7 +10106,7 @@ type DefaultClientBrandingAttributes struct { // 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 DefaultClientBrandingAttributes) String() string { +func (s DeleteConnectionAliasOutput) String() string { return awsutil.Prettify(s) } @@ -8352,82 +10115,17 @@ func (s DefaultClientBrandingAttributes) String() string { // 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 DefaultClientBrandingAttributes) GoString() string { +func (s DeleteConnectionAliasOutput) GoString() string { return s.String() } -// SetForgotPasswordLink sets the ForgotPasswordLink field's value. -func (s *DefaultClientBrandingAttributes) SetForgotPasswordLink(v string) *DefaultClientBrandingAttributes { - s.ForgotPasswordLink = &v - return s -} - -// SetLoginMessage sets the LoginMessage field's value. -func (s *DefaultClientBrandingAttributes) SetLoginMessage(v map[string]*string) *DefaultClientBrandingAttributes { - s.LoginMessage = v - return s -} - -// SetLogoUrl sets the LogoUrl field's value. -func (s *DefaultClientBrandingAttributes) SetLogoUrl(v string) *DefaultClientBrandingAttributes { - s.LogoUrl = &v - return s -} - -// SetSupportEmail sets the SupportEmail field's value. -func (s *DefaultClientBrandingAttributes) SetSupportEmail(v string) *DefaultClientBrandingAttributes { - s.SupportEmail = &v - return s -} - -// SetSupportLink sets the SupportLink field's value. -func (s *DefaultClientBrandingAttributes) SetSupportLink(v string) *DefaultClientBrandingAttributes { - s.SupportLink = &v - return s -} - -// The default client branding attributes to be imported. These attributes display -// on the client login screen. -// -// Client branding attributes are public facing. Ensure that you do not include -// sensitive information. -type DefaultImportClientBrandingAttributes struct { +type DeleteIpGroupInput struct { _ struct{} `type:"structure"` - // The forgotten password link. This is the web address that users can go to - // if they forget the password for their WorkSpace. - ForgotPasswordLink *string `min:"1" type:"string"` - - // The login message. Specified as a key value pair, in which the key is a locale - // and the value is the localized message for that locale. The only key supported - // is en_US. The HTML tags supported include the following: a, b, blockquote, - // br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, - // strong, sub, sup, u, ul. - LoginMessage map[string]*string `type:"map"` - - // The logo. The only image format accepted is a binary data object that is - // converted from a .png file. - // Logo is automatically base64 encoded/decoded by the SDK. - Logo []byte `min:"1" type:"blob"` - - // The support email. The company's customer support email address. - // - // * In each platform type, the SupportEmail and SupportLink parameters are - // mutually exclusive. You can specify one parameter for each platform type, - // but not both. - // - // * The default email is workspaces-feedback@amazon.com. - SupportEmail *string `min:"6" type:"string"` - - // The support link. The link for the company's customer support page for their - // WorkSpace. - // - // * In each platform type, the SupportEmail and SupportLink parameters are - // mutually exclusive. You can specify one parameter for each platform type, - // but not both. + // The identifier of the IP access control group. // - // * The default support link is workspaces-feedback@amazon.com. - SupportLink *string `min:"1" type:"string"` + // GroupId is a required field + GroupId *string `type:"string" required:"true"` } // String returns the string representation. @@ -8435,7 +10133,7 @@ type DefaultImportClientBrandingAttributes struct { // 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 DefaultImportClientBrandingAttributes) String() string { +func (s DeleteIpGroupInput) String() string { return awsutil.Prettify(s) } @@ -8444,24 +10142,15 @@ func (s DefaultImportClientBrandingAttributes) String() string { // 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 DefaultImportClientBrandingAttributes) GoString() string { +func (s DeleteIpGroupInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DefaultImportClientBrandingAttributes) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DefaultImportClientBrandingAttributes"} - if s.ForgotPasswordLink != nil && len(*s.ForgotPasswordLink) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ForgotPasswordLink", 1)) - } - if s.Logo != nil && len(s.Logo) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Logo", 1)) - } - if s.SupportEmail != nil && len(*s.SupportEmail) < 6 { - invalidParams.Add(request.NewErrParamMinLen("SupportEmail", 6)) - } - if s.SupportLink != nil && len(*s.SupportLink) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SupportLink", 1)) +func (s *DeleteIpGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteIpGroupInput"} + if s.GroupId == nil { + invalidParams.Add(request.NewErrParamRequired("GroupId")) } if invalidParams.Len() > 0 { @@ -8470,70 +10159,48 @@ func (s *DefaultImportClientBrandingAttributes) Validate() error { return nil } -// SetForgotPasswordLink sets the ForgotPasswordLink field's value. -func (s *DefaultImportClientBrandingAttributes) SetForgotPasswordLink(v string) *DefaultImportClientBrandingAttributes { - s.ForgotPasswordLink = &v - return s -} - -// SetLoginMessage sets the LoginMessage field's value. -func (s *DefaultImportClientBrandingAttributes) SetLoginMessage(v map[string]*string) *DefaultImportClientBrandingAttributes { - s.LoginMessage = v +// SetGroupId sets the GroupId field's value. +func (s *DeleteIpGroupInput) SetGroupId(v string) *DeleteIpGroupInput { + s.GroupId = &v return s } -// SetLogo sets the Logo field's value. -func (s *DefaultImportClientBrandingAttributes) SetLogo(v []byte) *DefaultImportClientBrandingAttributes { - s.Logo = v - return s +type DeleteIpGroupOutput struct { + _ struct{} `type:"structure"` } -// SetSupportEmail sets the SupportEmail field's value. -func (s *DefaultImportClientBrandingAttributes) SetSupportEmail(v string) *DefaultImportClientBrandingAttributes { - s.SupportEmail = &v - return s +// 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 DeleteIpGroupOutput) String() string { + return awsutil.Prettify(s) } -// SetSupportLink sets the SupportLink field's value. -func (s *DefaultImportClientBrandingAttributes) SetSupportLink(v string) *DefaultImportClientBrandingAttributes { - s.SupportLink = &v - return 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 DeleteIpGroupOutput) GoString() string { + return s.String() } -// Describes the default values that are used to create WorkSpaces. For more -// information, see Update Directory Details for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html). -type DefaultWorkspaceCreationProperties struct { +type DeleteTagsInput struct { _ struct{} `type:"structure"` - // The identifier of the default security group to apply to WorkSpaces when - // they are created. For more information, see Security Groups for Your WorkSpaces - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html). - CustomSecurityGroupId *string `min:"11" type:"string"` - - // The organizational unit (OU) in the directory for the WorkSpace machine accounts. - DefaultOu *string `type:"string"` - - // Specifies whether to automatically assign an Elastic public IP address to - // WorkSpaces in this directory by default. If enabled, the Elastic public IP - // address allows outbound internet access from your WorkSpaces when you’re - // using an internet gateway in the Amazon VPC in which your WorkSpaces are - // located. If you're using a Network Address Translation (NAT) gateway for - // outbound internet access from your VPC, or if your WorkSpaces are in public - // subnets and you manually assign them Elastic IP addresses, you should disable - // this setting. This setting applies to new WorkSpaces that you launch or to - // existing WorkSpaces that you rebuild. For more information, see Configure - // a VPC for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html). - EnableInternetAccess *bool `type:"boolean"` - - // Specifies whether maintenance mode is enabled for WorkSpaces. For more information, - // see WorkSpace Maintenance (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html). - EnableMaintenanceMode *bool `type:"boolean"` - - // Specifies whether the directory is enabled for Amazon WorkDocs. - EnableWorkDocs *bool `type:"boolean"` + // The identifier of the WorkSpaces resource. The supported resource types are + // WorkSpaces, registered directories, images, custom bundles, IP access control + // groups, and connection aliases. + // + // ResourceId is a required field + ResourceId *string `min:"1" type:"string" required:"true"` - // Specifies whether WorkSpace users are local administrators on their WorkSpaces. - UserEnabledAsLocalAdministrator *bool `type:"boolean"` + // The tag keys. + // + // TagKeys is a required field + TagKeys []*string `type:"list" required:"true"` } // String returns the string representation. @@ -8541,7 +10208,7 @@ type DefaultWorkspaceCreationProperties struct { // 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 DefaultWorkspaceCreationProperties) String() string { +func (s DeleteTagsInput) String() string { return awsutil.Prettify(s) } @@ -8550,59 +10217,68 @@ func (s DefaultWorkspaceCreationProperties) String() string { // 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 DefaultWorkspaceCreationProperties) GoString() string { +func (s DeleteTagsInput) GoString() string { return s.String() } -// SetCustomSecurityGroupId sets the CustomSecurityGroupId field's value. -func (s *DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId(v string) *DefaultWorkspaceCreationProperties { - s.CustomSecurityGroupId = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteTagsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteTagsInput"} + if s.ResourceId == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceId")) + } + if s.ResourceId != nil && len(*s.ResourceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDefaultOu sets the DefaultOu field's value. -func (s *DefaultWorkspaceCreationProperties) SetDefaultOu(v string) *DefaultWorkspaceCreationProperties { - s.DefaultOu = &v +// SetResourceId sets the ResourceId field's value. +func (s *DeleteTagsInput) SetResourceId(v string) *DeleteTagsInput { + s.ResourceId = &v return s } -// SetEnableInternetAccess sets the EnableInternetAccess field's value. -func (s *DefaultWorkspaceCreationProperties) SetEnableInternetAccess(v bool) *DefaultWorkspaceCreationProperties { - s.EnableInternetAccess = &v +// SetTagKeys sets the TagKeys field's value. +func (s *DeleteTagsInput) SetTagKeys(v []*string) *DeleteTagsInput { + s.TagKeys = v return s } -// SetEnableMaintenanceMode sets the EnableMaintenanceMode field's value. -func (s *DefaultWorkspaceCreationProperties) SetEnableMaintenanceMode(v bool) *DefaultWorkspaceCreationProperties { - s.EnableMaintenanceMode = &v - return s +type DeleteTagsOutput struct { + _ struct{} `type:"structure"` } -// SetEnableWorkDocs sets the EnableWorkDocs field's value. -func (s *DefaultWorkspaceCreationProperties) SetEnableWorkDocs(v bool) *DefaultWorkspaceCreationProperties { - s.EnableWorkDocs = &v - return s +// 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 DeleteTagsOutput) String() string { + return awsutil.Prettify(s) } -// SetUserEnabledAsLocalAdministrator sets the UserEnabledAsLocalAdministrator field's value. -func (s *DefaultWorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator(v bool) *DefaultWorkspaceCreationProperties { - s.UserEnabledAsLocalAdministrator = &v - return 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 DeleteTagsOutput) GoString() string { + return s.String() } -type DeleteClientBrandingInput struct { +type DeleteWorkspaceBundleInput struct { _ struct{} `type:"structure"` - // The device type for which you want to delete client branding. - // - // Platforms is a required field - Platforms []*string `min:"1" type:"list" required:"true" enum:"ClientDeviceType"` - - // The directory identifier of the WorkSpace for which you want to delete client - // branding. - // - // ResourceId is a required field - ResourceId *string `min:"10" type:"string" required:"true"` + // The identifier of the bundle. + BundleId *string `type:"string"` } // String returns the string representation. @@ -8610,7 +10286,7 @@ type DeleteClientBrandingInput struct { // 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 DeleteClientBrandingInput) String() string { +func (s DeleteWorkspaceBundleInput) String() string { return awsutil.Prettify(s) } @@ -8619,45 +10295,17 @@ func (s DeleteClientBrandingInput) String() string { // 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 DeleteClientBrandingInput) GoString() string { +func (s DeleteWorkspaceBundleInput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteClientBrandingInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteClientBrandingInput"} - if s.Platforms == nil { - invalidParams.Add(request.NewErrParamRequired("Platforms")) - } - if s.Platforms != nil && len(s.Platforms) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Platforms", 1)) - } - if s.ResourceId == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceId")) - } - if s.ResourceId != nil && len(*s.ResourceId) < 10 { - invalidParams.Add(request.NewErrParamMinLen("ResourceId", 10)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetPlatforms sets the Platforms field's value. -func (s *DeleteClientBrandingInput) SetPlatforms(v []*string) *DeleteClientBrandingInput { - s.Platforms = v - return s -} - -// SetResourceId sets the ResourceId field's value. -func (s *DeleteClientBrandingInput) SetResourceId(v string) *DeleteClientBrandingInput { - s.ResourceId = &v +// SetBundleId sets the BundleId field's value. +func (s *DeleteWorkspaceBundleInput) SetBundleId(v string) *DeleteWorkspaceBundleInput { + s.BundleId = &v return s } -type DeleteClientBrandingOutput struct { +type DeleteWorkspaceBundleOutput struct { _ struct{} `type:"structure"` } @@ -8666,7 +10314,7 @@ type DeleteClientBrandingOutput struct { // 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 DeleteClientBrandingOutput) String() string { +func (s DeleteWorkspaceBundleOutput) String() string { return awsutil.Prettify(s) } @@ -8675,22 +10323,17 @@ func (s DeleteClientBrandingOutput) String() string { // 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 DeleteClientBrandingOutput) GoString() string { +func (s DeleteWorkspaceBundleOutput) GoString() string { return s.String() } -type DeleteConnectClientAddInInput struct { +type DeleteWorkspaceImageInput struct { _ struct{} `type:"structure"` - // The identifier of the client add-in to delete. - // - // AddInId is a required field - AddInId *string `min:"36" type:"string" required:"true"` - - // The directory identifier for which the client add-in is configured. + // The identifier of the image. // - // ResourceId is a required field - ResourceId *string `min:"10" type:"string" required:"true"` + // ImageId is a required field + ImageId *string `type:"string" required:"true"` } // String returns the string representation. @@ -8698,7 +10341,7 @@ type DeleteConnectClientAddInInput struct { // 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 DeleteConnectClientAddInInput) String() string { +func (s DeleteWorkspaceImageInput) String() string { return awsutil.Prettify(s) } @@ -8707,24 +10350,15 @@ func (s DeleteConnectClientAddInInput) String() string { // 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 DeleteConnectClientAddInInput) GoString() string { +func (s DeleteWorkspaceImageInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteConnectClientAddInInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteConnectClientAddInInput"} - if s.AddInId == nil { - invalidParams.Add(request.NewErrParamRequired("AddInId")) - } - if s.AddInId != nil && len(*s.AddInId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("AddInId", 36)) - } - if s.ResourceId == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceId")) - } - if s.ResourceId != nil && len(*s.ResourceId) < 10 { - invalidParams.Add(request.NewErrParamMinLen("ResourceId", 10)) +func (s *DeleteWorkspaceImageInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteWorkspaceImageInput"} + if s.ImageId == nil { + invalidParams.Add(request.NewErrParamRequired("ImageId")) } if invalidParams.Len() > 0 { @@ -8733,19 +10367,13 @@ func (s *DeleteConnectClientAddInInput) Validate() error { return nil } -// SetAddInId sets the AddInId field's value. -func (s *DeleteConnectClientAddInInput) SetAddInId(v string) *DeleteConnectClientAddInInput { - s.AddInId = &v - return s -} - -// SetResourceId sets the ResourceId field's value. -func (s *DeleteConnectClientAddInInput) SetResourceId(v string) *DeleteConnectClientAddInInput { - s.ResourceId = &v +// SetImageId sets the ImageId field's value. +func (s *DeleteWorkspaceImageInput) SetImageId(v string) *DeleteWorkspaceImageInput { + s.ImageId = &v return s } -type DeleteConnectClientAddInOutput struct { +type DeleteWorkspaceImageOutput struct { _ struct{} `type:"structure"` } @@ -8754,7 +10382,7 @@ type DeleteConnectClientAddInOutput struct { // 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 DeleteConnectClientAddInOutput) String() string { +func (s DeleteWorkspaceImageOutput) String() string { return awsutil.Prettify(s) } @@ -8763,17 +10391,22 @@ func (s DeleteConnectClientAddInOutput) String() string { // 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 DeleteConnectClientAddInOutput) GoString() string { +func (s DeleteWorkspaceImageOutput) GoString() string { return s.String() } -type DeleteConnectionAliasInput struct { +type DeployWorkspaceApplicationsInput struct { _ struct{} `type:"structure"` - // The identifier of the connection alias to delete. + // Indicates whether the force flag is applied for the specified WorkSpace. + // When the force flag is enabled, it allows previously failed deployments to + // be retried. + Force *bool `type:"boolean"` + + // The identifier of the WorkSpace. // - // AliasId is a required field - AliasId *string `min:"13" type:"string" required:"true"` + // WorkspaceId is a required field + WorkspaceId *string `type:"string" required:"true"` } // String returns the string representation. @@ -8781,7 +10414,7 @@ type DeleteConnectionAliasInput struct { // 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 DeleteConnectionAliasInput) String() string { +func (s DeployWorkspaceApplicationsInput) String() string { return awsutil.Prettify(s) } @@ -8790,18 +10423,15 @@ func (s DeleteConnectionAliasInput) String() string { // 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 DeleteConnectionAliasInput) GoString() string { +func (s DeployWorkspaceApplicationsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteConnectionAliasInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteConnectionAliasInput"} - if s.AliasId == nil { - invalidParams.Add(request.NewErrParamRequired("AliasId")) - } - if s.AliasId != nil && len(*s.AliasId) < 13 { - invalidParams.Add(request.NewErrParamMinLen("AliasId", 13)) +func (s *DeployWorkspaceApplicationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeployWorkspaceApplicationsInput"} + if s.WorkspaceId == nil { + invalidParams.Add(request.NewErrParamRequired("WorkspaceId")) } if invalidParams.Len() > 0 { @@ -8810,14 +10440,23 @@ func (s *DeleteConnectionAliasInput) Validate() error { return nil } -// SetAliasId sets the AliasId field's value. -func (s *DeleteConnectionAliasInput) SetAliasId(v string) *DeleteConnectionAliasInput { - s.AliasId = &v +// SetForce sets the Force field's value. +func (s *DeployWorkspaceApplicationsInput) SetForce(v bool) *DeployWorkspaceApplicationsInput { + s.Force = &v return s } -type DeleteConnectionAliasOutput struct { +// SetWorkspaceId sets the WorkspaceId field's value. +func (s *DeployWorkspaceApplicationsInput) SetWorkspaceId(v string) *DeployWorkspaceApplicationsInput { + s.WorkspaceId = &v + return s +} + +type DeployWorkspaceApplicationsOutput struct { _ struct{} `type:"structure"` + + // The list of deployed associations and information about them. + Deployment *WorkSpaceApplicationDeployment `type:"structure"` } // String returns the string representation. @@ -8825,7 +10464,7 @@ type DeleteConnectionAliasOutput struct { // 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 DeleteConnectionAliasOutput) String() string { +func (s DeployWorkspaceApplicationsOutput) String() string { return awsutil.Prettify(s) } @@ -8834,17 +10473,25 @@ func (s DeleteConnectionAliasOutput) String() string { // 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 DeleteConnectionAliasOutput) GoString() string { +func (s DeployWorkspaceApplicationsOutput) GoString() string { return s.String() } -type DeleteIpGroupInput struct { +// SetDeployment sets the Deployment field's value. +func (s *DeployWorkspaceApplicationsOutput) SetDeployment(v *WorkSpaceApplicationDeployment) *DeployWorkspaceApplicationsOutput { + s.Deployment = v + return s +} + +type DeregisterWorkspaceDirectoryInput struct { _ struct{} `type:"structure"` - // The identifier of the IP access control group. + // The identifier of the directory. If any WorkSpaces are registered to this + // directory, you must remove them before you deregister the directory, or you + // will receive an OperationNotSupportedException error. // - // GroupId is a required field - GroupId *string `type:"string" required:"true"` + // DirectoryId is a required field + DirectoryId *string `min:"10" type:"string" required:"true"` } // String returns the string representation. @@ -8852,7 +10499,7 @@ type DeleteIpGroupInput struct { // 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 DeleteIpGroupInput) String() string { +func (s DeregisterWorkspaceDirectoryInput) String() string { return awsutil.Prettify(s) } @@ -8861,15 +10508,18 @@ func (s DeleteIpGroupInput) String() string { // 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 DeleteIpGroupInput) GoString() string { +func (s DeregisterWorkspaceDirectoryInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteIpGroupInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteIpGroupInput"} - if s.GroupId == nil { - invalidParams.Add(request.NewErrParamRequired("GroupId")) +func (s *DeregisterWorkspaceDirectoryInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeregisterWorkspaceDirectoryInput"} + if s.DirectoryId == nil { + invalidParams.Add(request.NewErrParamRequired("DirectoryId")) + } + if s.DirectoryId != nil && len(*s.DirectoryId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("DirectoryId", 10)) } if invalidParams.Len() > 0 { @@ -8878,13 +10528,13 @@ func (s *DeleteIpGroupInput) Validate() error { return nil } -// SetGroupId sets the GroupId field's value. -func (s *DeleteIpGroupInput) SetGroupId(v string) *DeleteIpGroupInput { - s.GroupId = &v +// SetDirectoryId sets the DirectoryId field's value. +func (s *DeregisterWorkspaceDirectoryInput) SetDirectoryId(v string) *DeregisterWorkspaceDirectoryInput { + s.DirectoryId = &v return s } -type DeleteIpGroupOutput struct { +type DeregisterWorkspaceDirectoryOutput struct { _ struct{} `type:"structure"` } @@ -8893,7 +10543,7 @@ type DeleteIpGroupOutput struct { // 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 DeleteIpGroupOutput) String() string { +func (s DeregisterWorkspaceDirectoryOutput) String() string { return awsutil.Prettify(s) } @@ -8902,24 +10552,12 @@ func (s DeleteIpGroupOutput) String() string { // 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 DeleteIpGroupOutput) GoString() string { +func (s DeregisterWorkspaceDirectoryOutput) GoString() string { return s.String() } -type DeleteTagsInput struct { +type DescribeAccountInput struct { _ struct{} `type:"structure"` - - // The identifier of the WorkSpaces resource. The supported resource types are - // WorkSpaces, registered directories, images, custom bundles, IP access control - // groups, and connection aliases. - // - // ResourceId is a required field - ResourceId *string `min:"1" type:"string" required:"true"` - - // The tag keys. - // - // TagKeys is a required field - TagKeys []*string `type:"list" required:"true"` } // String returns the string representation. @@ -8927,7 +10565,7 @@ type DeleteTagsInput struct { // 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 DeleteTagsInput) String() string { +func (s DescribeAccountInput) String() string { return awsutil.Prettify(s) } @@ -8936,43 +10574,16 @@ func (s DeleteTagsInput) String() string { // 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 DeleteTagsInput) GoString() string { +func (s DescribeAccountInput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteTagsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteTagsInput"} - if s.ResourceId == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceId")) - } - if s.ResourceId != nil && len(*s.ResourceId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1)) - } - if s.TagKeys == nil { - invalidParams.Add(request.NewErrParamRequired("TagKeys")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetResourceId sets the ResourceId field's value. -func (s *DeleteTagsInput) SetResourceId(v string) *DeleteTagsInput { - s.ResourceId = &v - return s -} - -// SetTagKeys sets the TagKeys field's value. -func (s *DeleteTagsInput) SetTagKeys(v []*string) *DeleteTagsInput { - s.TagKeys = v - return s -} - -type DeleteTagsOutput struct { +type DescribeAccountModificationsInput struct { _ struct{} `type:"structure"` + + // If you received a NextToken from a previous call that was paginated, provide + // this token to receive the next set of results. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -8980,24 +10591,47 @@ type DeleteTagsOutput struct { // 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 DeleteTagsOutput) String() string { +func (s DescribeAccountModificationsInput) 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 DeleteTagsOutput) GoString() string { - return s.String() +// 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 DescribeAccountModificationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeAccountModificationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAccountModificationsInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeAccountModificationsInput) SetNextToken(v string) *DescribeAccountModificationsInput { + s.NextToken = &v + return s } -type DeleteWorkspaceBundleInput struct { +type DescribeAccountModificationsOutput struct { _ struct{} `type:"structure"` - // The identifier of the bundle. - BundleId *string `type:"string"` + // The list of modifications to the configuration of BYOL. + AccountModifications []*AccountModification `type:"list"` + + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -9005,7 +10639,7 @@ type DeleteWorkspaceBundleInput struct { // 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 DeleteWorkspaceBundleInput) String() string { +func (s DescribeAccountModificationsOutput) String() string { return awsutil.Prettify(s) } @@ -9014,18 +10648,36 @@ func (s DeleteWorkspaceBundleInput) String() string { // 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 DeleteWorkspaceBundleInput) GoString() string { +func (s DescribeAccountModificationsOutput) GoString() string { return s.String() } -// SetBundleId sets the BundleId field's value. -func (s *DeleteWorkspaceBundleInput) SetBundleId(v string) *DeleteWorkspaceBundleInput { - s.BundleId = &v +// SetAccountModifications sets the AccountModifications field's value. +func (s *DescribeAccountModificationsOutput) SetAccountModifications(v []*AccountModification) *DescribeAccountModificationsOutput { + s.AccountModifications = v return s } -type DeleteWorkspaceBundleOutput struct { +// SetNextToken sets the NextToken field's value. +func (s *DescribeAccountModificationsOutput) SetNextToken(v string) *DescribeAccountModificationsOutput { + s.NextToken = &v + return s +} + +type DescribeAccountOutput struct { _ struct{} `type:"structure"` + + // The IP address range, specified as an IPv4 CIDR block, used for the management + // network interface. + // + // The management network interface is connected to a secure Amazon WorkSpaces + // management network. It is used for interactive streaming of the WorkSpace + // desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage + // the WorkSpace. + DedicatedTenancyManagementCidrRange *string `type:"string"` + + // The status of BYOL (whether BYOL is enabled or disabled). + DedicatedTenancySupport *string `type:"string" enum:"DedicatedTenancySupportResultEnum"` } // String returns the string representation. @@ -9033,7 +10685,7 @@ type DeleteWorkspaceBundleOutput struct { // 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 DeleteWorkspaceBundleOutput) String() string { +func (s DescribeAccountOutput) String() string { return awsutil.Prettify(s) } @@ -9042,17 +10694,41 @@ func (s DeleteWorkspaceBundleOutput) String() string { // 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 DeleteWorkspaceBundleOutput) GoString() string { +func (s DescribeAccountOutput) GoString() string { return s.String() } -type DeleteWorkspaceImageInput struct { +// SetDedicatedTenancyManagementCidrRange sets the DedicatedTenancyManagementCidrRange field's value. +func (s *DescribeAccountOutput) SetDedicatedTenancyManagementCidrRange(v string) *DescribeAccountOutput { + s.DedicatedTenancyManagementCidrRange = &v + return s +} + +// SetDedicatedTenancySupport sets the DedicatedTenancySupport field's value. +func (s *DescribeAccountOutput) SetDedicatedTenancySupport(v string) *DescribeAccountOutput { + s.DedicatedTenancySupport = &v + return s +} + +type DescribeApplicationAssociationsInput struct { _ struct{} `type:"structure"` - // The identifier of the image. + // The identifier of the specified application. // - // ImageId is a required field - ImageId *string `type:"string" required:"true"` + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` + + // The resource type of the associated resources. + // + // AssociatedResourceTypes is a required field + AssociatedResourceTypes []*string `type:"list" required:"true" enum:"ApplicationAssociatedResourceType"` + + // The maximum number of associations to return. + MaxResults *int64 `min:"1" type:"integer"` + + // If you received a NextToken from a previous call that was paginated, provide + // this token to receive the next set of results. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -9060,7 +10736,7 @@ type DeleteWorkspaceImageInput struct { // 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 DeleteWorkspaceImageInput) String() string { +func (s DescribeApplicationAssociationsInput) String() string { return awsutil.Prettify(s) } @@ -9069,15 +10745,24 @@ func (s DeleteWorkspaceImageInput) String() string { // 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 DeleteWorkspaceImageInput) GoString() string { +func (s DescribeApplicationAssociationsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteWorkspaceImageInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteWorkspaceImageInput"} - if s.ImageId == nil { - invalidParams.Add(request.NewErrParamRequired("ImageId")) +func (s *DescribeApplicationAssociationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeApplicationAssociationsInput"} + if s.ApplicationId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationId")) + } + if s.AssociatedResourceTypes == nil { + invalidParams.Add(request.NewErrParamRequired("AssociatedResourceTypes")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } if invalidParams.Len() > 0 { @@ -9086,14 +10771,39 @@ func (s *DeleteWorkspaceImageInput) Validate() error { return nil } -// SetImageId sets the ImageId field's value. -func (s *DeleteWorkspaceImageInput) SetImageId(v string) *DeleteWorkspaceImageInput { - s.ImageId = &v +// SetApplicationId sets the ApplicationId field's value. +func (s *DescribeApplicationAssociationsInput) SetApplicationId(v string) *DescribeApplicationAssociationsInput { + s.ApplicationId = &v return s } -type DeleteWorkspaceImageOutput struct { +// SetAssociatedResourceTypes sets the AssociatedResourceTypes field's value. +func (s *DescribeApplicationAssociationsInput) SetAssociatedResourceTypes(v []*string) *DescribeApplicationAssociationsInput { + s.AssociatedResourceTypes = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *DescribeApplicationAssociationsInput) SetMaxResults(v int64) *DescribeApplicationAssociationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeApplicationAssociationsInput) SetNextToken(v string) *DescribeApplicationAssociationsInput { + s.NextToken = &v + return s +} + +type DescribeApplicationAssociationsOutput struct { _ struct{} `type:"structure"` + + // List of associations and information about them. + Associations []*ApplicationResourceAssociation `type:"list"` + + // If you received a NextToken from a previous call that was paginated, provide + // this token to receive the next set of results. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -9101,7 +10811,7 @@ type DeleteWorkspaceImageOutput struct { // 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 DeleteWorkspaceImageOutput) String() string { +func (s DescribeApplicationAssociationsOutput) String() string { return awsutil.Prettify(s) } @@ -9110,19 +10820,46 @@ func (s DeleteWorkspaceImageOutput) String() string { // 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 DeleteWorkspaceImageOutput) GoString() string { +func (s DescribeApplicationAssociationsOutput) GoString() string { return s.String() } -type DeregisterWorkspaceDirectoryInput struct { +// SetAssociations sets the Associations field's value. +func (s *DescribeApplicationAssociationsOutput) SetAssociations(v []*ApplicationResourceAssociation) *DescribeApplicationAssociationsOutput { + s.Associations = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *DescribeApplicationAssociationsOutput) SetNextToken(v string) *DescribeApplicationAssociationsOutput { + s.NextToken = &v + return s +} + +type DescribeApplicationsInput struct { _ struct{} `type:"structure"` - // The identifier of the directory. If any WorkSpaces are registered to this - // directory, you must remove them before you deregister the directory, or you - // will receive an OperationNotSupportedException error. - // - // DirectoryId is a required field - DirectoryId *string `min:"10" type:"string" required:"true"` + // The identifiers of one or more applications. + ApplicationIds []*string `min:"1" type:"list"` + + // The compute types supported by the applications. + ComputeTypeNames []*string `type:"list" enum:"Compute"` + + // The license availability for the applications. + LicenseType *string `type:"string" enum:"WorkSpaceApplicationLicenseType"` + + // The maximum number of applications to return. + MaxResults *int64 `min:"1" type:"integer"` + + // If you received a NextToken from a previous call that was paginated, provide + // this token to receive the next set of results. + NextToken *string `min:"1" type:"string"` + + // The operating systems supported by the applications. + OperatingSystemNames []*string `type:"list" enum:"OperatingSystemName"` + + // The owner of the applications. + Owner *string `type:"string"` } // String returns the string representation. @@ -9130,7 +10867,7 @@ type DeregisterWorkspaceDirectoryInput struct { // 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 DeregisterWorkspaceDirectoryInput) String() string { +func (s DescribeApplicationsInput) String() string { return awsutil.Prettify(s) } @@ -9139,18 +10876,21 @@ func (s DeregisterWorkspaceDirectoryInput) String() string { // 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 DeregisterWorkspaceDirectoryInput) GoString() string { +func (s DescribeApplicationsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeregisterWorkspaceDirectoryInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeregisterWorkspaceDirectoryInput"} - if s.DirectoryId == nil { - invalidParams.Add(request.NewErrParamRequired("DirectoryId")) +func (s *DescribeApplicationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeApplicationsInput"} + if s.ApplicationIds != nil && len(s.ApplicationIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIds", 1)) } - if s.DirectoryId != nil && len(*s.DirectoryId) < 10 { - invalidParams.Add(request.NewErrParamMinLen("DirectoryId", 10)) + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } if invalidParams.Len() > 0 { @@ -9159,59 +10899,54 @@ func (s *DeregisterWorkspaceDirectoryInput) Validate() error { return nil } -// SetDirectoryId sets the DirectoryId field's value. -func (s *DeregisterWorkspaceDirectoryInput) SetDirectoryId(v string) *DeregisterWorkspaceDirectoryInput { - s.DirectoryId = &v +// SetApplicationIds sets the ApplicationIds field's value. +func (s *DescribeApplicationsInput) SetApplicationIds(v []*string) *DescribeApplicationsInput { + s.ApplicationIds = v return s } -type DeregisterWorkspaceDirectoryOutput struct { - _ struct{} `type:"structure"` +// SetComputeTypeNames sets the ComputeTypeNames field's value. +func (s *DescribeApplicationsInput) SetComputeTypeNames(v []*string) *DescribeApplicationsInput { + s.ComputeTypeNames = v + return s } -// 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 DeregisterWorkspaceDirectoryOutput) String() string { - return awsutil.Prettify(s) +// SetLicenseType sets the LicenseType field's value. +func (s *DescribeApplicationsInput) SetLicenseType(v string) *DescribeApplicationsInput { + s.LicenseType = &v + return 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 DeregisterWorkspaceDirectoryOutput) GoString() string { - return s.String() +// SetMaxResults sets the MaxResults field's value. +func (s *DescribeApplicationsInput) SetMaxResults(v int64) *DescribeApplicationsInput { + s.MaxResults = &v + return s } -type DescribeAccountInput struct { - _ struct{} `type:"structure"` +// SetNextToken sets the NextToken field's value. +func (s *DescribeApplicationsInput) SetNextToken(v string) *DescribeApplicationsInput { + s.NextToken = &v + return s } -// 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 DescribeAccountInput) String() string { - return awsutil.Prettify(s) +// SetOperatingSystemNames sets the OperatingSystemNames field's value. +func (s *DescribeApplicationsInput) SetOperatingSystemNames(v []*string) *DescribeApplicationsInput { + s.OperatingSystemNames = v + return 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 DescribeAccountInput) GoString() string { - return s.String() +// SetOwner sets the Owner field's value. +func (s *DescribeApplicationsInput) SetOwner(v string) *DescribeApplicationsInput { + s.Owner = &v + return s } -type DescribeAccountModificationsInput struct { +type DescribeApplicationsOutput struct { _ struct{} `type:"structure"` + // List of information about the specified applications. + Applications []*WorkSpaceApplication `type:"list"` + // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string `min:"1" type:"string"` @@ -9222,7 +10957,7 @@ type DescribeAccountModificationsInput struct { // 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 DescribeAccountModificationsInput) String() string { +func (s DescribeApplicationsOutput) String() string { return awsutil.Prettify(s) } @@ -9231,38 +10966,34 @@ func (s DescribeAccountModificationsInput) String() string { // 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 DescribeAccountModificationsInput) GoString() string { +func (s DescribeApplicationsOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeAccountModificationsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeAccountModificationsInput"} - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetApplications sets the Applications field's value. +func (s *DescribeApplicationsOutput) SetApplications(v []*WorkSpaceApplication) *DescribeApplicationsOutput { + s.Applications = v + return s } // SetNextToken sets the NextToken field's value. -func (s *DescribeAccountModificationsInput) SetNextToken(v string) *DescribeAccountModificationsInput { +func (s *DescribeApplicationsOutput) SetNextToken(v string) *DescribeApplicationsOutput { s.NextToken = &v return s } -type DescribeAccountModificationsOutput struct { +type DescribeBundleAssociationsInput struct { _ struct{} `type:"structure"` - // The list of modifications to the configuration of BYOL. - AccountModifications []*AccountModification `type:"list"` + // The resource types of the associated resource. + // + // AssociatedResourceTypes is a required field + AssociatedResourceTypes []*string `type:"list" required:"true" enum:"BundleAssociatedResourceType"` - // The token to use to retrieve the next page of results. This value is null - // when there are no more results to return. - NextToken *string `min:"1" type:"string"` + // The identifier of the bundle. + // + // BundleId is a required field + BundleId *string `type:"string" required:"true"` } // String returns the string representation. @@ -9270,7 +11001,7 @@ type DescribeAccountModificationsOutput struct { // 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 DescribeAccountModificationsOutput) String() string { +func (s DescribeBundleAssociationsInput) String() string { return awsutil.Prettify(s) } @@ -9279,36 +11010,43 @@ func (s DescribeAccountModificationsOutput) String() string { // 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 DescribeAccountModificationsOutput) GoString() string { +func (s DescribeBundleAssociationsInput) GoString() string { return s.String() } -// SetAccountModifications sets the AccountModifications field's value. -func (s *DescribeAccountModificationsOutput) SetAccountModifications(v []*AccountModification) *DescribeAccountModificationsOutput { - s.AccountModifications = v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeBundleAssociationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeBundleAssociationsInput"} + if s.AssociatedResourceTypes == nil { + invalidParams.Add(request.NewErrParamRequired("AssociatedResourceTypes")) + } + if s.BundleId == nil { + invalidParams.Add(request.NewErrParamRequired("BundleId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetNextToken sets the NextToken field's value. -func (s *DescribeAccountModificationsOutput) SetNextToken(v string) *DescribeAccountModificationsOutput { - s.NextToken = &v +// SetAssociatedResourceTypes sets the AssociatedResourceTypes field's value. +func (s *DescribeBundleAssociationsInput) SetAssociatedResourceTypes(v []*string) *DescribeBundleAssociationsInput { + s.AssociatedResourceTypes = v + return s +} + +// SetBundleId sets the BundleId field's value. +func (s *DescribeBundleAssociationsInput) SetBundleId(v string) *DescribeBundleAssociationsInput { + s.BundleId = &v return s } -type DescribeAccountOutput struct { +type DescribeBundleAssociationsOutput struct { _ struct{} `type:"structure"` - // The IP address range, specified as an IPv4 CIDR block, used for the management - // network interface. - // - // The management network interface is connected to a secure Amazon WorkSpaces - // management network. It is used for interactive streaming of the WorkSpace - // desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage - // the WorkSpace. - DedicatedTenancyManagementCidrRange *string `type:"string"` - - // The status of BYOL (whether BYOL is enabled or disabled). - DedicatedTenancySupport *string `type:"string" enum:"DedicatedTenancySupportResultEnum"` + // List of information about the specified associations. + Associations []*BundleResourceAssociation `type:"list"` } // String returns the string representation. @@ -9316,7 +11054,7 @@ type DescribeAccountOutput struct { // 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 DescribeAccountOutput) String() string { +func (s DescribeBundleAssociationsOutput) String() string { return awsutil.Prettify(s) } @@ -9325,19 +11063,13 @@ func (s DescribeAccountOutput) String() string { // 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 DescribeAccountOutput) GoString() string { +func (s DescribeBundleAssociationsOutput) GoString() string { return s.String() } -// SetDedicatedTenancyManagementCidrRange sets the DedicatedTenancyManagementCidrRange field's value. -func (s *DescribeAccountOutput) SetDedicatedTenancyManagementCidrRange(v string) *DescribeAccountOutput { - s.DedicatedTenancyManagementCidrRange = &v - return s -} - -// SetDedicatedTenancySupport sets the DedicatedTenancySupport field's value. -func (s *DescribeAccountOutput) SetDedicatedTenancySupport(v string) *DescribeAccountOutput { - s.DedicatedTenancySupport = &v +// SetAssociations sets the Associations field's value. +func (s *DescribeBundleAssociationsOutput) SetAssociations(v []*BundleResourceAssociation) *DescribeBundleAssociationsOutput { + s.Associations = v return s } @@ -9908,6 +11640,97 @@ func (s *DescribeConnectionAliasesOutput) SetNextToken(v string) *DescribeConnec return s } +type DescribeImageAssociationsInput struct { + _ struct{} `type:"structure"` + + // The resource types of the associated resource. + // + // AssociatedResourceTypes is a required field + AssociatedResourceTypes []*string `type:"list" required:"true" enum:"ImageAssociatedResourceType"` + + // The identifier of the image. + // + // ImageId is a required field + ImageId *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 DescribeImageAssociationsInput) 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 DescribeImageAssociationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeImageAssociationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeImageAssociationsInput"} + if s.AssociatedResourceTypes == nil { + invalidParams.Add(request.NewErrParamRequired("AssociatedResourceTypes")) + } + if s.ImageId == nil { + invalidParams.Add(request.NewErrParamRequired("ImageId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssociatedResourceTypes sets the AssociatedResourceTypes field's value. +func (s *DescribeImageAssociationsInput) SetAssociatedResourceTypes(v []*string) *DescribeImageAssociationsInput { + s.AssociatedResourceTypes = v + return s +} + +// SetImageId sets the ImageId field's value. +func (s *DescribeImageAssociationsInput) SetImageId(v string) *DescribeImageAssociationsInput { + s.ImageId = &v + return s +} + +type DescribeImageAssociationsOutput struct { + _ struct{} `type:"structure"` + + // List of information about the specified associations. + Associations []*ImageResourceAssociation `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 DescribeImageAssociationsOutput) 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 DescribeImageAssociationsOutput) GoString() string { + return s.String() +} + +// SetAssociations sets the Associations field's value. +func (s *DescribeImageAssociationsOutput) SetAssociations(v []*ImageResourceAssociation) *DescribeImageAssociationsOutput { + s.Associations = v + return s +} + type DescribeIpGroupsInput struct { _ struct{} `type:"structure"` @@ -10097,6 +11920,97 @@ func (s *DescribeTagsOutput) SetTagList(v []*Tag) *DescribeTagsOutput { return s } +type DescribeWorkspaceAssociationsInput struct { + _ struct{} `type:"structure"` + + // The resource types of the associated resources. + // + // AssociatedResourceTypes is a required field + AssociatedResourceTypes []*string `type:"list" required:"true" enum:"WorkSpaceAssociatedResourceType"` + + // The identifier of the WorkSpace. + // + // WorkspaceId is a required field + WorkspaceId *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 DescribeWorkspaceAssociationsInput) 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 DescribeWorkspaceAssociationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeWorkspaceAssociationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWorkspaceAssociationsInput"} + if s.AssociatedResourceTypes == nil { + invalidParams.Add(request.NewErrParamRequired("AssociatedResourceTypes")) + } + if s.WorkspaceId == nil { + invalidParams.Add(request.NewErrParamRequired("WorkspaceId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssociatedResourceTypes sets the AssociatedResourceTypes field's value. +func (s *DescribeWorkspaceAssociationsInput) SetAssociatedResourceTypes(v []*string) *DescribeWorkspaceAssociationsInput { + s.AssociatedResourceTypes = v + return s +} + +// SetWorkspaceId sets the WorkspaceId field's value. +func (s *DescribeWorkspaceAssociationsInput) SetWorkspaceId(v string) *DescribeWorkspaceAssociationsInput { + s.WorkspaceId = &v + return s +} + +type DescribeWorkspaceAssociationsOutput struct { + _ struct{} `type:"structure"` + + // List of information about the specified associations. + Associations []*WorkspaceResourceAssociation `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 DescribeWorkspaceAssociationsOutput) 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 DescribeWorkspaceAssociationsOutput) GoString() string { + return s.String() +} + +// SetAssociations sets the Associations field's value. +func (s *DescribeWorkspaceAssociationsOutput) SetAssociations(v []*WorkspaceResourceAssociation) *DescribeWorkspaceAssociationsOutput { + s.Associations = v + return s +} + type DescribeWorkspaceBundlesInput struct { _ struct{} `type:"structure"` @@ -10973,18 +12887,103 @@ func (s DisassociateConnectionAliasOutput) GoString() string { return s.String() } -type DisassociateIpGroupsInput struct { +type DisassociateIpGroupsInput struct { + _ struct{} `type:"structure"` + + // The identifier of the directory. + // + // DirectoryId is a required field + DirectoryId *string `min:"10" type:"string" required:"true"` + + // The identifiers of one or more IP access control groups. + // + // GroupIds is a required field + GroupIds []*string `type:"list" 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 DisassociateIpGroupsInput) 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 DisassociateIpGroupsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DisassociateIpGroupsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DisassociateIpGroupsInput"} + if s.DirectoryId == nil { + invalidParams.Add(request.NewErrParamRequired("DirectoryId")) + } + if s.DirectoryId != nil && len(*s.DirectoryId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("DirectoryId", 10)) + } + if s.GroupIds == nil { + invalidParams.Add(request.NewErrParamRequired("GroupIds")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDirectoryId sets the DirectoryId field's value. +func (s *DisassociateIpGroupsInput) SetDirectoryId(v string) *DisassociateIpGroupsInput { + s.DirectoryId = &v + return s +} + +// SetGroupIds sets the GroupIds field's value. +func (s *DisassociateIpGroupsInput) SetGroupIds(v []*string) *DisassociateIpGroupsInput { + s.GroupIds = v + return s +} + +type DisassociateIpGroupsOutput struct { + _ struct{} `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 DisassociateIpGroupsOutput) 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 DisassociateIpGroupsOutput) GoString() string { + return s.String() +} + +type DisassociateWorkspaceApplicationInput struct { _ struct{} `type:"structure"` - // The identifier of the directory. + // The identifier of the application. // - // DirectoryId is a required field - DirectoryId *string `min:"10" type:"string" required:"true"` + // ApplicationId is a required field + ApplicationId *string `type:"string" required:"true"` - // The identifiers of one or more IP access control groups. + // The identifier of the WorkSpace. // - // GroupIds is a required field - GroupIds []*string `type:"list" required:"true"` + // WorkspaceId is a required field + WorkspaceId *string `type:"string" required:"true"` } // String returns the string representation. @@ -10992,7 +12991,7 @@ type DisassociateIpGroupsInput struct { // 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 DisassociateIpGroupsInput) String() string { +func (s DisassociateWorkspaceApplicationInput) String() string { return awsutil.Prettify(s) } @@ -11001,21 +13000,18 @@ func (s DisassociateIpGroupsInput) String() string { // 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 DisassociateIpGroupsInput) GoString() string { +func (s DisassociateWorkspaceApplicationInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DisassociateIpGroupsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DisassociateIpGroupsInput"} - if s.DirectoryId == nil { - invalidParams.Add(request.NewErrParamRequired("DirectoryId")) +func (s *DisassociateWorkspaceApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DisassociateWorkspaceApplicationInput"} + if s.ApplicationId == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationId")) } - if s.DirectoryId != nil && len(*s.DirectoryId) < 10 { - invalidParams.Add(request.NewErrParamMinLen("DirectoryId", 10)) - } - if s.GroupIds == nil { - invalidParams.Add(request.NewErrParamRequired("GroupIds")) + if s.WorkspaceId == nil { + invalidParams.Add(request.NewErrParamRequired("WorkspaceId")) } if invalidParams.Len() > 0 { @@ -11024,20 +13020,23 @@ func (s *DisassociateIpGroupsInput) Validate() error { return nil } -// SetDirectoryId sets the DirectoryId field's value. -func (s *DisassociateIpGroupsInput) SetDirectoryId(v string) *DisassociateIpGroupsInput { - s.DirectoryId = &v +// SetApplicationId sets the ApplicationId field's value. +func (s *DisassociateWorkspaceApplicationInput) SetApplicationId(v string) *DisassociateWorkspaceApplicationInput { + s.ApplicationId = &v return s } -// SetGroupIds sets the GroupIds field's value. -func (s *DisassociateIpGroupsInput) SetGroupIds(v []*string) *DisassociateIpGroupsInput { - s.GroupIds = v +// SetWorkspaceId sets the WorkspaceId field's value. +func (s *DisassociateWorkspaceApplicationInput) SetWorkspaceId(v string) *DisassociateWorkspaceApplicationInput { + s.WorkspaceId = &v return s } -type DisassociateIpGroupsOutput struct { +type DisassociateWorkspaceApplicationOutput struct { _ struct{} `type:"structure"` + + // Information about the targeted association. + Association *WorkspaceResourceAssociation `type:"structure"` } // String returns the string representation. @@ -11045,7 +13044,7 @@ type DisassociateIpGroupsOutput struct { // 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 DisassociateIpGroupsOutput) String() string { +func (s DisassociateWorkspaceApplicationOutput) String() string { return awsutil.Prettify(s) } @@ -11054,12 +13053,18 @@ func (s DisassociateIpGroupsOutput) String() string { // 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 DisassociateIpGroupsOutput) GoString() string { +func (s DisassociateWorkspaceApplicationOutput) GoString() string { return s.String() } -// Provides in-depth details about the error. These details include the possible -// causes of the errors and troubleshooting information. +// SetAssociation sets the Association field's value. +func (s *DisassociateWorkspaceApplicationOutput) SetAssociation(v *WorkspaceResourceAssociation) *DisassociateWorkspaceApplicationOutput { + s.Association = v + return s +} + +// Describes in-depth details about the error. These details include the possible +// causes of the error and troubleshooting information. type ErrorDetails struct { _ struct{} `type:"structure"` @@ -11290,6 +13295,92 @@ func (s *ImagePermission) SetSharedAccountId(v string) *ImagePermission { return s } +// Describes the association between an application and an image resource. +type ImageResourceAssociation struct { + _ struct{} `type:"structure"` + + // The identifier of the associated resource. + AssociatedResourceId *string `min:"1" type:"string"` + + // The resource type of the associated resources. + AssociatedResourceType *string `type:"string" enum:"ImageAssociatedResourceType"` + + // The time the association is created. + Created *time.Time `type:"timestamp"` + + // The identifier of the image. + ImageId *string `type:"string"` + + // The time the association status was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The status of the image resource association. + State *string `type:"string" enum:"AssociationState"` + + // The reason the association deployment failed. + StateReason *AssociationStateReason `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 ImageResourceAssociation) 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 ImageResourceAssociation) GoString() string { + return s.String() +} + +// SetAssociatedResourceId sets the AssociatedResourceId field's value. +func (s *ImageResourceAssociation) SetAssociatedResourceId(v string) *ImageResourceAssociation { + s.AssociatedResourceId = &v + return s +} + +// SetAssociatedResourceType sets the AssociatedResourceType field's value. +func (s *ImageResourceAssociation) SetAssociatedResourceType(v string) *ImageResourceAssociation { + s.AssociatedResourceType = &v + return s +} + +// SetCreated sets the Created field's value. +func (s *ImageResourceAssociation) SetCreated(v time.Time) *ImageResourceAssociation { + s.Created = &v + return s +} + +// SetImageId sets the ImageId field's value. +func (s *ImageResourceAssociation) SetImageId(v string) *ImageResourceAssociation { + s.ImageId = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *ImageResourceAssociation) SetLastUpdatedTime(v time.Time) *ImageResourceAssociation { + s.LastUpdatedTime = &v + return s +} + +// SetState sets the State field's value. +func (s *ImageResourceAssociation) SetState(v string) *ImageResourceAssociation { + s.State = &v + return s +} + +// SetStateReason sets the StateReason field's value. +func (s *ImageResourceAssociation) SetStateReason(v *AssociationStateReason) *ImageResourceAssociation { + s.StateReason = v + return s +} + type ImportClientBrandingInput struct { _ struct{} `type:"structure"` @@ -11675,6 +13766,70 @@ func (s *ImportWorkspaceImageOutput) SetImageId(v string) *ImportWorkspaceImageO return s } +// The specified application is not compatible with the resource. +type IncompatibleApplicationsException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" 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 IncompatibleApplicationsException) 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 IncompatibleApplicationsException) GoString() string { + return s.String() +} + +func newErrorIncompatibleApplicationsException(v protocol.ResponseMetadata) error { + return &IncompatibleApplicationsException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *IncompatibleApplicationsException) Code() string { + return "IncompatibleApplicationsException" +} + +// Message returns the exception's message. +func (s *IncompatibleApplicationsException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *IncompatibleApplicationsException) OrigErr() error { + return nil +} + +func (s *IncompatibleApplicationsException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *IncompatibleApplicationsException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *IncompatibleApplicationsException) RequestID() string { + return s.RespMetadata.RequestID +} + // One or more parameter values are not valid. type InvalidParameterValuesException struct { _ struct{} `type:"structure"` @@ -13239,6 +15394,70 @@ func (s *OperatingSystem) SetType(v string) *OperatingSystem { return s } +// The operating system of the WorkSpace is not compatible with the application. +type OperatingSystemNotCompatibleException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" 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 OperatingSystemNotCompatibleException) 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 OperatingSystemNotCompatibleException) GoString() string { + return s.String() +} + +func newErrorOperatingSystemNotCompatibleException(v protocol.ResponseMetadata) error { + return &OperatingSystemNotCompatibleException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *OperatingSystemNotCompatibleException) Code() string { + return "OperatingSystemNotCompatibleException" +} + +// Message returns the exception's message. +func (s *OperatingSystemNotCompatibleException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *OperatingSystemNotCompatibleException) OrigErr() error { + return nil +} + +func (s *OperatingSystemNotCompatibleException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *OperatingSystemNotCompatibleException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *OperatingSystemNotCompatibleException) RequestID() string { + return s.RespMetadata.RequestID +} + // The properties of this WorkSpace are currently being modified. Try again // in a moment. type OperationInProgressException struct { @@ -14083,7 +16302,74 @@ func (s *ResourceCreationFailedException) Code() string { } // Message returns the exception's message. -func (s *ResourceCreationFailedException) Message() string { +func (s *ResourceCreationFailedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceCreationFailedException) OrigErr() error { + return nil +} + +func (s *ResourceCreationFailedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceCreationFailedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceCreationFailedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The specified resource is currently in use. +type ResourceInUseException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + // The ID of the resource that is in use. + ResourceId *string `min:"1" 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 ResourceInUseException) 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 ResourceInUseException) GoString() string { + return s.String() +} + +func newErrorResourceInUseException(v protocol.ResponseMetadata) error { + return &ResourceInUseException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceInUseException) Code() string { + return "ResourceInUseException" +} + +// Message returns the exception's message. +func (s *ResourceInUseException) Message() string { if s.Message_ != nil { return *s.Message_ } @@ -14091,21 +16377,21 @@ func (s *ResourceCreationFailedException) Message() string { } // OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ResourceCreationFailedException) OrigErr() error { +func (s *ResourceInUseException) OrigErr() error { return nil } -func (s *ResourceCreationFailedException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +func (s *ResourceInUseException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) } // Status code returns the HTTP status code for the request's response error. -func (s *ResourceCreationFailedException) StatusCode() int { +func (s *ResourceInUseException) StatusCode() int { return s.RespMetadata.StatusCode } // RequestID returns the service's response RequestID for request. -func (s *ResourceCreationFailedException) RequestID() string { +func (s *ResourceInUseException) RequestID() string { return s.RespMetadata.RequestID } @@ -15885,6 +18171,142 @@ func (s *UserStorage) SetCapacity(v string) *UserStorage { return s } +// Describes the WorkSpace application. +type WorkSpaceApplication struct { + _ struct{} `type:"structure"` + + // The identifier of the application. + ApplicationId *string `type:"string"` + + // The time the application is created. + Created *time.Time `type:"timestamp"` + + // The description of the WorkSpace application. + Description *string `type:"string"` + + // The license availability for the applications. + LicenseType *string `type:"string" enum:"WorkSpaceApplicationLicenseType"` + + // The name of the WorkSpace application. + Name *string `min:"1" type:"string"` + + // The owner of the WorkSpace application. + Owner *string `type:"string"` + + // The status of WorkSpace application. + State *string `type:"string" enum:"WorkSpaceApplicationState"` + + // The supported compute types of the WorkSpace application. + SupportedComputeTypeNames []*string `type:"list" enum:"Compute"` + + // The supported operating systems of the WorkSpace application. + SupportedOperatingSystemNames []*string `type:"list" enum:"OperatingSystemName"` +} + +// 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 WorkSpaceApplication) 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 WorkSpaceApplication) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *WorkSpaceApplication) SetApplicationId(v string) *WorkSpaceApplication { + s.ApplicationId = &v + return s +} + +// SetCreated sets the Created field's value. +func (s *WorkSpaceApplication) SetCreated(v time.Time) *WorkSpaceApplication { + s.Created = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *WorkSpaceApplication) SetDescription(v string) *WorkSpaceApplication { + s.Description = &v + return s +} + +// SetLicenseType sets the LicenseType field's value. +func (s *WorkSpaceApplication) SetLicenseType(v string) *WorkSpaceApplication { + s.LicenseType = &v + return s +} + +// SetName sets the Name field's value. +func (s *WorkSpaceApplication) SetName(v string) *WorkSpaceApplication { + s.Name = &v + return s +} + +// SetOwner sets the Owner field's value. +func (s *WorkSpaceApplication) SetOwner(v string) *WorkSpaceApplication { + s.Owner = &v + return s +} + +// SetState sets the State field's value. +func (s *WorkSpaceApplication) SetState(v string) *WorkSpaceApplication { + s.State = &v + return s +} + +// SetSupportedComputeTypeNames sets the SupportedComputeTypeNames field's value. +func (s *WorkSpaceApplication) SetSupportedComputeTypeNames(v []*string) *WorkSpaceApplication { + s.SupportedComputeTypeNames = v + return s +} + +// SetSupportedOperatingSystemNames sets the SupportedOperatingSystemNames field's value. +func (s *WorkSpaceApplication) SetSupportedOperatingSystemNames(v []*string) *WorkSpaceApplication { + s.SupportedOperatingSystemNames = v + return s +} + +// Describes the WorkSpace application deployment. +type WorkSpaceApplicationDeployment struct { + _ struct{} `type:"structure"` + + // The associations between the applications and the associated resources. + Associations []*WorkspaceResourceAssociation `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 WorkSpaceApplicationDeployment) 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 WorkSpaceApplicationDeployment) GoString() string { + return s.String() +} + +// SetAssociations sets the Associations field's value. +func (s *WorkSpaceApplicationDeployment) SetAssociations(v []*WorkspaceResourceAssociation) *WorkSpaceApplicationDeployment { + s.Associations = v + return s +} + // Describes a WorkSpace. type Workspace struct { _ struct{} `type:"structure"` @@ -16680,7 +19102,8 @@ type WorkspaceImage struct { // The error code that is returned for the image. ErrorCode *string `type:"string"` - // The details of the error returned for the image. + // Additional details of the error returned for the image, including the possible + // causes of the errors and troubleshooting information. ErrorDetails []*ErrorDetails `type:"list"` // The text of the error message that is returned for the image. @@ -16807,6 +19230,9 @@ type WorkspaceProperties struct { // The compute type. For more information, see Amazon WorkSpaces Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). ComputeTypeName *string `type:"string" enum:"Compute"` + // The name of the operating system. + OperatingSystemName *string `type:"string" enum:"OperatingSystemName"` + // The protocol. For more information, see Protocols for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html). // // * Only available for WorkSpaces created with PCoIP bundles. @@ -16862,6 +19288,12 @@ func (s *WorkspaceProperties) SetComputeTypeName(v string) *WorkspaceProperties return s } +// SetOperatingSystemName sets the OperatingSystemName field's value. +func (s *WorkspaceProperties) SetOperatingSystemName(v string) *WorkspaceProperties { + s.OperatingSystemName = &v + return s +} + // SetProtocols sets the Protocols field's value. func (s *WorkspaceProperties) SetProtocols(v []*string) *WorkspaceProperties { s.Protocols = v @@ -17032,6 +19464,92 @@ func (s *WorkspaceRequest) SetWorkspaceProperties(v *WorkspaceProperties) *Works return s } +// Describes the association between an application and a WorkSpace resource. +type WorkspaceResourceAssociation struct { + _ struct{} `type:"structure"` + + // The identifier of the associated resource. + AssociatedResourceId *string `min:"1" type:"string"` + + // The resource types of the associated resource. + AssociatedResourceType *string `type:"string" enum:"WorkSpaceAssociatedResourceType"` + + // The time the association is created. + Created *time.Time `type:"timestamp"` + + // The time the association status was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The status of the WorkSpace resource association. + State *string `type:"string" enum:"AssociationState"` + + // The reason the association deployment failed. + StateReason *AssociationStateReason `type:"structure"` + + // The identifier of the WorkSpace. + WorkspaceId *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 WorkspaceResourceAssociation) 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 WorkspaceResourceAssociation) GoString() string { + return s.String() +} + +// SetAssociatedResourceId sets the AssociatedResourceId field's value. +func (s *WorkspaceResourceAssociation) SetAssociatedResourceId(v string) *WorkspaceResourceAssociation { + s.AssociatedResourceId = &v + return s +} + +// SetAssociatedResourceType sets the AssociatedResourceType field's value. +func (s *WorkspaceResourceAssociation) SetAssociatedResourceType(v string) *WorkspaceResourceAssociation { + s.AssociatedResourceType = &v + return s +} + +// SetCreated sets the Created field's value. +func (s *WorkspaceResourceAssociation) SetCreated(v time.Time) *WorkspaceResourceAssociation { + s.Created = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *WorkspaceResourceAssociation) SetLastUpdatedTime(v time.Time) *WorkspaceResourceAssociation { + s.LastUpdatedTime = &v + return s +} + +// SetState sets the State field's value. +func (s *WorkspaceResourceAssociation) SetState(v string) *WorkspaceResourceAssociation { + s.State = &v + return s +} + +// SetStateReason sets the StateReason field's value. +func (s *WorkspaceResourceAssociation) SetStateReason(v *AssociationStateReason) *WorkspaceResourceAssociation { + s.StateReason = v + return s +} + +// SetWorkspaceId sets the WorkspaceId field's value. +func (s *WorkspaceResourceAssociation) SetWorkspaceId(v string) *WorkspaceResourceAssociation { + s.WorkspaceId = &v + return s +} + // The workspaces_DefaultRole role could not be found. If this is the first // time you are registering a directory, you will need to create the workspaces_DefaultRole // role before you can register a directory. For more information, see Creating @@ -17131,6 +19649,98 @@ func Application_Values() []string { } } +const ( + // ApplicationAssociatedResourceTypeWorkspace is a ApplicationAssociatedResourceType enum value + ApplicationAssociatedResourceTypeWorkspace = "WORKSPACE" + + // ApplicationAssociatedResourceTypeBundle is a ApplicationAssociatedResourceType enum value + ApplicationAssociatedResourceTypeBundle = "BUNDLE" + + // ApplicationAssociatedResourceTypeImage is a ApplicationAssociatedResourceType enum value + ApplicationAssociatedResourceTypeImage = "IMAGE" +) + +// ApplicationAssociatedResourceType_Values returns all elements of the ApplicationAssociatedResourceType enum +func ApplicationAssociatedResourceType_Values() []string { + return []string{ + ApplicationAssociatedResourceTypeWorkspace, + ApplicationAssociatedResourceTypeBundle, + ApplicationAssociatedResourceTypeImage, + } +} + +const ( + // AssociationErrorCodeValidationErrorInsufficientDiskSpace is a AssociationErrorCode enum value + AssociationErrorCodeValidationErrorInsufficientDiskSpace = "ValidationError.InsufficientDiskSpace" + + // AssociationErrorCodeValidationErrorInsufficientMemory is a AssociationErrorCode enum value + AssociationErrorCodeValidationErrorInsufficientMemory = "ValidationError.InsufficientMemory" + + // AssociationErrorCodeValidationErrorUnsupportedOperatingSystem is a AssociationErrorCode enum value + AssociationErrorCodeValidationErrorUnsupportedOperatingSystem = "ValidationError.UnsupportedOperatingSystem" + + // AssociationErrorCodeDeploymentErrorInternalServerError is a AssociationErrorCode enum value + AssociationErrorCodeDeploymentErrorInternalServerError = "DeploymentError.InternalServerError" + + // AssociationErrorCodeDeploymentErrorWorkspaceUnreachable is a AssociationErrorCode enum value + AssociationErrorCodeDeploymentErrorWorkspaceUnreachable = "DeploymentError.WorkspaceUnreachable" +) + +// AssociationErrorCode_Values returns all elements of the AssociationErrorCode enum +func AssociationErrorCode_Values() []string { + return []string{ + AssociationErrorCodeValidationErrorInsufficientDiskSpace, + AssociationErrorCodeValidationErrorInsufficientMemory, + AssociationErrorCodeValidationErrorUnsupportedOperatingSystem, + AssociationErrorCodeDeploymentErrorInternalServerError, + AssociationErrorCodeDeploymentErrorWorkspaceUnreachable, + } +} + +const ( + // AssociationStatePendingInstall is a AssociationState enum value + AssociationStatePendingInstall = "PENDING_INSTALL" + + // AssociationStatePendingInstallDeployment is a AssociationState enum value + AssociationStatePendingInstallDeployment = "PENDING_INSTALL_DEPLOYMENT" + + // AssociationStatePendingUninstall is a AssociationState enum value + AssociationStatePendingUninstall = "PENDING_UNINSTALL" + + // AssociationStatePendingUninstallDeployment is a AssociationState enum value + AssociationStatePendingUninstallDeployment = "PENDING_UNINSTALL_DEPLOYMENT" + + // AssociationStateInstalling is a AssociationState enum value + AssociationStateInstalling = "INSTALLING" + + // AssociationStateUninstalling is a AssociationState enum value + AssociationStateUninstalling = "UNINSTALLING" + + // AssociationStateError is a AssociationState enum value + AssociationStateError = "ERROR" + + // AssociationStateCompleted is a AssociationState enum value + AssociationStateCompleted = "COMPLETED" + + // AssociationStateRemoved is a AssociationState enum value + AssociationStateRemoved = "REMOVED" +) + +// AssociationState_Values returns all elements of the AssociationState enum +func AssociationState_Values() []string { + return []string{ + AssociationStatePendingInstall, + AssociationStatePendingInstallDeployment, + AssociationStatePendingUninstall, + AssociationStatePendingUninstallDeployment, + AssociationStateInstalling, + AssociationStateUninstalling, + AssociationStateError, + AssociationStateCompleted, + AssociationStateRemoved, + } +} + const ( // AssociationStatusNotAssociated is a AssociationStatus enum value AssociationStatusNotAssociated = "NOT_ASSOCIATED" @@ -17159,6 +19769,18 @@ func AssociationStatus_Values() []string { } } +const ( + // BundleAssociatedResourceTypeApplication is a BundleAssociatedResourceType enum value + BundleAssociatedResourceTypeApplication = "APPLICATION" +) + +// BundleAssociatedResourceType_Values returns all elements of the BundleAssociatedResourceType enum +func BundleAssociatedResourceType_Values() []string { + return []string{ + BundleAssociatedResourceTypeApplication, + } +} + const ( // BundleTypeRegular is a BundleType enum value BundleTypeRegular = "REGULAR" @@ -17383,6 +20005,18 @@ func DeletableSamlProperty_Values() []string { } } +const ( + // ImageAssociatedResourceTypeApplication is a ImageAssociatedResourceType enum value + ImageAssociatedResourceTypeApplication = "APPLICATION" +) + +// ImageAssociatedResourceType_Values returns all elements of the ImageAssociatedResourceType enum +func ImageAssociatedResourceType_Values() []string { + return []string{ + ImageAssociatedResourceTypeApplication, + } +} + const ( // ImageTypeOwned is a ImageType enum value ImageTypeOwned = "OWNED" @@ -17451,6 +20085,58 @@ func ModificationStateEnum_Values() []string { } } +const ( + // OperatingSystemNameAmazonLinux2 is a OperatingSystemName enum value + OperatingSystemNameAmazonLinux2 = "AMAZON_LINUX_2" + + // OperatingSystemNameUbuntu1804 is a OperatingSystemName enum value + OperatingSystemNameUbuntu1804 = "UBUNTU_18_04" + + // OperatingSystemNameUbuntu2004 is a OperatingSystemName enum value + OperatingSystemNameUbuntu2004 = "UBUNTU_20_04" + + // OperatingSystemNameUbuntu2204 is a OperatingSystemName enum value + OperatingSystemNameUbuntu2204 = "UBUNTU_22_04" + + // OperatingSystemNameUnknown is a OperatingSystemName enum value + OperatingSystemNameUnknown = "UNKNOWN" + + // OperatingSystemNameWindows10 is a OperatingSystemName enum value + OperatingSystemNameWindows10 = "WINDOWS_10" + + // OperatingSystemNameWindows11 is a OperatingSystemName enum value + OperatingSystemNameWindows11 = "WINDOWS_11" + + // OperatingSystemNameWindows7 is a OperatingSystemName enum value + OperatingSystemNameWindows7 = "WINDOWS_7" + + // OperatingSystemNameWindowsServer2016 is a OperatingSystemName enum value + OperatingSystemNameWindowsServer2016 = "WINDOWS_SERVER_2016" + + // OperatingSystemNameWindowsServer2019 is a OperatingSystemName enum value + OperatingSystemNameWindowsServer2019 = "WINDOWS_SERVER_2019" + + // OperatingSystemNameWindowsServer2022 is a OperatingSystemName enum value + OperatingSystemNameWindowsServer2022 = "WINDOWS_SERVER_2022" +) + +// OperatingSystemName_Values returns all elements of the OperatingSystemName enum +func OperatingSystemName_Values() []string { + return []string{ + OperatingSystemNameAmazonLinux2, + OperatingSystemNameUbuntu1804, + OperatingSystemNameUbuntu2004, + OperatingSystemNameUbuntu2204, + OperatingSystemNameUnknown, + OperatingSystemNameWindows10, + OperatingSystemNameWindows11, + OperatingSystemNameWindows7, + OperatingSystemNameWindowsServer2016, + OperatingSystemNameWindowsServer2019, + OperatingSystemNameWindowsServer2022, + } +} + const ( // OperatingSystemTypeWindows is a OperatingSystemType enum value OperatingSystemTypeWindows = "WINDOWS" @@ -17587,6 +20273,58 @@ func Tenancy_Values() []string { } } +const ( + // WorkSpaceApplicationLicenseTypeLicensed is a WorkSpaceApplicationLicenseType enum value + WorkSpaceApplicationLicenseTypeLicensed = "LICENSED" + + // WorkSpaceApplicationLicenseTypeUnlicensed is a WorkSpaceApplicationLicenseType enum value + WorkSpaceApplicationLicenseTypeUnlicensed = "UNLICENSED" +) + +// WorkSpaceApplicationLicenseType_Values returns all elements of the WorkSpaceApplicationLicenseType enum +func WorkSpaceApplicationLicenseType_Values() []string { + return []string{ + WorkSpaceApplicationLicenseTypeLicensed, + WorkSpaceApplicationLicenseTypeUnlicensed, + } +} + +const ( + // WorkSpaceApplicationStatePending is a WorkSpaceApplicationState enum value + WorkSpaceApplicationStatePending = "PENDING" + + // WorkSpaceApplicationStateError is a WorkSpaceApplicationState enum value + WorkSpaceApplicationStateError = "ERROR" + + // WorkSpaceApplicationStateAvailable is a WorkSpaceApplicationState enum value + WorkSpaceApplicationStateAvailable = "AVAILABLE" + + // WorkSpaceApplicationStateUninstallOnly is a WorkSpaceApplicationState enum value + WorkSpaceApplicationStateUninstallOnly = "UNINSTALL_ONLY" +) + +// WorkSpaceApplicationState_Values returns all elements of the WorkSpaceApplicationState enum +func WorkSpaceApplicationState_Values() []string { + return []string{ + WorkSpaceApplicationStatePending, + WorkSpaceApplicationStateError, + WorkSpaceApplicationStateAvailable, + WorkSpaceApplicationStateUninstallOnly, + } +} + +const ( + // WorkSpaceAssociatedResourceTypeApplication is a WorkSpaceAssociatedResourceType enum value + WorkSpaceAssociatedResourceTypeApplication = "APPLICATION" +) + +// WorkSpaceAssociatedResourceType_Values returns all elements of the WorkSpaceAssociatedResourceType enum +func WorkSpaceAssociatedResourceType_Values() []string { + return []string{ + WorkSpaceAssociatedResourceTypeApplication, + } +} + const ( // WorkspaceBundleStateAvailable is a WorkspaceBundleState enum value WorkspaceBundleStateAvailable = "AVAILABLE" diff --git a/service/workspaces/errors.go b/service/workspaces/errors.go index 536f297ed8c..df408e08860 100644 --- a/service/workspaces/errors.go +++ b/service/workspaces/errors.go @@ -14,6 +14,24 @@ const ( // The user is not authorized to access a resource. ErrCodeAccessDeniedException = "AccessDeniedException" + // ErrCodeApplicationNotSupportedException for service response error code + // "ApplicationNotSupportedException". + // + // The specified application is not supported. + ErrCodeApplicationNotSupportedException = "ApplicationNotSupportedException" + + // ErrCodeComputeNotCompatibleException for service response error code + // "ComputeNotCompatibleException". + // + // The compute type of the WorkSpace is not compatible with the application. + ErrCodeComputeNotCompatibleException = "ComputeNotCompatibleException" + + // ErrCodeIncompatibleApplicationsException for service response error code + // "IncompatibleApplicationsException". + // + // The specified application is not compatible with the resource. + ErrCodeIncompatibleApplicationsException = "IncompatibleApplicationsException" + // ErrCodeInvalidParameterValuesException for service response error code // "InvalidParameterValuesException". // @@ -26,6 +44,12 @@ const ( // The state of the resource is not valid for this operation. ErrCodeInvalidResourceStateException = "InvalidResourceStateException" + // ErrCodeOperatingSystemNotCompatibleException for service response error code + // "OperatingSystemNotCompatibleException". + // + // The operating system of the WorkSpace is not compatible with the application. + ErrCodeOperatingSystemNotCompatibleException = "OperatingSystemNotCompatibleException" + // ErrCodeOperationInProgressException for service response error code // "OperationInProgressException". // @@ -57,6 +81,12 @@ const ( // The resource could not be created. ErrCodeResourceCreationFailedException = "ResourceCreationFailedException" + // ErrCodeResourceInUseException for service response error code + // "ResourceInUseException". + // + // The specified resource is currently in use. + ErrCodeResourceInUseException = "ResourceInUseException" + // ErrCodeResourceLimitExceededException for service response error code // "ResourceLimitExceededException". // @@ -104,13 +134,18 @@ const ( var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "AccessDeniedException": newErrorAccessDeniedException, + "ApplicationNotSupportedException": newErrorApplicationNotSupportedException, + "ComputeNotCompatibleException": newErrorComputeNotCompatibleException, + "IncompatibleApplicationsException": newErrorIncompatibleApplicationsException, "InvalidParameterValuesException": newErrorInvalidParameterValuesException, "InvalidResourceStateException": newErrorInvalidResourceStateException, + "OperatingSystemNotCompatibleException": newErrorOperatingSystemNotCompatibleException, "OperationInProgressException": newErrorOperationInProgressException, "OperationNotSupportedException": newErrorOperationNotSupportedException, "ResourceAlreadyExistsException": newErrorResourceAlreadyExistsException, "ResourceAssociatedException": newErrorResourceAssociatedException, "ResourceCreationFailedException": newErrorResourceCreationFailedException, + "ResourceInUseException": newErrorResourceInUseException, "ResourceLimitExceededException": newErrorResourceLimitExceededException, "ResourceNotFoundException": newErrorResourceNotFoundException, "ResourceUnavailableException": newErrorResourceUnavailableException, diff --git a/service/workspaces/workspacesiface/interface.go b/service/workspaces/workspacesiface/interface.go index a1b4fd4fcd7..f16419bfbfa 100644 --- a/service/workspaces/workspacesiface/interface.go +++ b/service/workspaces/workspacesiface/interface.go @@ -68,6 +68,10 @@ type WorkSpacesAPI interface { AssociateIpGroupsWithContext(aws.Context, *workspaces.AssociateIpGroupsInput, ...request.Option) (*workspaces.AssociateIpGroupsOutput, error) AssociateIpGroupsRequest(*workspaces.AssociateIpGroupsInput) (*request.Request, *workspaces.AssociateIpGroupsOutput) + AssociateWorkspaceApplication(*workspaces.AssociateWorkspaceApplicationInput) (*workspaces.AssociateWorkspaceApplicationOutput, error) + AssociateWorkspaceApplicationWithContext(aws.Context, *workspaces.AssociateWorkspaceApplicationInput, ...request.Option) (*workspaces.AssociateWorkspaceApplicationOutput, error) + AssociateWorkspaceApplicationRequest(*workspaces.AssociateWorkspaceApplicationInput) (*request.Request, *workspaces.AssociateWorkspaceApplicationOutput) + AuthorizeIpRules(*workspaces.AuthorizeIpRulesInput) (*workspaces.AuthorizeIpRulesOutput, error) AuthorizeIpRulesWithContext(aws.Context, *workspaces.AuthorizeIpRulesInput, ...request.Option) (*workspaces.AuthorizeIpRulesOutput, error) AuthorizeIpRulesRequest(*workspaces.AuthorizeIpRulesInput) (*request.Request, *workspaces.AuthorizeIpRulesOutput) @@ -140,6 +144,10 @@ type WorkSpacesAPI interface { DeleteWorkspaceImageWithContext(aws.Context, *workspaces.DeleteWorkspaceImageInput, ...request.Option) (*workspaces.DeleteWorkspaceImageOutput, error) DeleteWorkspaceImageRequest(*workspaces.DeleteWorkspaceImageInput) (*request.Request, *workspaces.DeleteWorkspaceImageOutput) + DeployWorkspaceApplications(*workspaces.DeployWorkspaceApplicationsInput) (*workspaces.DeployWorkspaceApplicationsOutput, error) + DeployWorkspaceApplicationsWithContext(aws.Context, *workspaces.DeployWorkspaceApplicationsInput, ...request.Option) (*workspaces.DeployWorkspaceApplicationsOutput, error) + DeployWorkspaceApplicationsRequest(*workspaces.DeployWorkspaceApplicationsInput) (*request.Request, *workspaces.DeployWorkspaceApplicationsOutput) + DeregisterWorkspaceDirectory(*workspaces.DeregisterWorkspaceDirectoryInput) (*workspaces.DeregisterWorkspaceDirectoryOutput, error) DeregisterWorkspaceDirectoryWithContext(aws.Context, *workspaces.DeregisterWorkspaceDirectoryInput, ...request.Option) (*workspaces.DeregisterWorkspaceDirectoryOutput, error) DeregisterWorkspaceDirectoryRequest(*workspaces.DeregisterWorkspaceDirectoryInput) (*request.Request, *workspaces.DeregisterWorkspaceDirectoryOutput) @@ -152,6 +160,24 @@ type WorkSpacesAPI interface { DescribeAccountModificationsWithContext(aws.Context, *workspaces.DescribeAccountModificationsInput, ...request.Option) (*workspaces.DescribeAccountModificationsOutput, error) DescribeAccountModificationsRequest(*workspaces.DescribeAccountModificationsInput) (*request.Request, *workspaces.DescribeAccountModificationsOutput) + DescribeApplicationAssociations(*workspaces.DescribeApplicationAssociationsInput) (*workspaces.DescribeApplicationAssociationsOutput, error) + DescribeApplicationAssociationsWithContext(aws.Context, *workspaces.DescribeApplicationAssociationsInput, ...request.Option) (*workspaces.DescribeApplicationAssociationsOutput, error) + DescribeApplicationAssociationsRequest(*workspaces.DescribeApplicationAssociationsInput) (*request.Request, *workspaces.DescribeApplicationAssociationsOutput) + + DescribeApplicationAssociationsPages(*workspaces.DescribeApplicationAssociationsInput, func(*workspaces.DescribeApplicationAssociationsOutput, bool) bool) error + DescribeApplicationAssociationsPagesWithContext(aws.Context, *workspaces.DescribeApplicationAssociationsInput, func(*workspaces.DescribeApplicationAssociationsOutput, bool) bool, ...request.Option) error + + DescribeApplications(*workspaces.DescribeApplicationsInput) (*workspaces.DescribeApplicationsOutput, error) + DescribeApplicationsWithContext(aws.Context, *workspaces.DescribeApplicationsInput, ...request.Option) (*workspaces.DescribeApplicationsOutput, error) + DescribeApplicationsRequest(*workspaces.DescribeApplicationsInput) (*request.Request, *workspaces.DescribeApplicationsOutput) + + DescribeApplicationsPages(*workspaces.DescribeApplicationsInput, func(*workspaces.DescribeApplicationsOutput, bool) bool) error + DescribeApplicationsPagesWithContext(aws.Context, *workspaces.DescribeApplicationsInput, func(*workspaces.DescribeApplicationsOutput, bool) bool, ...request.Option) error + + DescribeBundleAssociations(*workspaces.DescribeBundleAssociationsInput) (*workspaces.DescribeBundleAssociationsOutput, error) + DescribeBundleAssociationsWithContext(aws.Context, *workspaces.DescribeBundleAssociationsInput, ...request.Option) (*workspaces.DescribeBundleAssociationsOutput, error) + DescribeBundleAssociationsRequest(*workspaces.DescribeBundleAssociationsInput) (*request.Request, *workspaces.DescribeBundleAssociationsOutput) + DescribeClientBranding(*workspaces.DescribeClientBrandingInput) (*workspaces.DescribeClientBrandingOutput, error) DescribeClientBrandingWithContext(aws.Context, *workspaces.DescribeClientBrandingInput, ...request.Option) (*workspaces.DescribeClientBrandingOutput, error) DescribeClientBrandingRequest(*workspaces.DescribeClientBrandingInput) (*request.Request, *workspaces.DescribeClientBrandingOutput) @@ -172,6 +198,10 @@ type WorkSpacesAPI interface { DescribeConnectionAliasesWithContext(aws.Context, *workspaces.DescribeConnectionAliasesInput, ...request.Option) (*workspaces.DescribeConnectionAliasesOutput, error) DescribeConnectionAliasesRequest(*workspaces.DescribeConnectionAliasesInput) (*request.Request, *workspaces.DescribeConnectionAliasesOutput) + DescribeImageAssociations(*workspaces.DescribeImageAssociationsInput) (*workspaces.DescribeImageAssociationsOutput, error) + DescribeImageAssociationsWithContext(aws.Context, *workspaces.DescribeImageAssociationsInput, ...request.Option) (*workspaces.DescribeImageAssociationsOutput, error) + DescribeImageAssociationsRequest(*workspaces.DescribeImageAssociationsInput) (*request.Request, *workspaces.DescribeImageAssociationsOutput) + DescribeIpGroups(*workspaces.DescribeIpGroupsInput) (*workspaces.DescribeIpGroupsOutput, error) DescribeIpGroupsWithContext(aws.Context, *workspaces.DescribeIpGroupsInput, ...request.Option) (*workspaces.DescribeIpGroupsOutput, error) DescribeIpGroupsRequest(*workspaces.DescribeIpGroupsInput) (*request.Request, *workspaces.DescribeIpGroupsOutput) @@ -180,6 +210,10 @@ type WorkSpacesAPI interface { DescribeTagsWithContext(aws.Context, *workspaces.DescribeTagsInput, ...request.Option) (*workspaces.DescribeTagsOutput, error) DescribeTagsRequest(*workspaces.DescribeTagsInput) (*request.Request, *workspaces.DescribeTagsOutput) + DescribeWorkspaceAssociations(*workspaces.DescribeWorkspaceAssociationsInput) (*workspaces.DescribeWorkspaceAssociationsOutput, error) + DescribeWorkspaceAssociationsWithContext(aws.Context, *workspaces.DescribeWorkspaceAssociationsInput, ...request.Option) (*workspaces.DescribeWorkspaceAssociationsOutput, error) + DescribeWorkspaceAssociationsRequest(*workspaces.DescribeWorkspaceAssociationsInput) (*request.Request, *workspaces.DescribeWorkspaceAssociationsOutput) + DescribeWorkspaceBundles(*workspaces.DescribeWorkspaceBundlesInput) (*workspaces.DescribeWorkspaceBundlesOutput, error) DescribeWorkspaceBundlesWithContext(aws.Context, *workspaces.DescribeWorkspaceBundlesInput, ...request.Option) (*workspaces.DescribeWorkspaceBundlesOutput, error) DescribeWorkspaceBundlesRequest(*workspaces.DescribeWorkspaceBundlesInput) (*request.Request, *workspaces.DescribeWorkspaceBundlesOutput) @@ -225,6 +259,10 @@ type WorkSpacesAPI interface { DisassociateIpGroupsWithContext(aws.Context, *workspaces.DisassociateIpGroupsInput, ...request.Option) (*workspaces.DisassociateIpGroupsOutput, error) DisassociateIpGroupsRequest(*workspaces.DisassociateIpGroupsInput) (*request.Request, *workspaces.DisassociateIpGroupsOutput) + DisassociateWorkspaceApplication(*workspaces.DisassociateWorkspaceApplicationInput) (*workspaces.DisassociateWorkspaceApplicationOutput, error) + DisassociateWorkspaceApplicationWithContext(aws.Context, *workspaces.DisassociateWorkspaceApplicationInput, ...request.Option) (*workspaces.DisassociateWorkspaceApplicationOutput, error) + DisassociateWorkspaceApplicationRequest(*workspaces.DisassociateWorkspaceApplicationInput) (*request.Request, *workspaces.DisassociateWorkspaceApplicationOutput) + ImportClientBranding(*workspaces.ImportClientBrandingInput) (*workspaces.ImportClientBrandingOutput, error) ImportClientBrandingWithContext(aws.Context, *workspaces.ImportClientBrandingInput, ...request.Option) (*workspaces.ImportClientBrandingOutput, error) ImportClientBrandingRequest(*workspaces.ImportClientBrandingInput) (*request.Request, *workspaces.ImportClientBrandingOutput)