Update upstream source from tag 'upstream/1.19.63+repack'

Update to upstream version '1.19.63+repack'
with Debian dir 2edc43320a
This commit is contained in:
Noah Meyerhans 2021-01-30 10:16:55 -08:00
commit ed7419efaf
23 changed files with 1578 additions and 281 deletions

View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.19.59
Version: 1.19.63
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

View file

@ -16,7 +16,7 @@ import os
import re
import logging
__version__ = '1.19.59'
__version__ = '1.19.63'
class NullHandler(logging.Handler):

View file

@ -85,7 +85,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes the specified analyzer. When you delete an analyzer, Access Analyzer is disabled for the account in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.</p>",
"documentation":"<p>Deletes the specified analyzer. When you delete an analyzer, Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.</p>",
"idempotent":true
},
"DeleteArchiveRule":{
@ -507,7 +507,7 @@
},
"status":{
"shape":"AnalyzerStatus",
"documentation":"<p>The status of the analyzer. An <code>Active</code> analyzer successfully monitors supported resources and generates new findings. The analyzer is <code>Disabled</code> when a user action, such as removing trusted access for IAM Access Analyzer from AWS Organizations, causes the analyzer to stop generating new findings. The status is <code>Creating</code> when the analyzer creation is in progress and <code>Failed</code> when the analyzer creation has failed. </p>"
"documentation":"<p>The status of the analyzer. An <code>Active</code> analyzer successfully monitors supported resources and generates new findings. The analyzer is <code>Disabled</code> when a user action, such as removing trusted access for AWS IAM Access Analyzer from AWS Organizations, causes the analyzer to stop generating new findings. The status is <code>Creating</code> when the analyzer creation is in progress and <code>Failed</code> when the analyzer creation has failed. </p>"
},
"statusReason":{
"shape":"StatusReason",
@ -643,7 +643,7 @@
},
"type":{
"shape":"Type",
"documentation":"<p>The type of analyzer to create. Only ACCOUNT analyzers are supported. You can create only one analyzer per account per Region.</p>"
"documentation":"<p>The type of analyzer to create. Only ACCOUNT and ORGANIZATION analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.</p>"
}
},
"documentation":"<p>Creates an analyzer.</p>"
@ -1377,7 +1377,8 @@
"AWS::SQS::Queue",
"AWS::Lambda::Function",
"AWS::Lambda::LayerVersion",
"AWS::KMS::Key"
"AWS::KMS::Key",
"AWS::SecretsManager::Secret"
]
},
"ServiceQuotaExceededException":{

View file

@ -225,7 +225,7 @@
"errors":[
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>The current feature settings for the AWS Account.</p>"
"documentation":"<p>Describes the global settings of the AWS account, including whether it is opted in to cross-account backup.</p>"
},
"DescribeProtectedResource":{
"name":"DescribeProtectedResource",
@ -799,7 +799,7 @@
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Updates the current global settings for the AWS Account. Use the <code>DescribeGlobalSettings</code> API to determine the current settings.</p>"
"documentation":"<p>Updates the current global settings for the AWS account. Use the <code>DescribeGlobalSettings</code> API to determine the current settings.</p>"
},
"UpdateRecoveryPointLifecycle":{
"name":"UpdateRecoveryPointLifecycle",
@ -815,7 +815,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Sets the transition lifecycle of a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>",
"documentation":"<p>Sets the transition lifecycle of a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>",
"idempotent":true
},
"UpdateRegionSettings":{
@ -844,7 +844,7 @@
"members":{
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS resource to be backed up. For VSS Windows backups, the only supported resource type is Amazon EC2.</p> <p>Valid values: <code>EC2</code>.</p>"
"documentation":"<p>Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows VSS. For an CloudFormation example, see the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html\">sample CloudFormation template to enable Windows VSS</a> in the <i>AWS Backup User Guide</i>.</p> <p>Valid values: <code>EC2</code>.</p>"
},
"BackupOptions":{
"shape":"BackupOptions",
@ -935,7 +935,7 @@
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
"documentation":"<p>Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either <code>AWSBackup</code> or <code>AwsBackup</code> in the role name. For example, <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names without those strings lack permissions to perform backup jobs.</p>"
},
"CreatedBy":{
"shape":"RecoveryPointCreator",
@ -1140,7 +1140,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
},
"RecoveryPointTags":{
"shape":"Tags",
@ -1186,7 +1186,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
},
"RecoveryPointTags":{
"shape":"Tags",
@ -1232,7 +1232,7 @@
},
"ListOfTags":{
"shape":"ListOfTags",
"documentation":"<p>An array of conditions used to specify a set of resources to assign to a backup plan; for example, <code>\"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\"</code>.</p>"
"documentation":"<p>An array of conditions used to specify a set of resources to assign to a backup plan; for example, <code>\"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\"</code>. Assigns the backup plan to every resource with at least one matching tag.</p>"
}
},
"documentation":"<p>Used to specify a set of resources to a backup plan.</p>"
@ -1350,7 +1350,7 @@
"documentation":"<p>A timestamp that specifies when to delete a recovery point.</p>"
}
},
"documentation":"<p>Contains <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps, which are used to specify a lifecycle for a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p>"
"documentation":"<p>Contains <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps, which are used to specify a lifecycle for a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
},
"Condition":{
"type":"structure",
@ -1562,7 +1562,7 @@
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
@ -1900,7 +1900,7 @@
},
"LastUpdateTime":{
"shape":"timestamp",
"documentation":"<p>The date and time that the global settings was last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of <code>LastUpdateTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
"documentation":"<p>The date and time that the global settings were last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of <code>LastUpdateTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
@ -2011,7 +2011,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
@ -2385,7 +2385,7 @@
"members":{
"ResourceTypes":{
"shape":"ResourceTypes",
"documentation":"<p>Contains a string with the supported AWS resource types:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>"
"documentation":"<p>Contains a string with the supported AWS resource types:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>"
}
}
},
@ -2445,7 +2445,7 @@
"documentation":"<p>Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus <code>MoveToColdStorageAfterDays</code>.</p>"
}
},
"documentation":"<p>Contains an array of <code>Transition</code> objects specifying how long in days before a recovery point transitions to cold storage or is deleted.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p>"
"documentation":"<p>Contains an array of <code>Transition</code> objects specifying how long in days before a recovery point transitions to cold storage or is deleted.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
},
"LimitExceededException":{
"type":"structure",
@ -2511,13 +2511,13 @@
},
"ByResourceType":{
"shape":"ResourceType",
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
},
"ByAccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.</p>",
"documentation":"<p>The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.</p> <p>If used from an AWS Organizations management account, passing <code>*</code> returns all jobs across the organization.</p>",
"location":"querystring",
"locationName":"accountId"
}
@ -2747,7 +2747,7 @@
},
"ByResourceType":{
"shape":"ResourceType",
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
},
@ -3157,7 +3157,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
@ -3394,15 +3394,15 @@
},
"StartWindowMinutes":{
"shape":"WindowMinutes",
"documentation":"<p>A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.</p>"
"documentation":"<p>A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.</p>"
},
"CompleteWindowMinutes":{
"shape":"WindowMinutes",
"documentation":"<p>A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.</p>"
"documentation":"<p>A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for <code>StartWindowMinutes</code>, or if the backup started later than scheduled.</p>"
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
},
"RecoveryPointTags":{
"shape":"Tags",
@ -3427,7 +3427,7 @@
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
"documentation":"<p>The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
@ -3472,7 +3472,7 @@
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a copy job is started, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
"documentation":"<p>The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
@ -3490,7 +3490,7 @@
},
"Metadata":{
"shape":"Metadata",
"documentation":"<p>A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.</p> <p> You can get configuration metadata about a resource at the time it was backed up by calling <code>GetRecoveryPointRestoreMetadata</code>. However, values in addition to those provided by <code>GetRecoveryPointRestoreMetadata</code> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</p> <p>You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:</p> <ul> <li> <p> <code>file-system-id</code>: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in <code>GetRecoveryPointRestoreMetadata</code>.</p> </li> <li> <p> <code>Encrypted</code>: A Boolean value that, if true, specifies that the file system is encrypted. If <code>KmsKeyId</code> is specified, <code>Encrypted</code> must be set to <code>true</code>.</p> </li> <li> <p> <code>KmsKeyId</code>: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.</p> </li> <li> <p> <code>PerformanceMode</code>: Specifies the throughput mode of the file system.</p> </li> <li> <p> <code>CreationToken</code>: A user-supplied value that ensures the uniqueness (idempotency) of the request.</p> </li> <li> <p> <code>newFileSystem</code>: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.</p> </li> <li> <p> <code>ItemsToRestore </code>: A serialized list of up to five strings where each string is a file path. Use <code>ItemsToRestore</code> to restore specific files or directories rather than the entire file system. This parameter is optional.</p> </li> </ul>"
"documentation":"<p>A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.</p> <p> You can get configuration metadata about a resource at the time it was backed up by calling <code>GetRecoveryPointRestoreMetadata</code>. However, values in addition to those provided by <code>GetRecoveryPointRestoreMetadata</code> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</p> <p>You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:</p> <ul> <li> <p> <code>file-system-id</code>: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in <code>GetRecoveryPointRestoreMetadata</code>.</p> </li> <li> <p> <code>Encrypted</code>: A Boolean value that, if true, specifies that the file system is encrypted. If <code>KmsKeyId</code> is specified, <code>Encrypted</code> must be set to <code>true</code>.</p> </li> <li> <p> <code>KmsKeyId</code>: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.</p> </li> <li> <p> <code>PerformanceMode</code>: Specifies the throughput mode of the file system.</p> </li> <li> <p> <code>CreationToken</code>: A user-supplied value that ensures the uniqueness (idempotency) of the request.</p> </li> <li> <p> <code>newFileSystem</code>: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.</p> </li> <li> <p> <code>ItemsToRestore </code>: An array of one to five strings where each string is a file path. Use <code>ItemsToRestore</code> to restore specific files or directories rather than the entire file system. This parameter is optional. For example, <code>\"itemsToRestore\":\"[\\\"/my.test\\\"]\"</code>.</p> </li> </ul>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
@ -3502,7 +3502,7 @@
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>Starts a job to restore a recovery point for one of the following resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>"
"documentation":"<p>Starts a job to restore a recovery point for one of the following resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>"
}
}
},
@ -3677,7 +3677,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
},
"CalculatedLifecycle":{
"shape":"CalculatedLifecycle",

View file

@ -1467,9 +1467,14 @@
"MaxDatapoints":{
"shape":"GetMetricDataMaxDatapoints",
"documentation":"<p>The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.</p>"
},
"LabelOptions":{
"shape":"LabelOptions",
"documentation":"<p>This structure includes the <code>Timezone</code> parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone. </p>"
}
}
},
"GetMetricDataLabelTimezone":{"type":"string"},
"GetMetricDataMaxDatapoints":{"type":"integer"},
"GetMetricDataOutput":{
"type":"structure",
@ -1854,6 +1859,16 @@
"exception":true,
"synthetic":true
},
"LabelOptions":{
"type":"structure",
"members":{
"Timezone":{
"shape":"GetMetricDataLabelTimezone",
"documentation":"<p>The time zone to use for metric data return in this operation. The format is <code>+</code> or <code>-</code> followed by four digits. The first two digits indicate the number of hours ahead or behind of UTC, and the final two digits are the number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30 minutes ahead of UTC. The default is +0000. </p>"
}
},
"documentation":"<p>This structure includes the <code>Timezone</code> parameter, which you can use to specify your time zone so that the labels that are associated with returned metrics display the correct time for your time zone. </p> <p>The <code>Timezone</code> value affects a label only if you have a time-based dynamic expression in the label. For more information about dynamic expressions in labels, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html\">Using Dynamic Labels</a>.</p>"
},
"LastModified":{"type":"timestamp"},
"LimitExceededException":{
"type":"structure",
@ -2192,7 +2207,7 @@
},
"Label":{
"shape":"MetricLabel",
"documentation":"<p>A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.</p>"
"documentation":"<p>A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.</p> <p>You can put dynamic expressions into a label, so that it is more descriptive. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html\">Using Dynamic Labels</a>.</p>"
},
"ReturnData":{
"shape":"ReturnData",

View file

@ -125,6 +125,12 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "QuickConnectSummaryList"
},
"ListQueueQuickConnects": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "QuickConnectSummaryList"
}
}
}

View file

@ -47,7 +47,7 @@
{"shape":"InvalidParameterException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.</p> <p>This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an Amazon S3 bucket, exists when being used for association.</p>"
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.</p> <p>This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.</p>"
},
"AssociateLambdaFunction":{
"name":"AssociateLambdaFunction",
@ -85,6 +85,23 @@
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.</p>"
},
"AssociateQueueQuickConnects":{
"name":"AssociateQueueQuickConnects",
"http":{
"method":"POST",
"requestUri":"/queues/{InstanceId}/{QueueId}/associate-quick-connects"
},
"input":{"shape":"AssociateQueueQuickConnectsRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a set of quick connects with a queue.</p>"
},
"AssociateRoutingProfileQueues":{
"name":"AssociateRoutingProfileQueues",
"http":{
@ -155,7 +172,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage (such as Amazon S3, or Kinesis) or allow for any configurations on features such as Contact Lens for Amazon Connect. </p>"
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. </p>"
},
"CreateIntegrationAssociation":{
"name":"CreateIntegrationAssociation",
@ -174,6 +191,25 @@
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Create an AppIntegration association with an Amazon Connect instance.</p>"
},
"CreateQueue":{
"name":"CreateQueue",
"http":{
"method":"PUT",
"requestUri":"/queues/{InstanceId}"
},
"input":{"shape":"CreateQueueRequest"},
"output":{"shape":"CreateQueueResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"DuplicateResourceException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates a new queue for the specified Amazon Connect instance.</p>"
},
"CreateQuickConnect":{
"name":"CreateQuickConnect",
"http":{
@ -378,6 +414,23 @@
],
"documentation":"<p>Describes the specified contact flow.</p> <p>You can also create and update contact flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p>"
},
"DescribeHoursOfOperation":{
"name":"DescribeHoursOfOperation",
"http":{
"method":"GET",
"requestUri":"/hours-of-operations/{InstanceId}/{HoursOfOperationId}"
},
"input":{"shape":"DescribeHoursOfOperationRequest"},
"output":{"shape":"DescribeHoursOfOperationResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the hours of operation.</p>"
},
"DescribeInstance":{
"name":"DescribeInstance",
"http":{
@ -391,7 +444,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status if applicable. </p> <p>If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.</p>"
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. </p> <p>If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.</p>"
},
"DescribeInstanceAttribute":{
"name":"DescribeInstanceAttribute",
@ -427,6 +480,23 @@
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.</p>"
},
"DescribeQueue":{
"name":"DescribeQueue",
"http":{
"method":"GET",
"requestUri":"/queues/{InstanceId}/{QueueId}"
},
"input":{"shape":"DescribeQueueRequest"},
"output":{"shape":"DescribeQueueResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified queue.</p>"
},
"DescribeQuickConnect":{
"name":"DescribeQuickConnect",
"http":{
@ -558,7 +628,7 @@
{"shape":"InvalidParameterException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Remove the Lambda function from the drop-down options available in the relevant contact flow blocks.</p>"
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Remove the Lambda function from the dropdown options available in the relevant contact flow blocks.</p>"
},
"DisassociateLexBot":{
"name":"DisassociateLexBot",
@ -576,6 +646,22 @@
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Revokes authorization from the specified instance to access the specified Amazon Lex bot.</p>"
},
"DisassociateQueueQuickConnects":{
"name":"DisassociateQueueQuickConnects",
"http":{
"method":"POST",
"requestUri":"/queues/{InstanceId}/{QueueId}/disassociate-quick-connects"
},
"input":{"shape":"DisassociateQueueQuickConnectsRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Disassociates a set of quick connects from a queue.</p>"
},
"DisassociateRoutingProfileQueues":{
"name":"DisassociateRoutingProfileQueues",
"http":{
@ -805,7 +891,7 @@
{"shape":"InvalidParameterException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all the Lambda functions that show up in the drop-down options in the relevant contact flow blocks.</p>"
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant contact flow blocks.</p>"
},
"ListLexBots":{
"name":"ListLexBots",
@ -858,6 +944,23 @@
],
"documentation":"<p>Provides information about the prompts for the specified Amazon Connect instance.</p>"
},
"ListQueueQuickConnects":{
"name":"ListQueueQuickConnects",
"http":{
"method":"GET",
"requestUri":"/queues/{InstanceId}/{QueueId}/quick-connects"
},
"input":{"shape":"ListQueueQuickConnectsRequest"},
"output":{"shape":"ListQueueQuickConnectsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Lists the quick connects associated with a queue.</p>"
},
"ListQueues":{
"name":"ListQueues",
"http":{
@ -907,7 +1010,7 @@
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>List the queues associated with a routing profile.</p>"
"documentation":"<p>Lists the queues associated with a routing profile.</p>"
},
"ListRoutingProfiles":{
"name":"ListRoutingProfiles",
@ -991,7 +1094,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>List the use cases. </p>"
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Lists the use cases. </p>"
},
"ListUserHierarchyGroups":{
"name":"ListUserHierarchyGroups",
@ -1057,7 +1160,7 @@
{"shape":"InternalServiceException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p> <p>When a new chat contact is successfully created, clients need to subscribe to the participants connection for the created chat within 5 minutes. This is achieved by invoking <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p> <p>A 429 error occurs in two situations:</p> <ul> <li> <p>API rate limit is exceeded. API TPS throttling returns a <code>TooManyRequests</code> exception from the API Gateway.</p> </li> <li> <p>The <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">quota for concurrent active chats</a> is exceeded. Active chat throttling returns a <code>LimitExceededException</code>.</p> </li> </ul> <p>For more information about how chat works, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat.html\">Chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
"documentation":"<p>Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p> <p>When a new chat contact is successfully created, clients must subscribe to the participants connection for the created chat within 5 minutes. This is achieved by invoking <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p> <p>A 429 error occurs in two situations:</p> <ul> <li> <p>API rate limit is exceeded. API TPS throttling returns a <code>TooManyRequests</code> exception from the API Gateway.</p> </li> <li> <p>The <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">quota for concurrent active chats</a> is exceeded. Active chat throttling returns a <code>LimitExceededException</code>.</p> </li> </ul> <p>For more information about chat, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat.html\">Chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
},
"StartContactRecording":{
"name":"StartContactRecording",
@ -1073,7 +1176,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.</p> <p>You can use this API to override the recording behavior configured in the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html\">Set recording behavior</a> block.</p> <p>Only voice recordings are supported at this time.</p>"
"documentation":"<p>Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.</p> <p>You can use this API to override the recording behavior configured in the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html\">Set recording behavior</a> block.</p> <p>Only voice recordings are supported at this time.</p>"
},
"StartOutboundVoiceContact":{
"name":"StartOutboundVoiceContact",
@ -1092,7 +1195,7 @@
{"shape":"DestinationNotAllowedException"},
{"shape":"OutboundContactNotPermittedException"}
],
"documentation":"<p>This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in <code>ContactFlowId</code>).</p> <p>Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case.</p> <p>There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.</p> <note> <p>UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </note>"
"documentation":"<p>Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in <code>ContactFlowId</code>).</p> <p>Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.</p> <p>There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.</p> <note> <p>UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </note>"
},
"StartTaskContact":{
"name":"StartTaskContact",
@ -1142,7 +1245,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>When a contact is being recorded, this API stops recording the call. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.</p> <p>Only voice recordings are supported at this time.</p>"
"documentation":"<p>Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.</p> <p>Only voice recordings are supported at this time.</p>"
},
"SuspendContactRecording":{
"name":"SuspendContactRecording",
@ -1173,7 +1276,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Adds the specified tags to the specified resource.</p> <p>The supported resource types are users, routing profiles, quick connects, and contact flows.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
"documentation":"<p>Adds the specified tags to the specified resource.</p> <p>The supported resource types are users, routing profiles, queues, quick connects, and contact flows.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -1205,7 +1308,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Creates or updates the contact attributes associated with the specified contact.</p> <p>You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.</p> <p>Contact attributes are available in Amazon Connect for 24 months, and are then deleted.</p> <p> <b>Important:</b> You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.</p>"
"documentation":"<p>Creates or updates the contact attributes associated with the specified contact.</p> <p>You can add or update attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.</p> <p>Contact attributes are available in Amazon Connect for 24 months, and are then deleted.</p> <p> <b>Important:</b> You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.</p>"
},
"UpdateContactFlowContent":{
"name":"UpdateContactFlowContent",
@ -1273,6 +1376,87 @@
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates an existing configuration for a resource type. This API is idempotent.</p>"
},
"UpdateQueueHoursOfOperation":{
"name":"UpdateQueueHoursOfOperation",
"http":{
"method":"POST",
"requestUri":"/queues/{InstanceId}/{QueueId}/hours-of-operation"
},
"input":{"shape":"UpdateQueueHoursOfOperationRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the hours of operation for the specified queue.</p>"
},
"UpdateQueueMaxContacts":{
"name":"UpdateQueueMaxContacts",
"http":{
"method":"POST",
"requestUri":"/queues/{InstanceId}/{QueueId}/max-contacts"
},
"input":{"shape":"UpdateQueueMaxContactsRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the maximum number of contacts allowed in a queue before it is considered full.</p>"
},
"UpdateQueueName":{
"name":"UpdateQueueName",
"http":{
"method":"POST",
"requestUri":"/queues/{InstanceId}/{QueueId}/name"
},
"input":{"shape":"UpdateQueueNameRequest"},
"errors":[
{"shape":"DuplicateResourceException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the name and description of a queue. At least <code>Name</code> or <code>Description</code> must be provided.</p>"
},
"UpdateQueueOutboundCallerConfig":{
"name":"UpdateQueueOutboundCallerConfig",
"http":{
"method":"POST",
"requestUri":"/queues/{InstanceId}/{QueueId}/outbound-caller-config"
},
"input":{"shape":"UpdateQueueOutboundCallerConfigRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.</p>"
},
"UpdateQueueStatus":{
"name":"UpdateQueueStatus",
"http":{
"method":"POST",
"requestUri":"/queues/{InstanceId}/{QueueId}/status"
},
"input":{"shape":"UpdateQueueStatusRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the status of the queue.</p>"
},
"UpdateQuickConnectConfig":{
"name":"UpdateQuickConnectConfig",
"http":{
@ -1303,7 +1487,7 @@
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.</p>"
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least <code>Name</code> or <code>Description</code> must be provided.</p>"
},
"UpdateRoutingProfileConcurrency":{
"name":"UpdateRoutingProfileConcurrency",
@ -1434,7 +1618,7 @@
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Updates the identity information for the specified user.</p> <important> <p>Someone with the ability to invoke <code>UpdateUserIndentityInfo</code> can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke <code>UpdateUserIndentityInfo</code>. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html\">Best Practices for Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>.</p> </important>"
"documentation":"<p>Updates the identity information for the specified user.</p> <important> <p>We strongly recommend limiting who has the ability to invoke <code>UpdateUserIdentityInfo</code>. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html\">Best Practices for Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>.</p> </important>"
},
"UpdateUserPhoneConfig":{
"name":"UpdateUserPhoneConfig",
@ -1596,6 +1780,32 @@
}
}
},
"AssociateQueueQuickConnectsRequest":{
"type":"structure",
"required":[
"InstanceId",
"QueueId",
"QuickConnectIds"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>",
"location":"uri",
"locationName":"QueueId"
},
"QuickConnectIds":{
"shape":"QuickConnectsList",
"documentation":"<p>The quick connects to associate with this queue.</p>"
}
}
},
"AssociateRoutingProfileQueuesRequest":{
"type":"structure",
"required":[
@ -1709,7 +1919,7 @@
"Channels":{
"type":"list",
"member":{"shape":"Channel"},
"max":3
"max":1
},
"ChatContent":{
"type":"string",
@ -1730,7 +1940,7 @@
"members":{
"ContentType":{
"shape":"ChatContentType",
"documentation":"<p>The type of the content. Supported types are text/plain.</p>"
"documentation":"<p>The type of the content. Supported types are text and plain.</p>"
},
"Content":{
"shape":"ChatContent",
@ -1743,6 +1953,16 @@
"type":"string",
"max":500
},
"CommonDescriptionLength250":{
"type":"string",
"max":250,
"min":0
},
"CommonNameLength127":{
"type":"string",
"max":127,
"min":1
},
"Comparison":{
"type":"string",
"enum":["LT"]
@ -1948,11 +2168,11 @@
},
"InboundCallsEnabled":{
"shape":"InboundCallsEnabled",
"documentation":"<p>Whether your contact center handles incoming contacts.</p>"
"documentation":"<p>Your contact center handles incoming contacts.</p>"
},
"OutboundCallsEnabled":{
"shape":"OutboundCallsEnabled",
"documentation":"<p>Whether your contact center allows outbound calls.</p>"
"documentation":"<p>Your contact center allows outbound calls.</p>"
}
}
},
@ -2021,6 +2241,64 @@
}
}
},
"CreateQueueRequest":{
"type":"structure",
"required":[
"InstanceId",
"Name",
"HoursOfOperationId"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"Name":{
"shape":"CommonNameLength127",
"documentation":"<p>The name of the queue.</p>"
},
"Description":{
"shape":"QueueDescription",
"documentation":"<p>The description of the queue.</p>"
},
"OutboundCallerConfig":{
"shape":"OutboundCallerConfig",
"documentation":"<p>The outbound caller ID name, number, and outbound whisper flow.</p>"
},
"HoursOfOperationId":{
"shape":"HoursOfOperationId",
"documentation":"<p>The identifier for the hours of operation.</p>"
},
"MaxContacts":{
"shape":"QueueMaxContacts",
"documentation":"<p>The maximum number of contacts that can be in the queue before it is considered full.</p>",
"box":true
},
"QuickConnectIds":{
"shape":"QuickConnectsList",
"documentation":"<p>The quick connects available to agents who are working the queue.</p>"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>One or more tags.</p>"
}
}
},
"CreateQueueResponse":{
"type":"structure",
"members":{
"QueueArn":{
"shape":"ARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the queue.</p>"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>"
}
}
},
"CreateQuickConnectRequest":{
"type":"structure",
"required":[
@ -2096,11 +2374,11 @@
},
"QueueConfigs":{
"shape":"RoutingProfileQueueConfigList",
"documentation":"<p>The inbound queues associated with the routing profile. If no queue is added, the agent can only make outbound calls.</p>"
"documentation":"<p>The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.</p>"
},
"MediaConcurrencies":{
"shape":"MediaConcurrencies",
"documentation":"<p>The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>"
"documentation":"<p>The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.</p>"
},
"Tags":{
"shape":"TagMap",
@ -2518,6 +2796,36 @@
}
}
},
"DescribeHoursOfOperationRequest":{
"type":"structure",
"required":[
"InstanceId",
"HoursOfOperationId"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"HoursOfOperationId":{
"shape":"HoursOfOperationId",
"documentation":"<p>The identifier for the hours of operation.</p>",
"location":"uri",
"locationName":"HoursOfOperationId"
}
}
},
"DescribeHoursOfOperationResponse":{
"type":"structure",
"members":{
"HoursOfOperation":{
"shape":"HoursOfOperation",
"documentation":"<p>The hours of operation.</p>"
}
}
},
"DescribeInstanceAttributeRequest":{
"type":"structure",
"required":[
@ -2606,6 +2914,36 @@
}
}
},
"DescribeQueueRequest":{
"type":"structure",
"required":[
"InstanceId",
"QueueId"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>",
"location":"uri",
"locationName":"QueueId"
}
}
},
"DescribeQueueResponse":{
"type":"structure",
"members":{
"Queue":{
"shape":"Queue",
"documentation":"<p>The name of the queue.</p>"
}
}
},
"DescribeQuickConnectRequest":{
"type":"structure",
"required":[
@ -2757,7 +3095,7 @@
"members":{
"Message":{
"shape":"Message",
"documentation":"<p>The message.</p>"
"documentation":"<p>The message about the outbound calls.</p>"
}
},
"documentation":"<p>Outbound calls to the destination number are not allowed.</p>",
@ -2898,6 +3236,32 @@
}
}
},
"DisassociateQueueQuickConnectsRequest":{
"type":"structure",
"required":[
"InstanceId",
"QueueId",
"QuickConnectIds"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>",
"location":"uri",
"locationName":"QueueId"
},
"QuickConnectIds":{
"shape":"QuickConnectsList",
"documentation":"<p>The quick connects to disassociate from the queue.</p>"
}
}
},
"DisassociateRoutingProfileQueuesRequest":{
"type":"structure",
"required":[
@ -3067,7 +3431,7 @@
},
"MaxResults":{
"shape":"MaxResult100",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true
}
}
@ -3152,7 +3516,7 @@
},
"MaxResults":{
"shape":"MaxResult100",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true
}
}
@ -3441,6 +3805,79 @@
"max":87600,
"min":0
},
"Hours24Format":{
"type":"integer",
"max":23,
"min":0
},
"HoursOfOperation":{
"type":"structure",
"members":{
"HoursOfOperationId":{
"shape":"HoursOfOperationId",
"documentation":"<p>The identifier for the hours of operation.</p>"
},
"HoursOfOperationArn":{
"shape":"ARN",
"documentation":"<p>The Amazon Resource Name (ARN) for the hours of operation.</p>"
},
"Name":{
"shape":"CommonNameLength127",
"documentation":"<p>The name for the hours of operation.</p>"
},
"Description":{
"shape":"CommonDescriptionLength250",
"documentation":"<p>The description for the hours of operation.</p>"
},
"TimeZone":{
"shape":"TimeZone",
"documentation":"<p>The time zone for the hours of operation.</p>"
},
"Config":{
"shape":"HoursOfOperationConfigList",
"documentation":"<p>Configuration information for the hours of operation.</p>"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>One or more tags.</p>"
}
},
"documentation":"<p>Information about of the hours of operation.</p>"
},
"HoursOfOperationConfig":{
"type":"structure",
"members":{
"Day":{
"shape":"HoursOfOperationDays",
"documentation":"<p>The day that the hours of operation applies to.</p>"
},
"StartTime":{
"shape":"HoursOfOperationTimeSlice",
"documentation":"<p>The start time that your contact center is open.</p>"
},
"EndTime":{
"shape":"HoursOfOperationTimeSlice",
"documentation":"<p>The end time that your contact center is closes.</p>"
}
},
"documentation":"<p>Contains information about the hours of operation.</p>"
},
"HoursOfOperationConfigList":{
"type":"list",
"member":{"shape":"HoursOfOperationConfig"}
},
"HoursOfOperationDays":{
"type":"string",
"enum":[
"SUNDAY",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY"
]
},
"HoursOfOperationId":{"type":"string"},
"HoursOfOperationName":{"type":"string"},
"HoursOfOperationSummary":{
@ -3465,6 +3902,20 @@
"type":"list",
"member":{"shape":"HoursOfOperationSummary"}
},
"HoursOfOperationTimeSlice":{
"type":"structure",
"members":{
"Hours":{
"shape":"Hours24Format",
"documentation":"<p>The hours.</p>"
},
"Minutes":{
"shape":"MinutesLimit60",
"documentation":"<p>The minutes.</p>"
}
},
"documentation":"<p>The start time or end time for an hours of operation.</p>"
},
"InboundCallsEnabled":{"type":"boolean"},
"Instance":{
"type":"structure",
@ -3566,7 +4017,7 @@
},
"S3Config":{
"shape":"S3Config",
"documentation":"<p>The S3 configuration.</p>"
"documentation":"<p>The S3 bucket configuration.</p>"
},
"KinesisVideoStreamConfig":{
"shape":"KinesisVideoStreamConfig",
@ -3703,7 +4154,7 @@
"documentation":"<p>The message.</p>"
}
},
"documentation":"<p>Request processing failed due to an error or failure with the service.</p>",
"documentation":"<p>Request processing failed because of an error or failure with the service.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
@ -3724,7 +4175,7 @@
"members":{
"Message":{
"shape":"Message",
"documentation":"<p>The message.</p>"
"documentation":"<p>The message about the parameters.</p>"
}
},
"documentation":"<p>One or more of the specified parameters are not valid.</p>",
@ -3736,7 +4187,7 @@
"members":{
"Message":{
"shape":"Message",
"documentation":"<p>The message.</p>"
"documentation":"<p>The message about the request.</p>"
}
},
"documentation":"<p>The request is not valid.</p>",
@ -3757,7 +4208,7 @@
"documentation":"<p>The Amazon Resource Name (ARN) of the delivery stream.</p>"
}
},
"documentation":"<p>Configuration information of a Kinesis Firehose delivery stream.</p>"
"documentation":"<p>Configuration information of a Kinesis Data Firehose delivery stream.</p>"
},
"KinesisStreamConfig":{
"type":"structure",
@ -3802,7 +4253,7 @@
},
"LexRegion":{
"shape":"LexRegion",
"documentation":"<p>The Region the Amazon Lex bot was created in.</p>"
"documentation":"<p>The Region that the Amazon Lex bot was created in.</p>"
}
},
"documentation":"<p>Configuration information of an Amazon Lex bot.</p>"
@ -3820,7 +4271,7 @@
"members":{
"Message":{
"shape":"Message",
"documentation":"<p>The message.</p>"
"documentation":"<p>The message about the limit.</p>"
}
},
"documentation":"<p>The allowed limit for the resource has been exceeded.</p>",
@ -3845,7 +4296,7 @@
},
"MaxResults":{
"shape":"MaxResult25",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -3889,7 +4340,7 @@
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"location":"querystring",
"locationName":"maxResults"
}
@ -3926,7 +4377,7 @@
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"location":"querystring",
"locationName":"maxResults"
}
@ -3963,7 +4414,7 @@
},
"MaxResults":{
"shape":"MaxResult7",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4010,7 +4461,7 @@
},
"MaxResults":{
"shape":"MaxResult10",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4041,7 +4492,7 @@
},
"MaxResults":{
"shape":"MaxResult10",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4079,7 +4530,7 @@
},
"MaxResults":{
"shape":"MaxResult100",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4117,7 +4568,7 @@
},
"MaxResults":{
"shape":"MaxResult25",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4155,7 +4606,7 @@
},
"MaxResults":{
"shape":"MaxResult25",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4167,7 +4618,7 @@
"members":{
"LexBots":{
"shape":"LexBotsList",
"documentation":"<p>The the names and regions of the Amazon Lex bots associated with the specified instance.</p>"
"documentation":"<p>The names and Regions of the Amazon Lex bots associated with the specified instance.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -4205,7 +4656,7 @@
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"location":"querystring",
"locationName":"maxResults"
}
@ -4262,6 +4713,53 @@
}
}
},
"ListQueueQuickConnectsRequest":{
"type":"structure",
"required":[
"InstanceId",
"QueueId"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>",
"location":"uri",
"locationName":"QueueId"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResult100",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListQueueQuickConnectsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If there are additional results, this is the token for the next set of results.</p>"
},
"QuickConnectSummaryList":{
"shape":"QuickConnectSummaryList",
"documentation":"<p>Information about the quick connects.</p>"
}
}
},
"ListQueuesRequest":{
"type":"structure",
"required":["InstanceId"],
@ -4286,7 +4784,7 @@
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"location":"querystring",
"locationName":"maxResults"
}
@ -4323,7 +4821,7 @@
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4376,7 +4874,7 @@
},
"MaxResults":{
"shape":"MaxResult100",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4414,7 +4912,7 @@
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4452,7 +4950,7 @@
},
"MaxResults":{
"shape":"MaxResult2",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4490,7 +4988,7 @@
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4558,7 +5056,7 @@
},
"MaxResults":{
"shape":"MaxResult100",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4597,7 +5095,7 @@
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4635,7 +5133,7 @@
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximimum number of results to return per page.</p>",
"documentation":"<p>The maximum number of results to return per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
@ -4708,6 +5206,11 @@
"documentation":"<p>Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.</p>"
},
"Message":{"type":"string"},
"MinutesLimit60":{
"type":"integer",
"max":59,
"min":0
},
"Name":{
"type":"string",
"max":512,
@ -4722,13 +5225,36 @@
"type":"list",
"member":{"shape":"Origin"}
},
"OutboundCallerConfig":{
"type":"structure",
"members":{
"OutboundCallerIdName":{
"shape":"OutboundCallerIdName",
"documentation":"<p>The caller ID name.</p>"
},
"OutboundCallerIdNumberId":{
"shape":"PhoneNumberId",
"documentation":"<p>The caller ID number.</p>"
},
"OutboundFlowId":{
"shape":"ContactFlowId",
"documentation":"<p>The outbound whisper flow to be used during an outbound call.</p>"
}
},
"documentation":"<p>The outbound caller ID name, number, and outbound whisper flow.</p>"
},
"OutboundCallerIdName":{
"type":"string",
"max":255,
"min":1
},
"OutboundCallsEnabled":{"type":"boolean"},
"OutboundContactNotPermittedException":{
"type":"structure",
"members":{
"Message":{
"shape":"Message",
"documentation":"<p>The message.</p>"
"documentation":"<p>The message about the contact.</p>"
}
},
"documentation":"<p>The contact is not permitted.</p>",
@ -5137,7 +5663,59 @@
"type":"list",
"member":{"shape":"PromptSummary"}
},
"Queue":{
"type":"structure",
"members":{
"Name":{
"shape":"CommonNameLength127",
"documentation":"<p>The name of the queue.</p>"
},
"QueueArn":{
"shape":"ARN",
"documentation":"<p>The Amazon Resource Name (ARN) for the queue.</p>"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>"
},
"Description":{
"shape":"QueueDescription",
"documentation":"<p>The description of the queue.</p>"
},
"OutboundCallerConfig":{
"shape":"OutboundCallerConfig",
"documentation":"<p>The outbound caller ID name, number, and outbound whisper flow.</p>"
},
"HoursOfOperationId":{
"shape":"HoursOfOperationId",
"documentation":"<p>The identifier for the hours of operation.</p>"
},
"MaxContacts":{
"shape":"QueueMaxContacts",
"documentation":"<p>The maximum number of contacts that can be in the queue before it is considered full.</p>",
"box":true
},
"Status":{
"shape":"QueueStatus",
"documentation":"<p>The status of the queue.</p>"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>One or more tags.</p>"
}
},
"documentation":"<p>Contains information about a queue.</p>"
},
"QueueDescription":{
"type":"string",
"max":250,
"min":1
},
"QueueId":{"type":"string"},
"QueueMaxContacts":{
"type":"integer",
"min":0
},
"QueueName":{
"type":"string",
"max":256,
@ -5152,7 +5730,7 @@
"members":{
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier of the queue.</p>"
"documentation":"<p>The identifier for the queue.</p>"
},
"ContactFlowId":{
"shape":"ContactFlowId",
@ -5175,6 +5753,13 @@
},
"documentation":"<p>Contains information about a queue resource for which metrics are returned.</p>"
},
"QueueStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"QueueSummary":{
"type":"structure",
"members":{
@ -5292,11 +5877,11 @@
},
"Arn":{
"shape":"ARN",
"documentation":"<p>The Amazon Resource Name (ARN).</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the quick connect.</p>"
},
"Name":{
"shape":"QuickConnectName",
"documentation":"<p>The name.</p>"
"documentation":"<p>The name of the quick connect.</p>"
},
"QuickConnectType":{
"shape":"QuickConnectType",
@ -5322,6 +5907,12 @@
"member":{"shape":"QuickConnectType"},
"max":3
},
"QuickConnectsList":{
"type":"list",
"member":{"shape":"QuickConnectId"},
"max":50,
"min":1
},
"Reference":{
"type":"structure",
"required":[
@ -5331,7 +5922,7 @@
"members":{
"Value":{
"shape":"ReferenceValue",
"documentation":"<p>A formatted URL that will be shown to an agent in the Contact Control Panel (CCP)</p>"
"documentation":"<p>A formatted URL that displays to an agent in the Contact Control Panel (CCP)</p>"
},
"Type":{
"shape":"ReferenceType",
@ -5385,7 +5976,7 @@
"members":{
"Message":{
"shape":"Message",
"documentation":"<p>The message.</p>"
"documentation":"<p>The message about the resource.</p>"
}
},
"documentation":"<p>The specified resource was not found.</p>",
@ -5524,7 +6115,7 @@
"members":{
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier of the queue.</p>"
"documentation":"<p>The identifier for the queue.</p>"
},
"QueueArn":{
"shape":"ARN",
@ -5562,7 +6153,7 @@
"members":{
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier of the queue.</p>"
"documentation":"<p>The identifier for the queue.</p>"
},
"Channel":{
"shape":"Channel",
@ -5614,10 +6205,10 @@
},
"EncryptionConfig":{
"shape":"EncryptionConfig",
"documentation":"<p>The S3 encryption configuration.</p>"
"documentation":"<p>The Amazon S3 encryption configuration.</p>"
}
},
"documentation":"<p>Information about the S3 storage type.</p>"
"documentation":"<p>Information about the Amazon Simple Storage Service (Amazon S3) storage type.</p>"
},
"SecurityKey":{
"type":"structure",
@ -5715,7 +6306,7 @@
},
"Attributes":{
"shape":"Attributes",
"documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes. </p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>"
"documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes. </p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>"
},
"ParticipantDetails":{
"shape":"ParticipantDetails",
@ -5772,7 +6363,7 @@
},
"VoiceRecordingConfiguration":{
"shape":"VoiceRecordingConfiguration",
"documentation":"<p>Who is being recorded.</p>"
"documentation":"<p>The person being recorded.</p>"
}
}
},
@ -6042,6 +6633,7 @@
"error":{"httpStatusCode":429},
"exception":true
},
"TimeZone":{"type":"string"},
"Timestamp":{"type":"timestamp"},
"URI":{
"type":"string",
@ -6215,6 +6807,140 @@
"StorageConfig":{"shape":"InstanceStorageConfig"}
}
},
"UpdateQueueHoursOfOperationRequest":{
"type":"structure",
"required":[
"InstanceId",
"QueueId",
"HoursOfOperationId"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>",
"location":"uri",
"locationName":"QueueId"
},
"HoursOfOperationId":{
"shape":"HoursOfOperationId",
"documentation":"<p>The identifier for the hours of operation.</p>"
}
}
},
"UpdateQueueMaxContactsRequest":{
"type":"structure",
"required":[
"InstanceId",
"QueueId",
"MaxContacts"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>",
"location":"uri",
"locationName":"QueueId"
},
"MaxContacts":{
"shape":"QueueMaxContacts",
"documentation":"<p>The maximum number of contacts that can be in the queue before it is considered full.</p>",
"box":true
}
}
},
"UpdateQueueNameRequest":{
"type":"structure",
"required":[
"InstanceId",
"QueueId"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>",
"location":"uri",
"locationName":"QueueId"
},
"Name":{
"shape":"CommonNameLength127",
"documentation":"<p>The name of the queue.</p>"
},
"Description":{
"shape":"QueueDescription",
"documentation":"<p>The description of the queue.</p>"
}
}
},
"UpdateQueueOutboundCallerConfigRequest":{
"type":"structure",
"required":[
"InstanceId",
"QueueId",
"OutboundCallerConfig"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>",
"location":"uri",
"locationName":"QueueId"
},
"OutboundCallerConfig":{
"shape":"OutboundCallerConfig",
"documentation":"<p>The outbound caller ID name, number, and outbound whisper flow.</p>"
}
}
},
"UpdateQueueStatusRequest":{
"type":"structure",
"required":[
"InstanceId",
"QueueId",
"Status"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The identifier for the queue.</p>",
"location":"uri",
"locationName":"QueueId"
},
"Status":{
"shape":"QueueStatus",
"documentation":"<p>The status of the queue.</p>"
}
}
},
"UpdateQuickConnectConfigRequest":{
"type":"structure",
"required":[
@ -6292,7 +7018,7 @@
},
"MediaConcurrencies":{
"shape":"MediaConcurrencies",
"documentation":"<p>The channels agents can handle in the Contact Control Panel (CCP).</p>"
"documentation":"<p>The channels that agents can handle in the Contact Control Panel (CCP).</p>"
}
}
},
@ -6740,5 +7466,5 @@
},
"timestamp":{"type":"timestamp"}
},
"documentation":"<p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p> <p>Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.</p> <p>There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connect endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect Endpoints</a>.</p> <note> <p>Working with contact flows? Check out the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p> </note>"
"documentation":"<p>Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p> <p>Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.</p> <p>There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect Endpoints</a>.</p> <note> <p>Working with contact flows? Check out the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html\">Amazon Connect Flow language</a>.</p> </note>"
}

View file

@ -802,7 +802,10 @@
},
"DeleteIntegrationRequest":{
"type":"structure",
"required":["DomainName"],
"required":[
"DomainName",
"Uri"
],
"members":{
"DomainName":{
"shape":"name",
@ -1070,7 +1073,10 @@
},
"GetIntegrationRequest":{
"type":"structure",
"required":["DomainName"],
"required":[
"DomainName",
"Uri"
],
"members":{
"DomainName":{
"shape":"name",

View file

@ -25,7 +25,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Deletes one or more versions of a recipe at a time.</p>"
"documentation":"<p>Deletes one or more versions of a recipe at a time.</p> <p>The entire request will be rejected if:</p> <ul> <li> <p>The recipe does not exist.</p> </li> <li> <p>There is an invalid version identifier in the list of versions.</p> </li> <li> <p>The verision list is empty.</p> </li> <li> <p>The version list size exceeds 50.</p> </li> <li> <p>The verison list contains duplicate entries.</p> </li> </ul> <p>The request will complete successfully, but with partial failures, if:</p> <ul> <li> <p>A version does not exist.</p> </li> <li> <p>A version is being used by a job.</p> </li> <li> <p>You specify <code>LATEST_WORKING</code>, but it's being used by a project.</p> </li> <li> <p>The version fails to be deleted.</p> </li> </ul> <p>The <code>LATEST_WORKING</code> version will only be deleted if the recipe has no other versions. If you try to delete <code>LATEST_WORKING</code> while other versions exist (or if they can't be deleted), then <code>LATEST_WORKING</code> will be listed as partial failure in the response.</p>"
},
"CreateDataset":{
"name":"CreateDataset",
@ -41,7 +41,7 @@
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Creates a new AWS Glue DataBrew dataset for this AWS account.</p>"
"documentation":"<p>Creates a new DataBrew dataset.</p>"
},
"CreateProfileJob":{
"name":"CreateProfileJob",
@ -52,9 +52,13 @@
"input":{"shape":"CreateProfileJobRequest"},
"output":{"shape":"CreateProfileJobResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Creates a new job to profile an AWS Glue DataBrew dataset that exists in the current AWS account.</p>"
"documentation":"<p>Creates a new job to analyze a dataset and create its data profile.</p>"
},
"CreateProject":{
"name":"CreateProject",
@ -70,7 +74,7 @@
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Creates a new AWS Glue DataBrew project in the current AWS account.</p>"
"documentation":"<p>Creates a new DataBrew project.</p>"
},
"CreateRecipe":{
"name":"CreateRecipe",
@ -85,7 +89,7 @@
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Creates a new AWS Glue DataBrew recipe for the current AWS account.</p>"
"documentation":"<p>Creates a new DataBrew recipe.</p>"
},
"CreateRecipeJob":{
"name":"CreateRecipeJob",
@ -96,9 +100,13 @@
"input":{"shape":"CreateRecipeJobRequest"},
"output":{"shape":"CreateRecipeJobResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Creates a new job for an existing AWS Glue DataBrew recipe in the current AWS account. You can create a standalone job using either a project, or a combination of a recipe and a dataset.</p>"
"documentation":"<p>Creates a new job to transform input data, using steps defined in an existing AWS Glue DataBrew recipe</p>"
},
"CreateSchedule":{
"name":"CreateSchedule",
@ -109,9 +117,11 @@
"input":{"shape":"CreateScheduleRequest"},
"output":{"shape":"CreateScheduleResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Creates a new schedule for one or more AWS Glue DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.</p>"
"documentation":"<p>Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.</p>"
},
"DeleteDataset":{
"name":"DeleteDataset",
@ -122,10 +132,11 @@
"input":{"shape":"DeleteDatasetRequest"},
"output":{"shape":"DeleteDatasetResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Deletes a dataset from AWS Glue DataBrew.</p>"
"documentation":"<p>Deletes a dataset from DataBrew.</p>"
},
"DeleteJob":{
"name":"DeleteJob",
@ -136,10 +147,11 @@
"input":{"shape":"DeleteJobRequest"},
"output":{"shape":"DeleteJobResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Deletes the specified AWS Glue DataBrew job from the current AWS account. The job can be for a recipe or for a profile.</p>"
"documentation":"<p>Deletes the specified DataBrew job.</p>"
},
"DeleteProject":{
"name":"DeleteProject",
@ -150,10 +162,11 @@
"input":{"shape":"DeleteProjectRequest"},
"output":{"shape":"DeleteProjectResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Deletes an existing AWS Glue DataBrew project from the current AWS account.</p>"
"documentation":"<p>Deletes an existing DataBrew project.</p>"
},
"DeleteRecipeVersion":{
"name":"DeleteRecipeVersion",
@ -164,10 +177,11 @@
"input":{"shape":"DeleteRecipeVersionRequest"},
"output":{"shape":"DeleteRecipeVersionResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Deletes a single version of an AWS Glue DataBrew recipe.</p>"
"documentation":"<p>Deletes a single version of a DataBrew recipe.</p>"
},
"DeleteSchedule":{
"name":"DeleteSchedule",
@ -181,7 +195,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Deletes the specified AWS Glue DataBrew schedule from the current AWS account.</p>"
"documentation":"<p>Deletes the specified DataBrew schedule.</p>"
},
"DescribeDataset":{
"name":"DescribeDataset",
@ -195,7 +209,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns the definition of a specific AWS Glue DataBrew dataset that is in the current AWS account.</p>"
"documentation":"<p>Returns the definition of a specific DataBrew dataset.</p>"
},
"DescribeJob":{
"name":"DescribeJob",
@ -209,7 +223,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns the definition of a specific AWS Glue DataBrew job that is in the current AWS account.</p>"
"documentation":"<p>Returns the definition of a specific DataBrew job.</p>"
},
"DescribeProject":{
"name":"DescribeProject",
@ -223,7 +237,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns the definition of a specific AWS Glue DataBrew project that is in the current AWS account.</p>"
"documentation":"<p>Returns the definition of a specific DataBrew project.</p>"
},
"DescribeRecipe":{
"name":"DescribeRecipe",
@ -237,7 +251,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns the definition of a specific AWS Glue DataBrew recipe that is in the current AWS account.</p>"
"documentation":"<p>Returns the definition of a specific DataBrew recipe corresponding to a particular version.</p>"
},
"DescribeSchedule":{
"name":"DescribeSchedule",
@ -251,7 +265,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns the definition of a specific AWS Glue DataBrew schedule that is in the current AWS account.</p>"
"documentation":"<p>Returns the definition of a specific DataBrew schedule.</p>"
},
"ListDatasets":{
"name":"ListDatasets",
@ -264,7 +278,7 @@
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Lists all of the AWS Glue DataBrew datasets for the current AWS account.</p>"
"documentation":"<p>Lists all of the DataBrew datasets.</p>"
},
"ListJobRuns":{
"name":"ListJobRuns",
@ -278,7 +292,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Lists all of the previous runs of a particular AWS Glue DataBrew job in the current AWS account.</p>"
"documentation":"<p>Lists all of the previous runs of a particular DataBrew job.</p>"
},
"ListJobs":{
"name":"ListJobs",
@ -291,7 +305,7 @@
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Lists the AWS Glue DataBrew jobs in the current AWS account.</p>"
"documentation":"<p>Lists all of the DataBrew jobs that are defined.</p>"
},
"ListProjects":{
"name":"ListProjects",
@ -304,7 +318,7 @@
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Lists all of the DataBrew projects in the current AWS account.</p>"
"documentation":"<p>Lists all of the DataBrew projects that are defined.</p>"
},
"ListRecipeVersions":{
"name":"ListRecipeVersions",
@ -317,7 +331,7 @@
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Lists all of the versions of a particular AWS Glue DataBrew recipe in the current AWS account.</p>"
"documentation":"<p>Lists the versions of a particular DataBrew recipe, except for <code>LATEST_WORKING</code>.</p>"
},
"ListRecipes":{
"name":"ListRecipes",
@ -330,7 +344,7 @@
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Lists all of the AWS Glue DataBrew recipes in the current AWS account.</p>"
"documentation":"<p>Lists all of the DataBrew recipes that are defined.</p>"
},
"ListSchedules":{
"name":"ListSchedules",
@ -343,7 +357,7 @@
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Lists the AWS Glue DataBrew schedules in the current AWS account.</p>"
"documentation":"<p>Lists the DataBrew schedules that are defined.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -358,7 +372,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Lists all the tags for an AWS Glue DataBrew resource. </p>"
"documentation":"<p>Lists all the tags for a DataBrew resource. </p>"
},
"PublishRecipe":{
"name":"PublishRecipe",
@ -370,9 +384,10 @@
"output":{"shape":"PublishRecipeResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Publishes a new major version of an AWS Glue DataBrew recipe that exists in the current AWS account.</p>"
"documentation":"<p>Publishes a new version of a DataBrew recipe.</p>"
},
"SendProjectSessionAction":{
"name":"SendProjectSessionAction",
@ -387,7 +402,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Performs a recipe step within an interactive AWS Glue DataBrew session that's currently open.</p>"
"documentation":"<p>Performs a recipe step within an interactive DataBrew session that's currently open.</p>"
},
"StartJobRun":{
"name":"StartJobRun",
@ -398,10 +413,12 @@
"input":{"shape":"StartJobRunRequest"},
"output":{"shape":"StartJobRunResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Runs an AWS Glue DataBrew job that exists in the current AWS account.</p>"
"documentation":"<p>Runs a DataBrew job.</p>"
},
"StartProjectSession":{
"name":"StartProjectSession",
@ -412,10 +429,12 @@
"input":{"shape":"StartProjectSessionRequest"},
"output":{"shape":"StartProjectSessionResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Creates an interactive session, enabling you to manipulate an AWS Glue DataBrew project.</p>"
"documentation":"<p>Creates an interactive session, enabling you to manipulate data in a DataBrew project.</p>"
},
"StopJobRun":{
"name":"StopJobRun",
@ -429,7 +448,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Stops the specified job from running in the current AWS account.</p>"
"documentation":"<p>Stops a particular run of a job.</p>"
},
"TagResource":{
"name":"TagResource",
@ -444,7 +463,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Adds metadata tags to an AWS Glue DataBrew resource, such as a dataset, job, project, or recipe.</p>"
"documentation":"<p>Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -459,7 +478,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Removes metadata tags from an AWS Glue DataBrew resource.</p>"
"documentation":"<p>Removes metadata tags from a DataBrew resource.</p>"
},
"UpdateDataset":{
"name":"UpdateDataset",
@ -470,10 +489,11 @@
"input":{"shape":"UpdateDatasetRequest"},
"output":{"shape":"UpdateDatasetResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Modifies the definition of an existing AWS Glue DataBrew dataset in the current AWS account.</p>"
"documentation":"<p>Modifies the definition of an existing DataBrew dataset.</p>"
},
"UpdateProfileJob":{
"name":"UpdateProfileJob",
@ -484,9 +504,11 @@
"input":{"shape":"UpdateProfileJobRequest"},
"output":{"shape":"UpdateProfileJobResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Modifies the definition of an existing AWS Glue DataBrew job in the current AWS account.</p>"
"documentation":"<p>Modifies the definition of an existing profile job.</p>"
},
"UpdateProject":{
"name":"UpdateProject",
@ -500,7 +522,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Modifies the definition of an existing AWS Glue DataBrew project in the current AWS account.</p>"
"documentation":"<p>Modifies the definition of an existing DataBrew project.</p>"
},
"UpdateRecipe":{
"name":"UpdateRecipe",
@ -514,7 +536,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Modifies the definition of the latest working version of an AWS Glue DataBrew recipe in the current AWS account.</p>"
"documentation":"<p>Modifies the definition of the <code>LATEST_WORKING</code> version of a DataBrew recipe.</p>"
},
"UpdateRecipeJob":{
"name":"UpdateRecipeJob",
@ -525,9 +547,11 @@
"input":{"shape":"UpdateRecipeJobRequest"},
"output":{"shape":"UpdateRecipeJobResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Modifies the definition of an existing AWS Glue DataBrew recipe job in the current AWS account.</p>"
"documentation":"<p>Modifies the definition of an existing DataBrew recipe job.</p>"
},
"UpdateSchedule":{
"name":"UpdateSchedule",
@ -538,9 +562,11 @@
"input":{"shape":"UpdateScheduleRequest"},
"output":{"shape":"UpdateScheduleResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Modifies the definition of an existing AWS Glue DataBrew schedule in the current AWS account.</p>"
"documentation":"<p>Modifies the definition of an existing DataBrew schedule.</p>"
}
},
"shapes":{
@ -574,13 +600,13 @@
"members":{
"Name":{
"shape":"RecipeName",
"documentation":"<p>The name of the recipe to be modified.</p>",
"documentation":"<p>The name of the recipe whose versions are to be deleted.</p>",
"location":"uri",
"locationName":"name"
},
"RecipeVersions":{
"shape":"RecipeVersionList",
"documentation":"<p>An array of version identifiers to be deleted.</p>"
"documentation":"<p>An array of version identifiers, for the recipe versions to be deleted. You can specify numeric versions (<code>X.Y</code>) or <code>LATEST_WORKING</code>. <code>LATEST_PUBLISHED</code> is not supported.</p>"
}
}
},
@ -594,7 +620,7 @@
},
"Errors":{
"shape":"RecipeErrorList",
"documentation":"<p>Errors, if any, that were encountered when deleting the recipe versions.</p>"
"documentation":"<p>Errors, if any, that occurred while attempting to delete the recipe versions.</p>"
}
}
},
@ -658,7 +684,7 @@
"members":{
"Condition":{
"shape":"Condition",
"documentation":"<p>A specific condition to apply to a recipe action. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html\">Recipe structure</a> in the <i>AWS Glue DataBrew Developer Guide</i>.</p>"
"documentation":"<p>A specific condition to apply to a recipe action. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure\">Recipe structure</a> in the <i>AWS Glue DataBrew Developer Guide</i>.</p>"
},
"Value":{
"shape":"ConditionValue",
@ -666,7 +692,7 @@
},
"TargetColumn":{
"shape":"TargetColumn",
"documentation":"<p>A column to apply this condition to, within an AWS Glue DataBrew dataset.</p>"
"documentation":"<p>A column to apply this condition to.</p>"
}
},
"documentation":"<p>Represents an individual condition that evaluates to true or false.</p> <p>Conditions are used with recipe actions: The action is only performed for column values where the condition evaluates to true.</p> <p>If a recipe requires more than one condition, then the recipe must specify multiple <code>ConditionExpression</code> elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.</p>"
@ -697,7 +723,7 @@
"members":{
"Name":{
"shape":"DatasetName",
"documentation":"<p>The name of the dataset to be created.</p>"
"documentation":"<p>The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>"
},
"FormatOptions":{"shape":"FormatOptions"},
"Input":{"shape":"Input"},
@ -740,11 +766,11 @@
},
"Name":{
"shape":"JobName",
"documentation":"<p>The name of the job to be created.</p>"
"documentation":"<p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>"
},
"LogSubscription":{
"shape":"LogSubscription",
"documentation":"<p>A value that enables or disables Amazon CloudWatch logging for the current AWS account. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
"documentation":"<p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
},
"MaxCapacity":{
"shape":"MaxCapacity",
@ -757,7 +783,7 @@
"OutputLocation":{"shape":"S3Location"},
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>"
},
"Tags":{
"shape":"TagMap",
@ -790,11 +816,11 @@
"members":{
"DatasetName":{
"shape":"DatasetName",
"documentation":"<p>The name of the dataset to associate this project with.</p>"
"documentation":"<p>The name of an existing dataset to associate this project with.</p>"
},
"Name":{
"shape":"ProjectName",
"documentation":"<p>A unique name for the new project.</p>"
"documentation":"<p>A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>"
},
"RecipeName":{
"shape":"RecipeName",
@ -843,11 +869,11 @@
},
"Name":{
"shape":"JobName",
"documentation":"<p>A unique name for the job.</p>"
"documentation":"<p>A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>"
},
"LogSubscription":{
"shape":"LogSubscription",
"documentation":"<p>A value that enables or disables Amazon CloudWatch logging for the current AWS account. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
"documentation":"<p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
},
"MaxCapacity":{
"shape":"MaxCapacity",
@ -868,11 +894,11 @@
"RecipeReference":{"shape":"RecipeReference"},
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>Metadata tags to apply to this job dataset.</p>"
"documentation":"<p>Metadata tags to apply to this job.</p>"
},
"Timeout":{
"shape":"Timeout",
@ -903,7 +929,7 @@
},
"Name":{
"shape":"RecipeName",
"documentation":"<p>A unique name for the recipe.</p>"
"documentation":"<p>A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>"
},
"Steps":{
"shape":"RecipeStepList",
@ -938,7 +964,7 @@
},
"CronExpression":{
"shape":"CronExpression",
"documentation":"<p>The date or dates and time or times, in <code>cron</code> format, when the jobs are to be run.</p>"
"documentation":"<p>The date or dates and time or times when the jobs are to be run. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html\">Cron expressions</a> in the <i>AWS Glue DataBrew Developer Guide</i>.</p>"
},
"Tags":{
"shape":"TagMap",
@ -946,7 +972,7 @@
},
"Name":{
"shape":"ScheduleName",
"documentation":"<p>A unique name for the schedule.</p>"
"documentation":"<p>A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>"
}
}
},
@ -966,6 +992,26 @@
"max":512,
"min":1
},
"CsvOptions":{
"type":"structure",
"members":{
"Delimiter":{
"shape":"Delimiter",
"documentation":"<p>A single character that specifies the delimiter being used in the Csv file.</p>"
}
},
"documentation":"<p>Options that define how DataBrew will read a Csv file when creating a dataset from that file.</p>"
},
"CsvOutputOptions":{
"type":"structure",
"members":{
"Delimiter":{
"shape":"Delimiter",
"documentation":"<p>A single character that specifies the delimiter used to create Csv job output.</p>"
}
},
"documentation":"<p>Options that define how DataBrew will write a Csv file a.</p>"
},
"DataCatalogInputDefinition":{
"type":"structure",
"required":[
@ -990,7 +1036,7 @@
"documentation":"<p>An Amazon location that AWS Glue Data Catalog can use as a temporary directory.</p>"
}
},
"documentation":"<p>Represents how metadata stored in the AWS Glue Data Catalog is defined in an AWS Glue DataBrew dataset. </p>"
"documentation":"<p>Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset. </p>"
},
"DatabaseName":{
"type":"string",
@ -1010,7 +1056,7 @@
},
"CreatedBy":{
"shape":"CreatedBy",
"documentation":"<p>The identifier (the user name) of the user who created the dataset.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who created the dataset.</p>"
},
"CreateDate":{
"shape":"Date",
@ -1034,7 +1080,7 @@
},
"LastModifiedBy":{
"shape":"LastModifiedBy",
"documentation":"<p>The identifier (the user name) of the user who last modified the dataset.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who last modified the dataset.</p>"
},
"Source":{
"shape":"Source",
@ -1049,7 +1095,7 @@
"documentation":"<p>The unique Amazon Resource Name (ARN) for the dataset.</p>"
}
},
"documentation":"<p>Represents a dataset that can be processed by AWS Glue DataBrew.</p>"
"documentation":"<p>Represents a dataset that can be processed by DataBrew.</p>"
},
"DatasetList":{
"type":"list",
@ -1136,13 +1182,13 @@
"members":{
"Name":{
"shape":"RecipeName",
"documentation":"<p>The name of the recipe to be deleted.</p>",
"documentation":"<p>The name of the recipe.</p>",
"location":"uri",
"locationName":"name"
},
"RecipeVersion":{
"shape":"RecipeVersion",
"documentation":"<p>The version of the recipe to be deleted.</p>",
"documentation":"<p>The version of the recipe to be deleted. You can specify a numeric versions (<code>X.Y</code>) or <code>LATEST_WORKING</code>. <code>LATEST_PUBLISHED</code> is not supported.</p>",
"location":"uri",
"locationName":"recipeVersion"
}
@ -1187,6 +1233,11 @@
}
}
},
"Delimiter":{
"type":"string",
"max":1,
"min":1
},
"DescribeDatasetRequest":{
"type":"structure",
"required":["Name"],
@ -1296,11 +1347,11 @@
},
"LogSubscription":{
"shape":"LogSubscription",
"documentation":"<p>A value that indicates whether Amazon CloudWatch logging is enabled for this job.</p>"
"documentation":"<p>Indicates whether Amazon CloudWatch logging is enabled for this job.</p>"
},
"MaxCapacity":{
"shape":"MaxCapacity",
"documentation":"<p>The maximum number of nodes that AWS Glue DataBrew can consume when the job processes data.</p>"
"documentation":"<p>The maximum number of compute nodes that DataBrew can consume when the job processes data.</p>"
},
"MaxRetries":{
"shape":"MaxRetries",
@ -1321,7 +1372,7 @@
},
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the AWS Identity and Access Management (IAM) role that was assumed for this request.</p>"
"documentation":"<p>The ARN of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>"
},
"Tags":{
"shape":"TagMap",
@ -1384,7 +1435,7 @@
"Sample":{"shape":"Sample"},
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the AWS Identity and Access Management (IAM) role that was assumed for this request.</p>"
"documentation":"<p>The ARN of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>"
},
"Tags":{
"shape":"TagMap",
@ -1522,7 +1573,7 @@
},
"CronExpression":{
"shape":"CronExpression",
"documentation":"<p>The date or dates and time or times, in <code>cron</code> format, when the jobs are to be run for the schedule.</p>"
"documentation":"<p>The date or dates and time or times when the jobs are to be run for the schedule. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html\">Cron expressions</a> in the <i>AWS Glue DataBrew Developer Guide</i>.</p>"
},
"Tags":{
"shape":"TagMap",
@ -1575,9 +1626,13 @@
"Excel":{
"shape":"ExcelOptions",
"documentation":"<p>Options that define how Excel input is to be interpreted by DataBrew.</p>"
},
"Csv":{
"shape":"CsvOptions",
"documentation":"<p>Options that define how Csv input is to be interpreted by DataBrew.</p>"
}
},
"documentation":"<p>Options that define how Microsoft Excel input is to be interpreted by DataBrew.</p>"
"documentation":"<p>Options that define the structure of either Csv, Excel, or JSON input.</p>"
},
"HiddenColumnList":{
"type":"list",
@ -1595,7 +1650,7 @@
"documentation":"<p>The AWS Glue Data Catalog parameters for the data.</p>"
}
},
"documentation":"<p>Information on how AWS Glue DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.</p>"
"documentation":"<p>Information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.</p>"
},
"InternalServerException":{
"type":"structure",
@ -1616,7 +1671,7 @@
},
"CreatedBy":{
"shape":"CreatedBy",
"documentation":"<p>The identifier (the user name) of the user who created the job.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who created the job.</p>"
},
"CreateDate":{
"shape":"Date",
@ -1628,7 +1683,7 @@
},
"EncryptionKeyArn":{
"shape":"EncryptionKeyArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an encryption key that is used to protect a job.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html\">Encrypting data written by DataBrew jobs</a> </p>"
},
"EncryptionMode":{
"shape":"EncryptionMode",
@ -1644,7 +1699,7 @@
},
"LastModifiedBy":{
"shape":"LastModifiedBy",
"documentation":"<p>The identifier (the user name) of the user who last modified the job.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who last modified the job.</p>"
},
"LastModifiedDate":{
"shape":"Date",
@ -1691,7 +1746,7 @@
"documentation":"<p>Metadata tags that have been applied to the job.</p>"
}
},
"documentation":"<p>Represents all of the attributes of an AWS Glue DataBrew job.</p>"
"documentation":"<p>Represents all of the attributes of a DataBrew job.</p>"
},
"JobList":{
"type":"list",
@ -1760,14 +1815,14 @@
},
"StartedBy":{
"shape":"StartedBy",
"documentation":"<p>The identifier (the user name) of the user who initiated the job run. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who initiated the job run. </p>"
},
"StartedOn":{
"shape":"Date",
"documentation":"<p>The date and time when the job run began. </p>"
}
},
"documentation":"<p>Represents one run of an AWS Glue DataBrew job.</p>"
"documentation":"<p>Represents one run of a DataBrew job.</p>"
},
"JobRunErrorMessage":{"type":"string"},
"JobRunId":{
@ -1825,7 +1880,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. </p>",
"documentation":"<p>The token returned by a previous call to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@ -1837,11 +1892,11 @@
"members":{
"Datasets":{
"shape":"DatasetList",
"documentation":"<p>A list of datasets that are defined in the current AWS account.</p>"
"documentation":"<p>A list of datasets that are defined.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call. </p>"
"documentation":"<p>A token that you can use in a subsequent call to retrieve the next set of results.</p>"
}
}
},
@ -1863,7 +1918,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token generated by AWS Glue DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. </p>",
"documentation":"<p>The token returned by a previous call to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@ -1879,7 +1934,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call. </p>"
"documentation":"<p>A token that you can use in a subsequent call to retrieve the next set of results.</p>"
}
}
},
@ -1918,11 +1973,11 @@
"members":{
"Jobs":{
"shape":"JobList",
"documentation":"<p>A list of jobs that are defined in the current AWS account.</p>"
"documentation":"<p>A list of jobs that are defined.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call. </p>"
"documentation":"<p>A token that you can use in a subsequent call to retrieve the next set of results.</p>"
}
}
},
@ -1931,7 +1986,7 @@
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"documentation":"<p>The token returned by a previous call to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@ -1949,11 +2004,11 @@
"members":{
"Projects":{
"shape":"ProjectList",
"documentation":"<p>A list of projects that are defined in the current AWS account.</p>"
"documentation":"<p>A list of projects that are defined .</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. </p>"
"documentation":"<p>A token that you can use in a subsequent call to retrieve the next set of results.</p>"
}
}
},
@ -1969,7 +2024,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"documentation":"<p>The token returned by a previous call to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@ -1987,7 +2042,7 @@
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. </p>"
"documentation":"<p>A token that you can use in a subsequent call to retrieve the next set of results.</p>"
},
"Recipes":{
"shape":"RecipeList",
@ -2006,13 +2061,13 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"documentation":"<p>The token returned by a previous call to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"RecipeVersion":{
"shape":"RecipeVersion",
"documentation":"<p>A version identifier. Using this parameter indicates to return only those recipes that have this version identifier.</p>",
"documentation":"<p>Return only those recipes with a version identifier of <code>LATEST_WORKING</code> or <code>LATEST_PUBLISHED</code>. If <code>RecipeVersion</code> is omitted, <code>ListRecipes</code> returns all of the <code>LATEST_PUBLISHED</code> recipe versions.</p> <p>Valid values: <code>LATEST_WORKING</code> | <code>LATEST_PUBLISHED</code> </p>",
"location":"querystring",
"locationName":"recipeVersion"
}
@ -2024,11 +2079,11 @@
"members":{
"Recipes":{
"shape":"RecipeList",
"documentation":"<p>A list of recipes that are defined in the current AWS account.</p>"
"documentation":"<p>A list of recipes that are defined.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. </p>"
"documentation":"<p>A token that you can use in a subsequent call to retrieve the next set of results.</p>"
}
}
},
@ -2049,7 +2104,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"documentation":"<p>The token returned by a previous call to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@ -2061,11 +2116,11 @@
"members":{
"Schedules":{
"shape":"ScheduleList",
"documentation":"<p>A list of schedules in the current AWS account.</p>"
"documentation":"<p>A list of schedules that are defined.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. </p>"
"documentation":"<p>A token that you can use in a subsequent call to retrieve the next set of results.</p>"
}
}
},
@ -2149,9 +2204,13 @@
"Overwrite":{
"shape":"OverwriteOutput",
"documentation":"<p>A value that, if true, means that any data in the location specified for output is overwritten with new output.</p>"
},
"FormatOptions":{
"shape":"OutputFormatOptions",
"documentation":"<p>Options that define how DataBrew formats job output files.</p>"
}
},
"documentation":"<p>Represents individual output from a particular job run.</p>"
"documentation":"<p>Parameters that specify how and where DataBrew will write the output generated by recipe jobs or profile jobs.</p>"
},
"OutputFormat":{
"type":"string",
@ -2165,6 +2224,16 @@
"XML"
]
},
"OutputFormatOptions":{
"type":"structure",
"members":{
"Csv":{
"shape":"CsvOutputOptions",
"documentation":"<p>Options that define how DataBrew writes Csv output.</p>"
}
},
"documentation":"<p>Options that define the structure of Csv job output.</p>"
},
"OutputList":{
"type":"list",
"member":{"shape":"Output"},
@ -2205,7 +2274,7 @@
},
"CreatedBy":{
"shape":"CreatedBy",
"documentation":"<p>The identifier (the user name) of the user who crated the project.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who crated the project.</p>"
},
"DatasetName":{
"shape":"DatasetName",
@ -2217,7 +2286,7 @@
},
"LastModifiedBy":{
"shape":"LastModifiedBy",
"documentation":"<p>The identifier (user name) of the user who last modified the project.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who last modified the project.</p>"
},
"Name":{
"shape":"ProjectName",
@ -2245,14 +2314,14 @@
},
"OpenedBy":{
"shape":"OpenedBy",
"documentation":"<p>The identifier (the user name) of the user that opened the project for use.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user that opened the project for use.</p>"
},
"OpenDate":{
"shape":"Date",
"documentation":"<p>The date and time when the project was opened.</p>"
}
},
"documentation":"<p>Represents all of the attributes of an AWS Glue DataBrew project.</p>"
"documentation":"<p>Represents all of the attributes of a DataBrew project.</p>"
},
"ProjectList":{
"type":"list",
@ -2296,7 +2365,7 @@
"members":{
"CreatedBy":{
"shape":"CreatedBy",
"documentation":"<p>The identifier (the user name) of the user who created the recipe.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who created the recipe.</p>"
},
"CreateDate":{
"shape":"Date",
@ -2304,7 +2373,7 @@
},
"LastModifiedBy":{
"shape":"LastModifiedBy",
"documentation":"<p>The identifier (user name) of the user who last modified the recipe.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who last modified the recipe.</p>"
},
"LastModifiedDate":{
"shape":"Date",
@ -2316,7 +2385,7 @@
},
"PublishedBy":{
"shape":"PublishedBy",
"documentation":"<p>The identifier (the user name) of the user who published the recipe.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who published the recipe.</p>"
},
"PublishedDate":{
"shape":"Date",
@ -2344,10 +2413,10 @@
},
"RecipeVersion":{
"shape":"RecipeVersion",
"documentation":"<p>The identifier for the version for the recipe. </p>"
"documentation":"<p>The identifier for the version for the recipe. Must be one of the following:</p> <ul> <li> <p>Numeric version (<code>X.Y</code>) - <code>X</code> and <code>Y</code> stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both <code>X</code> and <code>Y</code> are required, and \"0.0\" is not a valid version.</p> </li> <li> <p> <code>LATEST_WORKING</code> - the most recent valid version being developed in a DataBrew project.</p> </li> <li> <p> <code>LATEST_PUBLISHED</code> - the most recent published version.</p> </li> </ul>"
}
},
"documentation":"<p>Represents one or more actions to be performed on an AWS Glue DataBrew dataset.</p>"
"documentation":"<p>Represents one or more actions to be performed on a DataBrew dataset.</p>"
},
"RecipeAction":{
"type":"structure",
@ -2362,7 +2431,7 @@
"documentation":"<p>Contextual parameters for the transformation.</p>"
}
},
"documentation":"<p>Represents a transformation and associated parameters that are used to apply a change to an AWS Glue DataBrew dataset. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html\">Recipe structure</a> and <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html\">ecipe actions reference</a> .</p>"
"documentation":"<p>Represents a transformation and associated parameters that are used to apply a change to a DataBrew dataset. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html\">Recipe structure</a> and <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html\">Recipe actions reference</a>.</p>"
},
"RecipeDescription":{
"type":"string",
@ -2395,7 +2464,7 @@
"documentation":"<p>The identifier for the version for the recipe. </p>"
}
},
"documentation":"<p>Represents all of the attributes of an AWS Glue DataBrew recipe.</p>"
"documentation":"<p>Represents the name and version of a DataBrew recipe.</p>"
},
"RecipeStep":{
"type":"structure",
@ -2410,7 +2479,7 @@
"documentation":"<p>One or more conditions that must be met, in order for the recipe step to succeed.</p> <note> <p>All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.</p> </note>"
}
},
"documentation":"<p>Represents a single step to be performed in an AWS Glue DataBrew recipe.</p>"
"documentation":"<p>Represents a single step from a DataBrew recipe to be performed.</p>"
},
"RecipeStepList":{
"type":"list",
@ -2483,7 +2552,7 @@
"documentation":"<p>The way in which DataBrew obtains rows from a dataset.</p>"
}
},
"documentation":"<p>Represents the sample size and sampling type for AWS Glue DataBrew to use for interactive data analysis.</p>"
"documentation":"<p>Represents the sample size and sampling type for DataBrew to use for interactive data analysis.</p>"
},
"SampleSize":{
"type":"integer",
@ -2508,7 +2577,7 @@
},
"CreatedBy":{
"shape":"CreatedBy",
"documentation":"<p>The identifier (the user name) of the user who created the schedule.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who created the schedule.</p>"
},
"CreateDate":{
"shape":"Date",
@ -2520,7 +2589,7 @@
},
"LastModifiedBy":{
"shape":"LastModifiedBy",
"documentation":"<p>The identifier (the user name) of the user who last modified the schedule.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who last modified the schedule.</p>"
},
"LastModifiedDate":{
"shape":"Date",
@ -2532,7 +2601,7 @@
},
"CronExpression":{
"shape":"CronExpression",
"documentation":"<p>The date(s) and time(s), in <code>cron</code> format, when the job will run.</p>"
"documentation":"<p>The date(s) and time(s) when the job will run. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html\">Cron expressions</a> in the <i>AWS Glue DataBrew Developer Guide</i>.</p>"
},
"Tags":{
"shape":"TagMap",
@ -2560,7 +2629,7 @@
"members":{
"Preview":{
"shape":"Preview",
"documentation":"<p>Returns the result of the recipe step, without applying it. The result isn't added to the view frame stack.</p>"
"documentation":"<p>If true, the result of the recipe step will be returned, but not applied.</p>"
},
"Name":{
"shape":"ProjectName",
@ -2812,7 +2881,7 @@
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>An DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN). </p>",
"documentation":"<p>A DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN). </p>",
"location":"uri",
"locationName":"ResourceArn"
},
@ -2880,11 +2949,11 @@
},
"LogSubscription":{
"shape":"LogSubscription",
"documentation":"<p>A value that enables or disables Amazon CloudWatch logging for the current AWS account. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
"documentation":"<p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
},
"MaxCapacity":{
"shape":"MaxCapacity",
"documentation":"<p>The maximum number of nodes that DataBrew can use when the job processes data.</p>"
"documentation":"<p>The maximum number of compute nodes that DataBrew can use when the job processes data.</p>"
},
"MaxRetries":{
"shape":"MaxRetries",
@ -2893,7 +2962,7 @@
"OutputLocation":{"shape":"S3Location"},
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>"
},
"Timeout":{
"shape":"Timeout",
@ -2969,7 +3038,7 @@
},
"LogSubscription":{
"shape":"LogSubscription",
"documentation":"<p>A value that enables or disables Amazon CloudWatch logging for the current AWS account. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
"documentation":"<p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
},
"MaxCapacity":{
"shape":"MaxCapacity",
@ -2985,7 +3054,7 @@
},
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>"
},
"Timeout":{
"shape":"Timeout",
@ -3046,7 +3115,7 @@
},
"CronExpression":{
"shape":"CronExpression",
"documentation":"<p>The date or dates and time or times, in <code>cron</code> format, when the jobs are to be run.</p>"
"documentation":"<p>The date or dates and time or times when the jobs are to be run. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html\">Cron expressions</a> in the <i>AWS Glue DataBrew Developer Guide</i>.</p>"
},
"Name":{
"shape":"ScheduleName",
@ -3092,7 +3161,7 @@
"documentation":"<p>A list of columns to hide in the view frame.</p>"
}
},
"documentation":"<p>Represents the data being being transformed during an AWS Glue DataBrew project session.</p>"
"documentation":"<p>Represents the data being being transformed during an action.</p>"
}
},
"documentation":"<p>AWS Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required.</p>"

View file

@ -263,7 +263,7 @@
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore.</p> <p>A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.</p> <p>A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).</p> <p>When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html\">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
"documentation":"<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore.</p> <p>A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.</p> <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. </p> <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html\">Creating a Subnet Group</a>. For versions below 5.0.6, the limit is 250 per cluster.</p> <p>To request a limit increase, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> and choose the limit type <b>Nodes per cluster per instance type</b>. </p> <p>When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html\">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
},
"CreateSnapshot":{
"name":"CreateSnapshot",
@ -535,7 +535,7 @@
{"shape":"InvalidUserGroupStateFault"},
{"shape":"InvalidParameterValueException"}
],
"documentation":"<p>For Redis engine version 6.x onwards: Deletes a ser group. The user group must first be disassociated from the replcation group before it can be deleted. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a>. </p>"
"documentation":"<p>For Redis engine version 6.x onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a>. </p>"
},
"DescribeCacheClusters":{
"name":"DescribeCacheClusters",
@ -913,7 +913,7 @@
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.</p>"
"documentation":"<p>Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.</p>"
},
"ListAllowedNodeTypeModifications":{
"name":"ListAllowedNodeTypeModifications",
@ -1151,7 +1151,7 @@
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Allows you to purchase a reserved cache node offering.</p>"
"documentation":"<p>Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes.html\">Managing Costs with Reserved Nodes</a> for Redis or <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html\">Managing Costs with Reserved Nodes</a> for Memcached.</p>"
},
"RebalanceSlotsInGlobalReplicationGroup":{
"name":"RebalanceSlotsInGlobalReplicationGroup",
@ -1517,7 +1517,7 @@
},
"ConfigurationEndpoint":{
"shape":"Endpoint",
"documentation":"<p>Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have <code>.cfg</code> in it.</p> <p>Example: <code>mem-3.9dvc4r<u>.cfg</u>.usw2.cache.amazonaws.com:11211</code> </p>"
"documentation":"<p>Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have <code>.cfg</code> in it.</p> <p>Example: <code>mem-3.9dvc4r<u>.cfg</u>.usw2.cache.amazonaws.com:11211</code> </p>"
},
"ClientDownloadLandingPage":{
"shape":"String",
@ -2633,7 +2633,7 @@
},
"CacheParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.</p> <note> <p>If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, <code>CacheParameterGroupName=default.redis4.0</code>.</p> </note> <p>If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. </p> <ul> <li> <p>To create a Redis (cluster mode disabled) replication group, use <code>CacheParameterGroupName=default.redis3.2</code>.</p> </li> <li> <p>To create a Redis (cluster mode enabled) replication group, use <code>CacheParameterGroupName=default.redis3.2.cluster.on</code>.</p> </li> </ul>"
"documentation":"<p>The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.</p> <p>If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. </p> <ul> <li> <p>To create a Redis (cluster mode disabled) replication group, use <code>CacheParameterGroupName=default.redis3.2</code>.</p> </li> <li> <p>To create a Redis (cluster mode enabled) replication group, use <code>CacheParameterGroupName=default.redis3.2.cluster.on</code>.</p> </li> </ul>"
},
"CacheSubnetGroupName":{
"shape":"String",
@ -4365,6 +4365,10 @@
"shape":"String",
"documentation":"<p>The upgraded version of the cache engine to be run on the clusters in the Global Datastore. </p>"
},
"CacheParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.</p>"
},
"GlobalReplicationGroupDescription":{
"shape":"String",
"documentation":"<p>A description of the Global Datastore</p>"

View file

@ -658,6 +658,7 @@
},
"appmesh" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1306,6 +1307,7 @@
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-south-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -2928,6 +2930,7 @@
},
"fsx" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -2937,6 +2940,7 @@
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-south-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -2970,6 +2974,7 @@
},
"hostname" : "fsx-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -3614,6 +3619,7 @@
},
"lakeformation" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -4112,7 +4118,19 @@
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-west-2" : { }
"us-east-1-fips" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "models-fips.lex.us-east-1.amazonaws.com"
},
"us-west-2" : { },
"us-west-2-fips" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "models-fips.lex.us-west-2.amazonaws.com"
}
}
},
"monitoring" : {
@ -5005,7 +5023,19 @@
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-west-2" : { }
"us-east-1-fips" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "runtime-fips.lex.us-east-1.amazonaws.com"
},
"us-west-2" : { },
"us-west-2-fips" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "runtime-fips.lex.us-west-2.amazonaws.com"
}
}
},
"runtime.sagemaker" : {
@ -8312,7 +8342,12 @@
},
"hostname" : "greengrass-fips.us-gov-east-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "greengrass.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
@ -9372,6 +9407,16 @@
"us-iso-east-1" : { }
}
},
"medialive" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"mediapackage" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"monitoring" : {
"endpoints" : {
"us-iso-east-1" : { }
@ -9439,6 +9484,11 @@
}
}
},
"ssm" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"states" : {
"endpoints" : {
"us-iso-east-1" : { }

View file

@ -3491,6 +3491,14 @@
"AdvancedSecurityOptions":{
"shape":"AdvancedSecurityOptionsInput",
"documentation":"<p>Specifies advanced security options.</p>"
},
"NodeToNodeEncryptionOptions":{
"shape":"NodeToNodeEncryptionOptions",
"documentation":"<p>Specifies the NodeToNodeEncryptionOptions.</p>"
},
"EncryptionAtRestOptions":{
"shape":"EncryptionAtRestOptions",
"documentation":"<p>Specifies the Encryption At Rest Options.</p>"
}
},
"documentation":"<p>Container for the parameters to the <code><a>UpdateElasticsearchDomain</a></code> operation. Specifies the type and number of instances in the domain cluster.</p>"

View file

@ -7493,13 +7493,13 @@
},
"deleteStream":{
"shape":"DeleteStream",
"documentation":"<p>Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.</p>",
"documentation":"<p>When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.</p>",
"location":"querystring",
"locationName":"deleteStream"
},
"forceDeleteAWSJob":{
"shape":"ForceDeleteAWSJob",
"documentation":"<p>Specifies if the AWS Job associated with the OTA update should be deleted when the OTA update is deleted.</p>",
"documentation":"<p>When true, deletes the AWS job created by the OTAUpdate process even if it is \"IN_PROGRESS\". Otherwise, if the job is not in a terminal state (\"COMPLETED\" or \"CANCELED\") an exception will occur. The default is false.</p>",
"location":"querystring",
"locationName":"forceDeleteAWSJob"
}

View file

@ -266,7 +266,7 @@
{"shape":"AccessDeniedException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.</p> <note> <p>You can only push container images to the container service registry of your Lightsail account. You cannot pull container images perform any other container image management actions on the container service registry of your Lightsail account.</p> </note> <p>After you push your container images to the container image registry of your Lightsail account, use the <code>RegisterContainerImage</code> action to register the pushed images to a specific Lightsail container service.</p> <note> <p>This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see <a href=\"amazon-lightsail-pushing-container-images\">Pushing and managing container images on your Amazon Lightsail container services</a> in the <i>Lightsail Dev Guide</i>.</p> </note>"
"documentation":"<p>Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.</p> <note> <p>You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.</p> </note> <p>After you push your container images to the container image registry of your Lightsail account, use the <code>RegisterContainerImage</code> action to register the pushed images to a specific Lightsail container service.</p> <note> <p>This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images\">Pushing and managing container images on your Amazon Lightsail container services</a> in the <i>Lightsail Dev Guide</i>.</p> </note>"
},
"CreateDisk":{
"name":"CreateDisk",
@ -3299,7 +3299,7 @@
},
"requestFailureReason":{
"shape":"RequestFailureReason",
"documentation":"<p>The validation failure reason, if any, of the certificate.</p> <p>The following failure reasons are possible:</p> <ul> <li> <p> <b> <code>NO_AVAILABLE_CONTACTS</code> </b> - This failure applies to email validation, which is not available for Lightsail certificates.</p> </li> <li> <p> <b> <code>ADDITIONAL_VERIFICATION_REQUIRED</code> </b> - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a> to contact AWS Support.</p> <note> <p>You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.</p> </note> </li> <li> <p> <b> <code>DOMAIN_NOT_ALLOWED</code> </b> - One or more of the domain names in the certificate request was reported as an unsafe domain by <a href=\"https://www.virustotal.com/gui/home/url\">VirusTotal</a>. To correct the problem, search for your domain name on the <a href=\"https://www.virustotal.com/gui/home/url\">VirusTotal</a> website. If your domain is reported as suspicious, see <a href=\"https://www.google.com/webmasters/hacked/?hl=en\">Google Help for Hacked Websites</a> to learn what you can do.</p> <p>If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.</p> <p>If you see this error and your domain is not included in the VirusTotal list, visit the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a> and create a case.</p> </li> <li> <p> <b> <code>INVALID_PUBLIC_DOMAIN</code> </b> - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for <code>example.invalidpublicdomain</code> because <code>invalidpublicdomain</code> is not a valid top-level domain.</p> </li> <li> <p> <b> <code>OTHER</code> </b> - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request. </p> </li> </ul>"
"documentation":"<p>The validation failure reason, if any, of the certificate.</p> <p>The following failure reasons are possible:</p> <ul> <li> <p> <b> <code>NO_AVAILABLE_CONTACTS</code> </b> - This failure applies to email validation, which is not available for Lightsail certificates.</p> </li> <li> <p> <b> <code>ADDITIONAL_VERIFICATION_REQUIRED</code> </b> - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a> to contact AWS Support.</p> <note> <p>You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.</p> </note> </li> <li> <p> <b> <code>DOMAIN_NOT_ALLOWED</code> </b> - One or more of the domain names in the certificate request was reported as an unsafe domain by <a href=\"https://www.virustotal.com/gui/home/url\">VirusTotal</a>. To correct the problem, search for your domain name on the <a href=\"https://www.virustotal.com/gui/home/url\">VirusTotal</a> website. If your domain is reported as suspicious, see <a href=\"https://developers.google.com/web/fundamentals/security/hacked\">Google Help for Hacked Websites</a> to learn what you can do.</p> <p>If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.</p> <p>If you see this error and your domain is not included in the VirusTotal list, visit the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a> and create a case.</p> </li> <li> <p> <b> <code>INVALID_PUBLIC_DOMAIN</code> </b> - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for <code>example.invalidpublicdomain</code> because <code>invalidpublicdomain</code> is not a valid top-level domain.</p> </li> <li> <p> <b> <code>OTHER</code> </b> - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request. </p> </li> </ul>"
},
"inUseResourceCount":{
"shape":"InUseResourceCount",

View file

@ -2549,7 +2549,7 @@
"documentation": "<p>Specifies whether Amazon S3 restricts public bucket policies for the bucket.</p>"
}
},
"documentation": "<p>Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account level or bucket level. For detailed information about each setting, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html\">Using Amazon S3 block public access</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
"documentation": "<p>Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account level or bucket level. For detailed information about each setting, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html\">Blocking public access to your Amazon S3 storage</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
},
"BucketCountByEffectivePermission": {
"type": "structure",
@ -4825,7 +4825,8 @@
"LT",
"LTE",
"NE",
"CONTAINS"
"CONTAINS",
"STARTS_WITH"
]
},
"JobDetails": {
@ -5739,7 +5740,7 @@
"accountId": {
"shape": "__string",
"locationName": "accountId",
"documentation": "<p>The unique identifier for the AWS account that owns the buckets. If you specify this value and don't specify a value for the buckets array, the job analyzes objects in all the buckets that are owned by the account and meet other conditions specified for the job.</p>"
"documentation": "<p>The unique identifier for the AWS account that owns the buckets.</p>"
},
"buckets": {
"shape": "__listOf__string",
@ -5747,7 +5748,11 @@
"documentation": "<p>An array that lists the names of the buckets.</p>"
}
},
"documentation": "<p>Specifies which AWS account owns the S3 buckets that a classification job analyzes, and the buckets to analyze for the account.</p>"
"documentation": "<p>Specifies which AWS account owns the S3 buckets that a classification job analyzes, and the buckets to analyze for the account.</p>",
"required": [
"accountId",
"buckets"
]
},
"S3BucketOwner": {
"type": "structure",
@ -5880,7 +5885,8 @@
"OBJECT_EXTENSION",
"OBJECT_LAST_MODIFIED_DATE",
"OBJECT_SIZE",
"TAG"
"TAG",
"OBJECT_KEY"
]
},
"Scoping": {
@ -6092,7 +6098,7 @@
"comparator": {
"shape": "JobComparator",
"locationName": "comparator",
"documentation": "<p>The operator to use in the condition. Valid operators for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - EQ (equals) or NE (not equals)</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS</p></li> <li><p>OBJECT_SIZE - Any operator except CONTAINS</p></li> <li><p>TAG - EQ (equals) or NE (not equals)</p></li></ul>"
"documentation": "<p>The operator to use in the condition. Valid operators for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - EQ (equals) or NE (not equals)</p></li> <li><p>OBJECT_KEY - STARTS_WITH</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS</p></li> <li><p>OBJECT_SIZE - Any operator except CONTAINS</p></li> <li><p>TAG - EQ (equals) or NE (not equals)</p></li></ul>"
},
"key": {
"shape": "ScopeFilterKey",
@ -6102,7 +6108,7 @@
"values": {
"shape": "__listOf__string",
"locationName": "values",
"documentation": "<p>An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION, this array can specify multiple values and Amazon Macie uses an OR operator to join the values. Otherwise, this array can specify only one value. Valid values for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: doc, docx, pdf</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z</p></li> <li><p>OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.</p></li> <li><p>TAG - A string that represents a tag key for an object. For advanced options, use a TagScopeTerm object, instead of a SimpleScopeTerm object, to define a tag-based condition for the job.</p></li></ul>"
"documentation": "<p>An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses an OR operator to join the values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf</p></li> <li><p>OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z</p></li> <li><p>OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.</p></li> <li><p>TAG - A string that represents a tag key for an object. For advanced options, use a TagScopeTerm object, instead of a SimpleScopeTerm object, to define a tag-based condition for the job.</p></li></ul> <p>Macie doesn't support use of wildcard characters in values. Also, string values are case sensitive.</p>"
}
},
"documentation": "<p>Specifies a property-based condition that determines whether an object is included or excluded from a classification job.</p>"

View file

@ -29,7 +29,8 @@
{"shape":"ResourceNotReadyException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"InternalServiceErrorException"}
{"shape":"InternalServiceErrorException"},
{"shape":"TooManyTagsException"}
],
"documentation":"<p>Creates a member within a Managed Blockchain network.</p> <p>Applies only to Hyperledger Fabric.</p>"
},
@ -47,7 +48,8 @@
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"InternalServiceErrorException"}
{"shape":"InternalServiceErrorException"},
{"shape":"TooManyTagsException"}
],
"documentation":"<p>Creates a new blockchain network using Amazon Managed Blockchain.</p> <p>Applies only to Hyperledger Fabric.</p>"
},
@ -67,9 +69,10 @@
{"shape":"ResourceNotReadyException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"InternalServiceErrorException"}
{"shape":"InternalServiceErrorException"},
{"shape":"TooManyTagsException"}
],
"documentation":"<p>Creates a node on the specified blockchain network.</p> <p>Applies to Hyperledger Fabric and Ethereum.</p>"
"documentation":"<p>Creates a node on the specified blockchain network.</p> <p>Applies to Hyperledger Fabric and Ethereum.</p> <p>Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
},
"CreateProposal":{
"name":"CreateProposal",
@ -85,7 +88,8 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceNotReadyException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceErrorException"}
{"shape":"InternalServiceErrorException"},
{"shape":"TooManyTagsException"}
],
"documentation":"<p>Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.</p> <p>Applies only to Hyperledger Fabric.</p>"
},
@ -292,6 +296,22 @@
],
"documentation":"<p>Returns a list of proposals for the network.</p> <p>Applies only to Hyperledger Fabric.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InternalServiceErrorException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceNotReadyException"}
],
"documentation":"<p>Returns a list of tags for the specified resource. Each tag consists of a key and optional value.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
},
"RejectInvitation":{
"name":"RejectInvitation",
"http":{
@ -310,6 +330,39 @@
],
"documentation":"<p>Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.</p> <p>Applies only to Hyperledger Fabric.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InternalServiceErrorException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyTagsException"},
{"shape":"ResourceNotReadyException"}
],
"documentation":"<p>Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource. Each tag consists of a key and optional value.</p> <p>When you specify a tag key that already exists, the tag value is overwritten with the new value. Use <code>UntagResource</code> to remove tag keys.</p> <p>A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InternalServiceErrorException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceNotReadyException"}
],
"documentation":"<p>Removes the specified tags from the Amazon Managed Blockchain resource.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
},
"UpdateMember":{
"name":"UpdateMember",
"http":{
@ -391,6 +444,12 @@
},
"documentation":"<p>A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of <code>YES</code> votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.</p> <p>Applies only to Hyperledger Fabric.</p>"
},
"ArnString":{
"type":"string",
"max":1011,
"min":1,
"pattern":"^arn:.+:.+:.+:.+:.+"
},
"AvailabilityZoneString":{"type":"string"},
"ClientRequestTokenString":{
"type":"string",
@ -479,6 +538,10 @@
"MemberConfiguration":{
"shape":"MemberConfiguration",
"documentation":"<p>Configuration properties for the first member within the network.</p>"
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>Tags to assign to the network. Each tag consists of a key and optional value.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
}
}
},
@ -521,6 +584,10 @@
"NodeConfiguration":{
"shape":"NodeConfiguration",
"documentation":"<p>The properties of a node configuration.</p>"
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>Tags to assign to the node. Each tag consists of a key and optional value.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
}
}
},
@ -564,6 +631,10 @@
"Description":{
"shape":"DescriptionString",
"documentation":"<p>A description for the proposal that is visible to voting members, for example, \"Proposal to add Example Corp. as member.\"</p>"
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>Tags to assign to the proposal. Each tag consists of a key and optional value.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
}
}
},
@ -649,6 +720,7 @@
"type":"boolean",
"box":true
},
"ExceptionMessage":{"type":"string"},
"Framework":{
"type":"string",
"enum":[
@ -787,6 +859,13 @@
"error":{"httpStatusCode":400},
"exception":true
},
"InputTagMap":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":50,
"min":0
},
"InstanceTypeString":{"type":"string"},
"InternalServiceErrorException":{
"type":"structure",
@ -824,7 +903,11 @@
"shape":"InvitationStatus",
"documentation":"<p>The status of the invitation:</p> <ul> <li> <p> <code>PENDING</code> - The invitee has not created a member to join the network, and the invitation has not yet expired.</p> </li> <li> <p> <code>ACCEPTING</code> - The invitee has begun creating a member, and creation has not yet completed.</p> </li> <li> <p> <code>ACCEPTED</code> - The invitee created a member and joined the network using the <code>InvitationID</code>.</p> </li> <li> <p> <code>REJECTED</code> - The invitee rejected the invitation.</p> </li> <li> <p> <code>EXPIRED</code> - The invitee neither created a member nor rejected the invitation before the <code>ExpirationDate</code>.</p> </li> </ul>"
},
"NetworkSummary":{"shape":"NetworkSummary"}
"NetworkSummary":{"shape":"NetworkSummary"},
"Arn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>An invitation to an AWS account to create a member and join the network.</p> <p>Applies only to Hyperledger Fabric.</p>"
},
@ -1126,6 +1209,27 @@
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>",
"location":"uri",
"locationName":"resourceArn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"OutputTagMap",
"documentation":"<p>The tags assigned to the resource.</p>"
}
}
},
"LogConfiguration":{
"type":"structure",
"members":{
@ -1180,6 +1284,14 @@
"CreationDate":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the member was created.</p>"
},
"Tags":{
"shape":"OutputTagMap",
"documentation":"<p>Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
},
"Arn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>Member configuration properties.</p> <p>Applies only to Hyperledger Fabric.</p>"
@ -1206,6 +1318,10 @@
"LogPublishingConfiguration":{
"shape":"MemberLogPublishingConfiguration",
"documentation":"<p>Configuration properties for logging events associated with a member of a Managed Blockchain network.</p>"
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource.</p>"
}
},
"documentation":"<p>Configuration properties of the member.</p> <p>Applies only to Hyperledger Fabric.</p>"
@ -1325,6 +1441,10 @@
"IsOwned":{
"shape":"IsOwned",
"documentation":"<p>An indicator of whether the member is owned by your AWS account or a different AWS account.</p>"
},
"Arn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>A summary of configuration properties for a member.</p> <p>Applies only to Hyperledger Fabric.</p>"
@ -1381,6 +1501,14 @@
"CreationDate":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the network was created.</p>"
},
"Tags":{
"shape":"OutputTagMap",
"documentation":"<p>Tags assigned to the network. Each tag consists of a key and optional value.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
},
"Arn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>Network configuration properties.</p>"
@ -1393,7 +1521,7 @@
"documentation":"<p>The Ethereum <code>CHAIN_ID</code> associated with the Ethereum network. Chain IDs are as follows:</p> <ul> <li> <p>mainnet = <code>1</code> </p> </li> <li> <p>rinkeby = <code>4</code> </p> </li> <li> <p>ropsten = <code>3</code> </p> </li> </ul>"
}
},
"documentation":"<p>Attributes of Ethereum for a network.</p>"
"documentation":"<p>Attributes of Ethereum for a network. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
},
"NetworkFabricAttributes":{
"type":"structure",
@ -1429,7 +1557,7 @@
},
"Ethereum":{
"shape":"NetworkEthereumAttributes",
"documentation":"<p>Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network.</p>"
"documentation":"<p>Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
}
},
"documentation":"<p>Attributes relevant to the network for the blockchain framework that the network uses.</p>"
@ -1496,6 +1624,10 @@
"CreationDate":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the network was created.</p>"
},
"Arn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>A summary of network configuration properties.</p>"
@ -1525,7 +1657,7 @@
},
"AvailabilityZone":{
"shape":"AvailabilityZoneString",
"documentation":"<p>The Availability Zone in which the node exists.</p>"
"documentation":"<p>The Availability Zone in which the node exists. Required for Ethereum nodes. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
},
"FrameworkAttributes":{
"shape":"NodeFrameworkAttributes",
@ -1546,6 +1678,14 @@
"CreationDate":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the node was created.</p>"
},
"Tags":{
"shape":"OutputTagMap",
"documentation":"<p>Tags assigned to the node. Each tag consists of a key and optional value.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
},
"Arn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>Configuration properties of a node.</p>"
@ -1560,7 +1700,7 @@
},
"AvailabilityZone":{
"shape":"AvailabilityZoneString",
"documentation":"<p>The Availability Zone in which the node exists.</p>"
"documentation":"<p>The Availability Zone in which the node exists. Required for Ethereum nodes. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
},
"LogPublishingConfiguration":{
"shape":"NodeLogPublishingConfiguration",
@ -1585,7 +1725,7 @@
"documentation":"<p>The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods over WebSockets connections from a client. Use this endpoint in client code for smart contracts when using a WebSockets connection. Connections to this endpoint are authenticated using <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>.</p>"
}
},
"documentation":"<p>Attributes of an Ethereum node.</p>"
"documentation":"<p>Attributes of an Ethereum node. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
},
"NodeFabricAttributes":{
"type":"structure",
@ -1624,7 +1764,7 @@
},
"Ethereum":{
"shape":"NodeEthereumAttributes",
"documentation":"<p>Attributes of Ethereum for a node on a Managed Blockchain network that uses Ethereum.</p>"
"documentation":"<p>Attributes of Ethereum for a node on a Managed Blockchain network that uses Ethereum. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
}
},
"documentation":"<p>Attributes relevant to a node on a Managed Blockchain network for the blockchain framework that the network uses.</p>"
@ -1680,6 +1820,10 @@
"InstanceType":{
"shape":"InstanceTypeString",
"documentation":"<p>The EC2 instance type for the node.</p>"
},
"Arn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>A summary of configuration properties for a node.</p>"
@ -1688,6 +1832,13 @@
"type":"list",
"member":{"shape":"NodeSummary"}
},
"OutputTagMap":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":200,
"min":0
},
"PaginationToken":{
"type":"string",
"max":128
@ -1750,6 +1901,14 @@
"OutstandingVoteCount":{
"shape":"VoteCount",
"documentation":"<p> The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of <code>YES</code> votes and <code>NO</code> votes. </p>"
},
"Tags":{
"shape":"OutputTagMap",
"documentation":"<p>Tags assigned to the proposal. Each tag consists of a key and optional value.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
},
"Arn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>Properties of a proposal on a Managed Blockchain network.</p> <p>Applies only to Hyperledger Fabric.</p>"
@ -1820,6 +1979,10 @@
"ExpirationDate":{
"shape":"Timestamp",
"documentation":"<p> The date and time that the proposal expires. This is the <code>CreationDate</code> plus the <code>ProposalDurationInHours</code> that is specified in the <code>ProposalThresholdPolicy</code>. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is <code>EXPIRED</code> and <code>Actions</code> are not carried out. </p>"
},
"Arn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>Properties of a proposal.</p> <p>Applies only to Hyperledger Fabric.</p>"
@ -1890,9 +2053,13 @@
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
"Message":{"shape":"String"},
"ResourceName":{
"shape":"ArnString",
"documentation":"<p>A requested resource does not exist. It may have been deleted or referenced inaccurately.</p>"
}
},
"documentation":"<p>A requested resource does not exist on the network. It may have been deleted or referenced inaccurately.</p>",
"documentation":"<p>A requested resource does not exist. It may have been deleted or referenced inaccurately.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
@ -1913,6 +2080,46 @@
]
},
"String":{"type":"string"},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200,
"min":0
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>The tags to assign to the specified resource. Tag values can be empty, for example, <code>\"MyTagKey\" : \"\"</code>. You can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"ThresholdComparator":{
"type":"string",
"enum":[
@ -1938,6 +2145,45 @@
"type":"timestamp",
"timestampFormat":"iso8601"
},
"TooManyTagsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"},
"ResourceName":{
"shape":"ArnString",
"documentation":"<p/>"
}
},
"documentation":"<p/>",
"error":{"httpStatusCode":400},
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"ArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag keys.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateMemberInput":{
"type":"structure",
"required":[
@ -2084,5 +2330,5 @@
"documentation":"<p> The voting rules for the network to decide if a proposal is accepted </p> <p>Applies only to Hyperledger Fabric.</p>"
}
},
"documentation":"<p/> <p>Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.</p> <p>Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as <code>CreateMember</code> and <code>DeleteMember</code> do not apply to Ethereum.</p> <p>The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.</p>"
"documentation":"<p/> <p>Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.</p> <p>Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Ethereum on Managed Blockchain is in preview release and is subject to change. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as <code>CreateMember</code> and <code>DeleteMember</code> do not apply to Ethereum.</p> <p>The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.</p>"
}

View file

@ -4233,6 +4233,11 @@
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
"Vpc": {
"shape": "VpcOutputSettings",
"locationName": "vpc",
"documentation": "Settings for VPC output"
}
},
"documentation": "Placeholder documentation for Channel"
@ -4359,6 +4364,11 @@
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
"Vpc": {
"shape": "VpcOutputSettings",
"locationName": "vpc",
"documentation": "Settings for VPC output"
}
},
"documentation": "Placeholder documentation for ChannelSummary"
@ -4445,6 +4455,11 @@
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
"Vpc": {
"shape": "VpcOutputSettings",
"locationName": "vpc",
"documentation": "Settings for VPC output"
}
},
"documentation": "Placeholder documentation for CreateChannel"
@ -4511,6 +4526,11 @@
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
"Vpc": {
"shape": "VpcOutputSettings",
"locationName": "vpc",
"documentation": "Settings for VPC output"
}
},
"documentation": "A request to create a channel"
@ -5005,6 +5025,11 @@
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
"Vpc": {
"shape": "VpcOutputSettings",
"locationName": "vpc",
"documentation": "Settings for VPC output"
}
},
"documentation": "Placeholder documentation for DeleteChannelResponse"
@ -5423,6 +5448,11 @@
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
"Vpc": {
"shape": "VpcOutputSettings",
"locationName": "vpc",
"documentation": "Settings for VPC output"
}
},
"documentation": "Placeholder documentation for DescribeChannelResponse"
@ -13100,6 +13130,11 @@
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
"Vpc": {
"shape": "VpcOutputSettings",
"locationName": "vpc",
"documentation": "Settings for VPC output"
}
},
"documentation": "Placeholder documentation for StartChannelResponse"
@ -13375,6 +13410,11 @@
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
},
"Vpc": {
"shape": "VpcOutputSettings",
"locationName": "vpc",
"documentation": "Settings for VPC output"
}
},
"documentation": "Placeholder documentation for StopChannelResponse"
@ -14595,6 +14635,30 @@
},
"documentation": "Video Selector Settings"
},
"VpcOutputSettings": {
"type": "structure",
"members": {
"PublicAddressAllocationIds": {
"shape": "__listOf__string",
"locationName": "publicAddressAllocationIds",
"documentation": "List of public address allocation ids to associate with ENIs that will be created in Output VPC.\nMust specify one for SINGLE_PIPELINE, two for STANDARD channels\n"
},
"SecurityGroupIds": {
"shape": "__listOf__string",
"locationName": "securityGroupIds",
"documentation": "A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces.\nIf none are specified then the VPC default security group will be used\n"
},
"SubnetIds": {
"shape": "__listOf__string",
"locationName": "subnetIds",
"documentation": "A list of VPC subnet IDs from the same VPC.\nIf STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).\n"
}
},
"documentation": "The properties for a private VPC Output\nWhen this property is specified, the output egress addresses will be created in a user specified VPC\n",
"required": [
"SubnetIds"
]
},
"WavCodingMode": {
"type": "string",
"documentation": "Wav Coding Mode",

View file

@ -3069,7 +3069,7 @@
},
"streamUI":{
"shape":"Boolean",
"documentation":"<p>Boolean indicating whether a streaming session will be configured for the application. If <code>True</code>, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and luanch the component. It must have a graphical user interface. </p>"
"documentation":"<p>Boolean indicating whether a streaming session will be configured for the application. If <code>True</code>, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface. </p>"
}
},
"documentation":"<p>Information about a launch configuration.</p>"
@ -3743,6 +3743,14 @@
"launchConfig":{
"shape":"LaunchConfig",
"documentation":"<p>The launch configuration for the robot application.</p>"
},
"uploadConfigurations":{
"shape":"UploadConfigurations",
"documentation":"<p>The upload configurations for the robot application.</p>"
},
"useDefaultUploadConfigurations":{
"shape":"BoxedBoolean",
"documentation":"<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>. </p>"
}
},
"documentation":"<p>Application configuration information for a robot.</p>"
@ -3979,9 +3987,17 @@
"shape":"LaunchConfig",
"documentation":"<p>The launch configuration for the simulation application.</p>"
},
"uploadConfigurations":{
"shape":"UploadConfigurations",
"documentation":"<p>Information about upload configurations for the simulation application.</p>"
},
"worldConfigs":{
"shape":"WorldConfigs",
"documentation":"<p>A list of world configurations.</p>"
},
"useDefaultUploadConfigurations":{
"shape":"BoxedBoolean",
"documentation":"<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>. </p>"
}
},
"documentation":"<p>Information about a simulation application configuration.</p>"
@ -4207,7 +4223,8 @@
"WrongRegionS3Bucket",
"WrongRegionS3Output",
"WrongRegionRobotApplication",
"WrongRegionSimulationApplication"
"WrongRegionSimulationApplication",
"UploadContentMismatchError"
]
},
"SimulationJobRequest":{
@ -4230,7 +4247,7 @@
},
"useDefaultApplications":{
"shape":"BoxedBoolean",
"documentation":"<p>Boolean indicating whether to use default simulation tool applications.</p>"
"documentation":"<p>A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access. </p>"
},
"robotApplications":{
"shape":"RobotApplicationConfigs",
@ -4839,6 +4856,42 @@
}
}
},
"UploadBehavior":{
"type":"string",
"enum":[
"UPLOAD_ON_TERMINATE",
"UPLOAD_ROLLING_AUTO_REMOVE"
]
},
"UploadConfiguration":{
"type":"structure",
"required":[
"name",
"path",
"uploadBehavior"
],
"members":{
"name":{
"shape":"Name",
"documentation":"<p>A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path. </p> <p> For example, if your simulation output location is <code>s3://my-bucket</code> and your upload configuration name is <code>robot-test</code>, your files will be uploaded to <code>s3://my-bucket/&lt;simid&gt;/&lt;runid&gt;/robot-test</code>. </p>"
},
"path":{
"shape":"Path",
"documentation":"<p> Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of <code>**</code> as a <i>super asterisk</i>. For example, specifying <code>/var/log/**.log</code> causes all .log files in the <code>/var/log</code> directory tree to be collected. For more examples, see <a href=\"https://github.com/gobwas/glob\">Glob Library</a>. </p>"
},
"uploadBehavior":{
"shape":"UploadBehavior",
"documentation":"<p>Specifies how to upload the files:</p> <dl> <dt>UPLOAD_ON_TERMINATE</dt> <dd> <p>Matching files are uploaded once the simulation enters the <code>TERMINATING</code> state. Matching files are not uploaded until all of your code (including tools) have stopped. </p> <p>If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.</p> </dd> <dt>UPLOAD_ROLLING_AUTO_REMOVE</dt> <dd> <p>Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped. </p> </dd> </dl>"
}
},
"documentation":"<p>Provides upload configuration information. Files are uploaded from the simulation job to a location you specify. </p>"
},
"UploadConfigurations":{
"type":"list",
"member":{"shape":"UploadConfiguration"},
"max":10,
"min":0
},
"VPCConfig":{
"type":"structure",
"required":["subnets"],

View file

@ -148,9 +148,10 @@
{"shape":"LimitExceededException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"ConcurrentModificationException"}
{"shape":"ConcurrentModificationException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Starts the process of verifying an email identity. An <i>identity</i> is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.</p> <p>When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. </p> <p>When you verify a domain without specifying the <code>DkimSigningAttributes</code> object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>.</p> <p>Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the <code>CreateEmailIdentity</code> operation has to include the <code>DkimSigningAttributes</code> object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key that you want to use for DKIM authentication) and a private key.</p>"
"documentation":"<p>Starts the process of verifying an email identity. An <i>identity</i> is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.</p> <p>When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. </p> <p>When you verify a domain without specifying the <code>DkimSigningAttributes</code> object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>.</p> <p>Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the <code>CreateEmailIdentity</code> operation has to include the <code>DkimSigningAttributes</code> object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key that you want to use for DKIM authentication) and a private key.</p> <p>When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process.</p> <p>Additionally, you can associate an existing configuration set with the email identity that you're verifying.</p>"
},
"CreateEmailIdentityPolicy":{
"name":"CreateEmailIdentityPolicy",
@ -975,6 +976,21 @@
],
"documentation":"<p>Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.</p> <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see <a href=\"http://aws.amazon.com/ses/pricing/\">Amazon SES Pricing</a>.</p>"
},
"PutEmailIdentityConfigurationSetAttributes":{
"name":"PutEmailIdentityConfigurationSetAttributes",
"http":{
"method":"PUT",
"requestUri":"/v2/email/identities/{EmailIdentity}/configuration-set"
},
"input":{"shape":"PutEmailIdentityConfigurationSetAttributesRequest"},
"output":{"shape":"PutEmailIdentityConfigurationSetAttributesResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Used to associate a configuration set with an email identity.</p>"
},
"PutEmailIdentityDkimAttributes":{
"name":"PutEmailIdentityDkimAttributes",
"http":{
@ -1898,6 +1914,10 @@
"DkimSigningAttributes":{
"shape":"DkimSigningAttributes",
"documentation":"<p>If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, as opposed to the default method, <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>.</p> <p>You can only specify this object if the email identity is a domain, as opposed to an address.</p>"
},
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence. </p>"
}
},
"documentation":"<p>A request to begin the verification process for an email identity (an email address or domain).</p>"
@ -3331,6 +3351,10 @@
"Tags":{
"shape":"TagList",
"documentation":"<p>An array of objects that define the tags (keys and values) that are associated with the email identity.</p>"
},
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The configuration set used by default when sending from this identity.</p>"
}
},
"documentation":"<p>Details about an email identity.</p>"
@ -4606,6 +4630,29 @@
},
"documentation":"<p>A response that indicates whether the Deliverability dashboard is enabled.</p>"
},
"PutEmailIdentityConfigurationSetAttributesRequest":{
"type":"structure",
"required":["EmailIdentity"],
"members":{
"EmailIdentity":{
"shape":"Identity",
"documentation":"<p>The email address or domain that you want to associate with a configuration set.</p>",
"location":"uri",
"locationName":"EmailIdentity"
},
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The configuration set that you want to associate with an email identity.</p>"
}
},
"documentation":"<p>A request to associate a configuration set with an email identity.</p>"
},
"PutEmailIdentityConfigurationSetAttributesResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>"
},
"PutEmailIdentityDkimAttributesRequest":{
"type":"structure",
"required":["EmailIdentity"],

View file

@ -1712,7 +1712,7 @@
"SelectedChoices":{
"type":"list",
"member":{"shape":"ChoiceId"},
"documentation":"<p>List of selected choice IDs in a question answer.</p>"
"documentation":"<p>List of selected choice IDs in a question answer.</p> <p>The values entered replace the previously selected choices.</p>"
},
"ServiceCode":{
"type":"string",
@ -2236,5 +2236,5 @@
"documentation":"<p>A workload summary return object.</p>"
}
},
"documentation":"<fullname>AWS Well-Architected Tool</fullname> <p>This is the <i>AWS Well-Architected Tool API Reference</i>.</p> <p>The AWS Well-Architected Tool API provides programmatic access to the <a href=\"http://aws.amazon.com/well-architected-tool\">AWS Well-Architected Tool</a> in the <a href=\"https://console.aws.amazon.com/wellarchitected\">AWS Management Console</a>.</p> <p> <b>Managing workloads:</b> </p> <ul> <li> <p> <a>CreateWorkload</a>: Define a new workload.</p> </li> <li> <p> <a>ListWorkloads</a>: List workloads.</p> </li> <li> <p> <a>GetWorkload</a>: Get the properties of a workload.</p> </li> <li> <p> <a>UpdateWorkload</a>: Update the properties of a workload.</p> </li> <li> <p> <a>DeleteWorkload</a>: Delete a workload.</p> </li> </ul> <p> <b>Managing milestones:</b> </p> <ul> <li> <p> <a>CreateMilestone</a>: Create a milestone.</p> </li> <li> <p> <a>ListMilestones</a>: List milestones.</p> </li> <li> <p> <a>GetMilestone</a>: Get the properties of a milestone.</p> </li> </ul> <p> <b>Managing lenses:</b> </p> <ul> <li> <p> <a>ListLenses</a>: List the available lenses.</p> </li> <li> <p> <a>AssociateLenses</a>: Add one or more lenses to a workload.</p> </li> <li> <p> <a>DisassociateLenses</a>: Remove one or more lenses from a workload.</p> </li> <li> <p> <a>ListNotifications</a>: List lens notifications for a workload.</p> </li> <li> <p> <a>GetLensVersionDifference</a>: Get the differences between the version of a lens used in a workload and the latest version.</p> </li> <li> <p> <a>UpgradeLensReview</a>: Upgrade a workload to use the latest version of a lens.</p> </li> </ul> <p> <b>Managing reviews:</b> </p> <ul> <li> <p> <a>ListLensReviews</a>: List reviews associated with a workload.</p> </li> <li> <p> <a>GetLensReview</a>: Get pillar and risk data associated with a workload review.</p> </li> <li> <p> <a>GetLensReviewReport</a>: Get the report associated with a workload review.</p> </li> <li> <p> <a>UpdateLensReview</a>: Update the notes associated with a workload review.</p> </li> <li> <p> <a>ListAnswers</a>: List the questions and answers in a workload review.</p> </li> <li> <p> <a>UpdateAnswer</a>: Update the answer to a specific question in a workload review.</p> </li> <li> <p> <a>ListLensReviewImprovements</a>: List the improvement plan associated with a workload review.</p> </li> </ul> <p> <b>Managing workload shares:</b> </p> <ul> <li> <p> <a>ListWorkloadShares</a>: List the workload shares associated with a workload.</p> </li> <li> <p> <a>CreateWorkloadShare</a>: Create a workload share.</p> </li> <li> <p> <a>UpdateWorkloadShare</a>: Update a workload share.</p> </li> <li> <p> <a>DeleteWorkloadShare</a>: Delete a workload share.</p> </li> </ul> <p> <b>Managing workload share invitations:</b> </p> <ul> <li> <p> <a>ListShareInvitations</a>: List workload share invitations.</p> </li> <li> <p> <a>UpdateShareInvitation</a>: Update a workload share invitation.</p> </li> </ul> <p>For information about the AWS Well-Architected Tool, see the <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html\">AWS Well-Architected Tool User Guide</a>.</p>"
"documentation":"<fullname>AWS Well-Architected Tool</fullname> <p>This is the <i>AWS Well-Architected Tool API Reference</i>. The AWS Well-Architected Tool API provides programmatic access to the <a href=\"http://aws.amazon.com/well-architected-tool\">AWS Well-Architected Tool</a> in the <a href=\"https://console.aws.amazon.com/wellarchitected\">AWS Management Console</a>. For information about the AWS Well-Architected Tool, see the <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html\">AWS Well-Architected Tool User Guide</a>.</p>"
}

View file

@ -70,7 +70,6 @@ def type_check(valid_types):
def range_check(name, value, shape, error_type, errors):
failed = False
min_allowed = float('-inf')
max_allowed = float('inf')
if 'min' in shape.metadata:
min_allowed = shape.metadata['min']
if value < min_allowed:
@ -82,8 +81,7 @@ def range_check(name, value, shape, error_type, errors):
if value < min_allowed:
failed = True
if failed:
errors.report(name, error_type, param=value,
valid_range=[min_allowed, max_allowed])
errors.report(name, error_type, param=value, min_allowed=min_allowed)
class ValidationErrors(object):
@ -117,17 +115,15 @@ class ValidationErrors(object):
str(type(additional['param'])),
', '.join(additional['valid_types']))
elif error_type == 'invalid range':
min_allowed = additional['valid_range'][0]
max_allowed = additional['valid_range'][1]
return ('Invalid range for parameter %s, value: %s, valid range: '
'%s-%s' % (name, additional['param'],
min_allowed, max_allowed))
min_allowed = additional['min_allowed']
return ('Invalid value for parameter %s, value: %s, '
'valid min value: %s' % (name, additional['param'],
min_allowed))
elif error_type == 'invalid length':
min_allowed = additional['valid_range'][0]
max_allowed = additional['valid_range'][1]
return ('Invalid length for parameter %s, value: %s, valid range: '
'%s-%s' % (name, additional['param'],
min_allowed, max_allowed))
min_allowed = additional['min_allowed']
return ('Invalid length for parameter %s, value: %s, '
'valid min length: %s' % (name, additional['param'],
min_allowed))
elif error_type == 'unable to encode to json':
return 'Invalid parameter %s must be json serializable: %s' \
% (name, additional['type_error'])

View file

@ -54,7 +54,7 @@ copyright = u'2013, Mitch Garnaat'
# The short X.Y version.
version = '1.19.'
# The full version, including alpha/beta/rc tags.
release = '1.19.59'
release = '1.19.63'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

View file

@ -278,8 +278,8 @@ class TestValidateRanges(BaseTestValidate):
'Long': -10,
},
errors=[
'Invalid range for parameter Int',
'Invalid range for parameter Long',
'Invalid value for parameter Int',
'Invalid value for parameter Long',
]
)
@ -423,7 +423,7 @@ class TestValidationFloatType(BaseTestValidate):
'Float': 1,
},
errors=[
'Invalid range for parameter Float',
'Invalid value for parameter Float',
]
)
@ -441,7 +441,7 @@ class TestValidationFloatType(BaseTestValidate):
'Float': decimal.Decimal('1'),
},
errors=[
'Invalid range for parameter Float',
'Invalid value for parameter Float',
]
)