diff --git a/.changes/2.1498.0.json b/.changes/2.1498.0.json new file mode 100644 index 0000000000..348a5bb4e7 --- /dev/null +++ b/.changes/2.1498.0.json @@ -0,0 +1,102 @@ +[ + { + "type": "feature", + "category": "CodeCatalyst", + "description": "This release includes updates to the Dev Environment APIs to include an optional vpcConnectionName parameter that supports using Dev Environments with Amazon VPC." + }, + { + "type": "feature", + "category": "DLM", + "description": "This release adds support for Amazon Data Lifecycle Manager default policies for EBS snapshots and EBS-backed AMIs." + }, + { + "type": "feature", + "category": "EC2", + "description": "Enable use of tenant-specific PublicSigningKeyUrl from device trust providers and onboard jumpcloud as a new device trust provider." + }, + { + "type": "feature", + "category": "FSx", + "description": "Enables customers to update their PerUnitStorageThroughput on their Lustre file systems." + }, + { + "type": "feature", + "category": "Glue", + "description": "Introduces new column statistics APIs to support statistics generation for tables within the Glue Data Catalog." + }, + { + "type": "feature", + "category": "IVSRealTime", + "description": "This release introduces server side composition and recording for stages." + }, + { + "type": "feature", + "category": "Imagebuilder", + "description": "This release adds the Image Lifecycle Management feature to automate the process of deprecating, disabling and deleting outdated images and their associated resources." + }, + { + "type": "feature", + "category": "Iot", + "description": "GA release the ability to index and search devices based on their GeoLocation data. With GeoQueries you can narrow your search to retrieve devices located in the desired geographic boundary." + }, + { + "type": "feature", + "category": "Kafka", + "description": "Added a new API response field which determines if there is an action required from the customer regarding their cluster." + }, + { + "type": "feature", + "category": "Lambda", + "description": "Adds support for logging configuration in Lambda Functions. Customers will have more control how their function logs are captured and to which cloud watch log group they are delivered also." + }, + { + "type": "feature", + "category": "Macie2", + "description": "This release adds support for configuring Macie to assume an IAM role when retrieving sample occurrences of sensitive data reported by findings." + }, + { + "type": "feature", + "category": "MediaPackage", + "description": "DRM_TOP_LEVEL_COMPACT allows placing content protection elements at the MPD level and referenced at the AdaptationSet level" + }, + { + "type": "feature", + "category": "PinpointSMSVoiceV2", + "description": "Amazon Pinpoint now offers additional operations as part of version 2 of the SMS and voice APIs. This release includes 26 new APIs to create and manage phone number registrations, add verified destination numbers, and request sender IDs." + }, + { + "type": "feature", + "category": "Polly", + "description": "Add new engine - long-form - dedicated for longer content, such as news articles, training materials, or marketing videos." + }, + { + "type": "feature", + "category": "QuickSight", + "description": "Custom permission support for QuickSight roles; Three new datasources STARBURST, TRINO, BIGQUERY; Lenient mode changes the default behavior to allow for exporting and importing with certain UI allowed errors, Support for permissions and tags export and import." + }, + { + "type": "feature", + "category": "SSM", + "description": "This release introduces the ability to filter automation execution steps which have parent steps. In addition, runbook variable information is returned by GetAutomationExecution and parent step information is returned by the DescribeAutomationStepExecutions API." + }, + { + "type": "feature", + "category": "SSMIncidents", + "description": "Introduces new APIs ListIncidentFindings and BatchGetIncidentFindings to use findings related to an incident." + }, + { + "type": "feature", + "category": "SSOAdmin", + "description": "Instances bound to a single AWS account, API operations for managing instances and applications, and assignments to applications are now supported. Trusted identity propagation is also supported, with new API operations for managing trusted token issuers and application grants and scopes." + }, + { + "type": "feature", + "category": "SageMaker", + "description": "Amazon SageMaker Studio now supports Trainium instance types - trn1.2xlarge, trn1.32xlarge, trn1n.32xlarge." + }, + { + "type": "feature", + "category": "Transfer", + "description": "Introduced S3StorageOptions for servers to enable directory listing optimizations and added Type fields to logical directory mappings." + } +] \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e41c05297..7d79be53ad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,29 @@ # Changelog for AWS SDK for JavaScript - + +## 2.1498.0 +* feature: CodeCatalyst: This release includes updates to the Dev Environment APIs to include an optional vpcConnectionName parameter that supports using Dev Environments with Amazon VPC. +* feature: DLM: This release adds support for Amazon Data Lifecycle Manager default policies for EBS snapshots and EBS-backed AMIs. +* feature: EC2: Enable use of tenant-specific PublicSigningKeyUrl from device trust providers and onboard jumpcloud as a new device trust provider. +* feature: FSx: Enables customers to update their PerUnitStorageThroughput on their Lustre file systems. +* feature: Glue: Introduces new column statistics APIs to support statistics generation for tables within the Glue Data Catalog. +* feature: IVSRealTime: This release introduces server side composition and recording for stages. +* feature: Imagebuilder: This release adds the Image Lifecycle Management feature to automate the process of deprecating, disabling and deleting outdated images and their associated resources. +* feature: Iot: GA release the ability to index and search devices based on their GeoLocation data. With GeoQueries you can narrow your search to retrieve devices located in the desired geographic boundary. +* feature: Kafka: Added a new API response field which determines if there is an action required from the customer regarding their cluster. +* feature: Lambda: Adds support for logging configuration in Lambda Functions. Customers will have more control how their function logs are captured and to which cloud watch log group they are delivered also. +* feature: Macie2: This release adds support for configuring Macie to assume an IAM role when retrieving sample occurrences of sensitive data reported by findings. +* feature: MediaPackage: DRM_TOP_LEVEL_COMPACT allows placing content protection elements at the MPD level and referenced at the AdaptationSet level +* feature: PinpointSMSVoiceV2: Amazon Pinpoint now offers additional operations as part of version 2 of the SMS and voice APIs. This release includes 26 new APIs to create and manage phone number registrations, add verified destination numbers, and request sender IDs. +* feature: Polly: Add new engine - long-form - dedicated for longer content, such as news articles, training materials, or marketing videos. +* feature: QuickSight: Custom permission support for QuickSight roles; Three new datasources STARBURST, TRINO, BIGQUERY; Lenient mode changes the default behavior to allow for exporting and importing with certain UI allowed errors, Support for permissions and tags export and import. +* feature: SSM: This release introduces the ability to filter automation execution steps which have parent steps. In addition, runbook variable information is returned by GetAutomationExecution and parent step information is returned by the DescribeAutomationStepExecutions API. +* feature: SSMIncidents: Introduces new APIs ListIncidentFindings and BatchGetIncidentFindings to use findings related to an incident. +* feature: SSOAdmin: Instances bound to a single AWS account, API operations for managing instances and applications, and assignments to applications are now supported. Trusted identity propagation is also supported, with new API operations for managing trusted token issuers and application grants and scopes. +* feature: SageMaker: Amazon SageMaker Studio now supports Trainium instance types - trn1.2xlarge, trn1.32xlarge, trn1n.32xlarge. +* feature: Transfer: Introduced S3StorageOptions for servers to enable directory listing optimizations and added Type fields to logical directory mappings. + ## 2.1497.0 * feature: AutoScaling: This release introduces Instance Maintenance Policy, a new EC2 Auto Scaling capability that allows customers to define whether instances are launched before or after existing instances are terminated during instance replacement operations. * feature: CloudTrail: The Lake Repricing feature lets customers configure a BillingMode for an event data store. The BillingMode determines the cost for ingesting and storing events and the default and maximum retention period for the event data store. diff --git a/README.md b/README.md index 8322390b01..2f4bab4ae1 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ require('aws-sdk/lib/maintenance_mode_message').suppress = true; To use the SDK in the browser, simply add the following script tag to your HTML pages: - + You can also build a custom browser SDK with your specified set of AWS services. This can allow you to reduce the SDK's size, specify different API versions of diff --git a/apis/codecatalyst-2022-09-28.min.json b/apis/codecatalyst-2022-09-28.min.json index 31546e5e42..0617056349 100644 --- a/apis/codecatalyst-2022-09-28.min.json +++ b/apis/codecatalyst-2022-09-28.min.json @@ -106,7 +106,8 @@ "type": "integer" } } - } + }, + "vpcConnectionName": {} } }, "output": { @@ -119,7 +120,8 @@ "members": { "spaceName": {}, "projectName": {}, - "id": {} + "id": {}, + "vpcConnectionName": {} } }, "idempotent": true @@ -493,7 +495,8 @@ }, "persistentStorage": { "shape": "S1m" - } + }, + "vpcConnectionName": {} } } }, @@ -1032,7 +1035,8 @@ }, "persistentStorage": { "shape": "S1m" - } + }, + "vpcConnectionName": {} } } }, diff --git a/apis/codecatalyst-2022-09-28.normal.json b/apis/codecatalyst-2022-09-28.normal.json index d2262a2fa5..8eb5a99ad9 100644 --- a/apis/codecatalyst-2022-09-28.normal.json +++ b/apis/codecatalyst-2022-09-28.normal.json @@ -1512,6 +1512,10 @@ "persistentStorage": { "shape": "PersistentStorageConfiguration", "documentation": "
Information about the amount of storage allocated to the Dev Environment.
By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.
The name of the connection to use connect to a Amazon VPC.
" } } }, @@ -1540,6 +1544,10 @@ "id": { "shape": "Uuid", "documentation": "The system-generated unique ID of the Dev Environment.
" + }, + "vpcConnectionName": { + "shape": "NameString", + "documentation": "The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
" } } }, @@ -2085,6 +2093,10 @@ "persistentStorage": { "shape": "PersistentStorage", "documentation": "Information about the configuration of persistent storage for the Dev Environment.
" + }, + "vpcConnectionName": { + "shape": "NameString", + "documentation": "The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
" } }, "documentation": "Information about a Dev Environment.
" @@ -2377,6 +2389,10 @@ "persistentStorage": { "shape": "PersistentStorage", "documentation": "Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.
" + }, + "vpcConnectionName": { + "shape": "NameString", + "documentation": "The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
" } } }, diff --git a/apis/dlm-2018-01-12.min.json b/apis/dlm-2018-01-12.min.json index 78141ecc2e..3e29288a08 100644 --- a/apis/dlm-2018-01-12.min.json +++ b/apis/dlm-2018-01-12.min.json @@ -22,8 +22,7 @@ "required": [ "ExecutionRoleArn", "Description", - "State", - "PolicyDetails" + "State" ], "members": { "ExecutionRoleArn": {}, @@ -33,7 +32,26 @@ "shape": "S5" }, "Tags": { - "shape": "S25" + "shape": "S2g" + }, + "DefaultPolicy": {}, + "CreateInterval": { + "type": "integer" + }, + "RetainInterval": { + "type": "integer" + }, + "CopyTags": { + "type": "boolean" + }, + "ExtendDeletion": { + "type": "boolean" + }, + "CrossRegionCopyTargets": { + "shape": "S28" + }, + "Exclusions": { + "shape": "S2b" } } }, @@ -47,7 +65,7 @@ "DeleteLifecyclePolicy": { "http": { "method": "DELETE", - "requestUri": "/policies/{policyId}/" + "requestUri": "/policies/{policyId}" }, "input": { "type": "structure", @@ -100,6 +118,10 @@ "locationName": "tagsToAdd", "type": "list", "member": {} + }, + "DefaultPolicyType": { + "location": "querystring", + "locationName": "defaultPolicyType" } } }, @@ -115,9 +137,12 @@ "Description": {}, "State": {}, "Tags": { - "shape": "S25" + "shape": "S2g" }, - "PolicyType": {} + "PolicyType": {}, + "DefaultPolicy": { + "type": "boolean" + } } } } @@ -127,7 +152,7 @@ "GetLifecyclePolicy": { "http": { "method": "GET", - "requestUri": "/policies/{policyId}/" + "requestUri": "/policies/{policyId}" }, "input": { "type": "structure", @@ -153,18 +178,21 @@ "StatusMessage": {}, "ExecutionRoleArn": {}, "DateCreated": { - "shape": "S2p" + "shape": "S33" }, "DateModified": { - "shape": "S2p" + "shape": "S33" }, "PolicyDetails": { "shape": "S5" }, "Tags": { - "shape": "S25" + "shape": "S2g" }, - "PolicyArn": {} + "PolicyArn": {}, + "DefaultPolicy": { + "type": "boolean" + } } } } @@ -191,7 +219,7 @@ "type": "structure", "members": { "Tags": { - "shape": "S25" + "shape": "S2g" } } } @@ -212,7 +240,7 @@ "locationName": "resourceArn" }, "Tags": { - "shape": "S25" + "shape": "S2g" } } }, @@ -270,6 +298,24 @@ "Description": {}, "PolicyDetails": { "shape": "S5" + }, + "CreateInterval": { + "type": "integer" + }, + "RetainInterval": { + "type": "integer" + }, + "CopyTags": { + "type": "boolean" + }, + "ExtendDeletion": { + "type": "boolean" + }, + "CrossRegionCopyTargets": { + "shape": "S28" + }, + "Exclusions": { + "shape": "S2b" } } }, @@ -566,6 +612,26 @@ } } } + }, + "PolicyLanguage": {}, + "ResourceType": {}, + "CreateInterval": { + "type": "integer" + }, + "RetainInterval": { + "type": "integer" + }, + "CopyTags": { + "type": "boolean" + }, + "CrossRegionCopyTargets": { + "shape": "S28" + }, + "ExtendDeletion": { + "type": "boolean" + }, + "Exclusions": { + "shape": "S2b" } } }, @@ -593,12 +659,39 @@ "IntervalUnit": {} } }, - "S25": { + "S28": { + "type": "list", + "member": { + "type": "structure", + "members": { + "TargetRegion": {} + } + } + }, + "S2b": { + "type": "structure", + "members": { + "ExcludeBootVolumes": { + "type": "boolean" + }, + "ExcludeVolumeTypes": { + "type": "list", + "member": {} + }, + "ExcludeTags": { + "type": "list", + "member": { + "shape": "Sc" + } + } + } + }, + "S2g": { "type": "map", "key": {}, "value": {} }, - "S2p": { + "S33": { "type": "timestamp", "timestampFormat": "iso8601" } diff --git a/apis/dlm-2018-01-12.normal.json b/apis/dlm-2018-01-12.normal.json index 3d481a7386..6dc17781fc 100644 --- a/apis/dlm-2018-01-12.normal.json +++ b/apis/dlm-2018-01-12.normal.json @@ -36,13 +36,13 @@ "shape": "InternalServerException" } ], - "documentation": "Creates a policy to manage the lifecycle of the specified Amazon Web Services resources. You can create up to 100 lifecycle policies.
" + "documentation": "Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types:
Custom EBS snapshot policy
Custom EBS-backed AMI policy
Cross-account copy event policy
Default policy for EBS snapshots
Default policy for EBS-backed AMIs
For more information, see Default policies vs custom policies.
If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.
Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots.
" } }, - "documentation": "[Snapshot policies only] Specifies information about the archive storage tier retention period.
" + "documentation": "[Custom snapshot policies only] Specifies information about the archive storage tier retention period.
" }, "ArchiveRule": { "type": "structure", @@ -277,7 +277,7 @@ "documentation": "Information about the retention period for the snapshot archiving rule.
" } }, - "documentation": "[Snapshot policies only] Specifies a snapshot archiving rule for a schedule.
" + "documentation": "[Custom snapshot policies only] Specifies a snapshot archiving rule for a schedule.
" }, "AvailabilityZone": { "type": "string", @@ -316,13 +316,16 @@ "max": 1000, "min": 1 }, + "CreateInterval": { + "type": "integer", + "min": 1 + }, "CreateLifecyclePolicyRequest": { "type": "structure", "required": [ "ExecutionRoleArn", "Description", - "State", - "PolicyDetails" + "State" ], "members": { "ExecutionRoleArn": { @@ -335,15 +338,43 @@ }, "State": { "shape": "SettablePolicyStateValues", - "documentation": "The desired activation state of the lifecycle policy after creation.
" + "documentation": "The activation state of the lifecycle policy after creation.
" }, "PolicyDetails": { "shape": "PolicyDetails", - "documentation": "The configuration details of the lifecycle policy.
" + "documentation": "The configuration details of the lifecycle policy.
If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.
The tags to apply to the lifecycle policy during creation.
" + }, + "DefaultPolicy": { + "shape": "DefaultPolicyTypeValues", + "documentation": "[Default policies only] Specify the type of default policy to create.
To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME
.
To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE
.
[Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.
Default: 1
" + }, + "RetainInterval": { + "shape": "RetainInterval", + "documentation": "[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.
Default: 7
" + }, + "CopyTags": { + "shape": "CopyTagsNullable", + "documentation": " [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false
.
Default: false
" + }, + "ExtendDeletion": { + "shape": "ExtendDeletion", + "documentation": "[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
By default (ExtendDeletion=false):
If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true
.
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true
.
If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.
If you do not specify a value, the default is false
.
Default: false
" + }, + "CrossRegionCopyTargets": { + "shape": "CrossRegionCopyTargetList", + "documentation": "[Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
" + }, + "Exclusions": { + "shape": "Exclusions", + "documentation": "[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
" } } }, @@ -361,7 +392,7 @@ "members": { "Location": { "shape": "LocationValues", - "documentation": " [Snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD
. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL
. If you omit this parameter, CLOUD
is used by default.
If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.
" + "documentation": " [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD
. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL
. If you omit this parameter, CLOUD
is used by default.
If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.
" }, "Interval": { "shape": "Interval", @@ -381,10 +412,10 @@ }, "Scripts": { "shape": "ScriptsList", - "documentation": "[Snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
For more information, see Automating application-consistent snapshots with pre and post scripts.
" + "documentation": "[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
For more information, see Automating application-consistent snapshots with pre and post scripts.
" } }, - "documentation": "[Snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.
You must specify either CronExpression, or Interval, IntervalUnit, and Times.
If you need to specify an ArchiveRule for the schedule, then you must specify a creation frequency of at least 28 days.
[Custom snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.
You must specify either CronExpression, or Interval, IntervalUnit, and Times.
If you need to specify an ArchiveRule for the schedule, then you must specify a creation frequency of at least 28 days.
The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3
and IntervalUnit=MONTHS
.
[AMI policies only] Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.
" + "documentation": "[Custom AMI policies only] Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.
" }, "CrossRegionCopyRetainRule": { "type": "structure", @@ -457,11 +488,11 @@ "members": { "TargetRegion": { "shape": "TargetRegion", - "documentation": "Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.
[AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
" + "documentation": "Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.
[Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
" }, "Target": { "shape": "Target", - "documentation": "Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.
[Snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
" + "documentation": "Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.
[Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
" }, "Encrypted": { "shape": "Encrypted", @@ -481,10 +512,10 @@ }, "DeprecateRule": { "shape": "CrossRegionCopyDeprecateRule", - "documentation": "[AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
" + "documentation": "[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
" } }, - "documentation": "[Snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.
To specify a cross-Region copy action for event-based polices, use CrossRegionCopyAction.
[Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.
To specify a cross-Region copy action for event-based polices, use CrossRegionCopyAction.
The target Region, for example us-east-1
.
[Default policies only] Specifies a destination Region for cross-Region copy actions.
" + }, + "CrossRegionCopyTargetList": { + "type": "list", + "member": { + "shape": "CrossRegionCopyTarget" + }, + "max": 3, + "min": 0 + }, + "DefaultPoliciesTypeValues": { + "type": "string", + "enum": [ + "VOLUME", + "INSTANCE", + "ALL" + ] + }, + "DefaultPolicy": { + "type": "boolean" + }, + "DefaultPolicyTypeValues": { + "type": "string", + "enum": [ + "VOLUME", + "INSTANCE" + ] + }, "DeleteLifecyclePolicyRequest": { "type": "structure", "required": [ @@ -528,7 +595,7 @@ "documentation": "The unit of time in which to measure the Interval.
" } }, - "documentation": "[AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.
For age-based schedules, you must specify Interval and IntervalUnit. For count-based schedules, you must specify Count.
" + "documentation": "[Custom AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.
For age-based schedules, you must specify Interval and IntervalUnit. For count-based schedules, you must specify Count.
" }, "DescriptionRegex": { "type": "string", @@ -611,6 +678,9 @@ "ExcludeBootVolume": { "type": "boolean" }, + "ExcludeBootVolumes": { + "type": "boolean" + }, "ExcludeDataVolumeTagList": { "type": "list", "member": { @@ -619,6 +689,40 @@ "max": 50, "min": 0 }, + "ExcludeTagsList": { + "type": "list", + "member": { + "shape": "Tag" + }, + "max": 50, + "min": 0 + }, + "ExcludeVolumeTypesList": { + "type": "list", + "member": { + "shape": "VolumeTypeValues" + }, + "max": 6, + "min": 0 + }, + "Exclusions": { + "type": "structure", + "members": { + "ExcludeBootVolumes": { + "shape": "ExcludeBootVolumes", + "documentation": " [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true
.
[Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.
" + }, + "ExcludeTags": { + "shape": "ExcludeTagsList", + "documentation": "[Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
" + } + }, + "documentation": "[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
" + }, "ExecuteOperationOnScriptFailure": { "type": "boolean" }, @@ -640,6 +744,9 @@ "min": 0, "pattern": "arn:aws(-[a-z]{1,3}){0,2}:iam::\\d+:role/.*" }, + "ExtendDeletion": { + "type": "boolean" + }, "FastRestoreRule": { "type": "structure", "required": [ @@ -663,7 +770,7 @@ "documentation": "The Availability Zones in which to enable fast snapshot restore.
" } }, - "documentation": "[Snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by snapshot policies. You can enable fast snapshot restore based on either a count or a time interval.
" + "documentation": "[Custom snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by snapshot policies. You can enable fast snapshot restore based on either a count or a time interval.
" }, "GetLifecyclePoliciesRequest": { "type": "structure", @@ -697,6 +804,12 @@ "documentation": "The tags to add to objects created by the policy.
Tags are strings in the format key=value
.
These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.
", "location": "querystring", "locationName": "tagsToAdd" + }, + "DefaultPolicyType": { + "shape": "DefaultPoliciesTypeValues", + "documentation": "[Default policies only] Specifies the type of default policy to get. Specify one of the following:
VOLUME
- To get only the default policy for EBS snapshots
INSTANCE
- To get only the default policy for EBS-backed AMIs
ALL
- To get all default policies
The Amazon Resource Name (ARN) of the policy.
" + }, + "DefaultPolicy": { + "shape": "DefaultPolicy", + "documentation": "[Default policies only] The type of default policy. Values include:
VOLUME
- Default policy for EBS snapshots
INSTANCE
- Default policy for EBS-backed AMIs
[All policy types] Detailed information about a snapshot, AMI, or event-based lifecycle policy.
" + "documentation": "[Custom policies only] Detailed information about a snapshot, AMI, or event-based lifecycle policy.
" }, "LifecyclePolicySummary": { "type": "structure", @@ -818,6 +935,10 @@ "PolicyType": { "shape": "PolicyTypeValues", "documentation": "The type of policy. EBS_SNAPSHOT_MANAGEMENT
indicates that the policy manages the lifecycle of Amazon EBS snapshots. IMAGE_MANAGEMENT
indicates that the policy manages the lifecycle of EBS-backed AMIs. EVENT_BASED_POLICY
indicates that the policy automates cross-account snapshot copies for snapshots that are shared with your account.
[Default policies only] The type of default policy. Values include:
VOLUME
- Default policy for EBS snapshots
INSTANCE
- Default policy for EBS-backed AMIs
Summary information about a lifecycle policy.
" @@ -866,18 +987,18 @@ "members": { "ExcludeBootVolume": { "shape": "ExcludeBootVolume", - "documentation": " [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false
. If you specify true
, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
[Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false
. If you specify true
, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
[AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true
indicates that targeted instances are not rebooted when the policy runs. false
indicates that target instances are rebooted when the policy runs. The default is true
(instances are not rebooted).
[Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true
indicates that targeted instances are not rebooted when the policy runs. false
indicates that target instances are rebooted when the policy runs. The default is true
(instances are not rebooted).
[Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
" + "documentation": "[Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
" } }, - "documentation": "[Snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The set of valid parameters depends on the combination of policy type and target resource type.
If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed
Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch.
[Custom snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The set of valid parameters depends on the combination of policy type and target resource type.
If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed
Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch.
[All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT
to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT
to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY
to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT
.
[Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT
to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT
to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY
to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT
.
[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME
to create snapshots of individual volumes or use INSTANCE
to create multi-volume snapshots from the volumes for an instance.
[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME
to create snapshots of individual volumes or use INSTANCE
to create multi-volume snapshots from the volumes for an instance.
[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD
. If the source resources are located on an Outpost in your account, specify OUTPOST
.
If you specify OUTPOST
, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.
[Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD
. If the source resources are located on an Outpost in your account, specify OUTPOST
.
If you specify OUTPOST
, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.
[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
" + "documentation": "[Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
" }, "Schedules": { "shape": "ScheduleList", - "documentation": "[Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
" + "documentation": "[Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
" }, "Parameters": { "shape": "Parameters", - "documentation": "[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.
[Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.
[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
" + }, + "PolicyLanguage": { + "shape": "PolicyLanguageValues", + "documentation": "The type of policy to create. Specify one of the following:
SIMPLIFIED
To create a default policy.
STANDARD
To create a custom policy.
[Default policies only] Specify the type of default policy to create.
To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME
.
To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE
.
[Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.
Default: 1
" + }, + "RetainInterval": { + "shape": "RetainInterval", + "documentation": "[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.
Default: 7
" + }, + "CopyTags": { + "shape": "CopyTagsNullable", + "documentation": " [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false
.
Default: false
" + }, + "CrossRegionCopyTargets": { + "shape": "CrossRegionCopyTargetList", + "documentation": "[Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
" + }, + "ExtendDeletion": { + "shape": "ExtendDeletion", + "documentation": "[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
By default (ExtendDeletion=false):
If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true
.
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true
.
If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.
If you do not specify a value, the default is false
.
Default: false
" + }, + "Exclusions": { + "shape": "Exclusions", + "documentation": "[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
" } }, - "documentation": "[All policy types] Specifies the configuration of a lifecycle policy.
" + "documentation": "Specifies the configuration of a lifecycle policy.
" }, "PolicyId": { "type": "string", "max": 64, "min": 0, - "pattern": "policy-[A-Za-z0-9]+" + "pattern": "policy-[a-f0-9]+" }, "PolicyIdList": { "type": "list", @@ -941,6 +1094,13 @@ "shape": "PolicyId" } }, + "PolicyLanguageValues": { + "type": "string", + "enum": [ + "SIMPLIFIED", + "STANDARD" + ] + }, "PolicyTypeValues": { "type": "string", "enum": [ @@ -979,6 +1139,10 @@ "max": 1, "min": 1 }, + "RetainInterval": { + "type": "integer", + "min": 1 + }, "RetainRule": { "type": "structure", "members": { @@ -995,7 +1159,7 @@ "documentation": "The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3
and IntervalUnit=MONTHS
. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
[Snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs created by AMI policies.
For snapshot policies that have an ArchiveRule, this retention rule applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the archive tier.
For snapshot policies that do not have an ArchiveRule, snapshots are permanently deleted when this retention threshold is met.
You can retain snapshots based on either a count or a time interval.
Count-based retention
You must specify Count. If you specify an ArchiveRule for the schedule, then you can specify a retention count of 0
to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention count of 1
or more.
Age-based retention
You must specify Interval and IntervalUnit. If you specify an ArchiveRule for the schedule, then you can specify a retention interval of 0
days to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention interval of 1
day or more.
[Custom snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs created by AMI policies.
For snapshot policies that have an ArchiveRule, this retention rule applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the archive tier.
For snapshot policies that do not have an ArchiveRule, snapshots are permanently deleted when this retention threshold is met.
You can retain snapshots based on either a count or a time interval.
Count-based retention
You must specify Count. If you specify an ArchiveRule for the schedule, then you can specify a retention count of 0
to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention count of 1
or more.
Age-based retention
You must specify Interval and IntervalUnit. If you specify an ArchiveRule for the schedule, then you can specify a retention interval of 0
days to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention interval of 1
day or more.
The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6
and IntervalUnit=MONTHS
.
[Snapshot policies only] Describes the retention rule for archived snapshots. Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.
The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.
For count-based schedules, you must specify Count. For age-based schedules, you must specify Interval and IntervalUnit.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
" + "documentation": "[Custom snapshot policies only] Describes the retention rule for archived snapshots. Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.
The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.
For count-based schedules, you must specify Count. For age-based schedules, you must specify Interval and IntervalUnit.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
" }, "RetentionIntervalUnitValues": { "type": "string", @@ -1053,7 +1217,7 @@ }, "FastRestoreRule": { "shape": "FastRestoreRule", - "documentation": "[Snapshot policies only] The rule for enabling fast snapshot restore.
" + "documentation": "[Custom snapshot policies only] The rule for enabling fast snapshot restore.
" }, "CrossRegionCopyRules": { "shape": "CrossRegionCopyRules", @@ -1061,18 +1225,18 @@ }, "ShareRules": { "shape": "ShareRules", - "documentation": "[Snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
" + "documentation": "[Custom snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
" }, "DeprecateRule": { "shape": "DeprecateRule", - "documentation": "[AMI policies only] The AMI deprecation rule for the schedule.
" + "documentation": "[Custom AMI policies only] The AMI deprecation rule for the schedule.
" }, "ArchiveRule": { "shape": "ArchiveRule", - "documentation": "[Snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
" + "documentation": "[Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
" } }, - "documentation": "[Snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
" + "documentation": "[Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
" }, "ScheduleList": { "type": "list", @@ -1119,7 +1283,7 @@ "documentation": "Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.
If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.
If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.
If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0
.
Default: 0
" } }, - "documentation": "[Snapshot policies that target instances only] Information about pre and/or post scripts for a snapshot lifecycle policy that targets instances. For more information, see Automating application-consistent snapshots with pre and post scripts.
" + "documentation": "[Custom snapshot policies that target instances only] Information about pre and/or post scripts for a snapshot lifecycle policy that targets instances. For more information, see Automating application-consistent snapshots with pre and post scripts.
" }, "ScriptExecutionTimeout": { "type": "integer", @@ -1165,7 +1329,7 @@ "documentation": "The unit of time for the automatic unsharing interval.
" } }, - "documentation": "[Snapshot policies only] Specifies a rule for sharing snapshots across Amazon Web Services accounts.
" + "documentation": "[Custom snapshot policies only] Specifies a rule for sharing snapshots across Amazon Web Services accounts.
" }, "ShareRules": { "type": "list", @@ -1416,6 +1580,30 @@ "PolicyDetails": { "shape": "PolicyDetails", "documentation": "The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
" + }, + "CreateInterval": { + "shape": "CreateInterval", + "documentation": "[Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
" + }, + "RetainInterval": { + "shape": "RetainInterval", + "documentation": "[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.
" + }, + "CopyTags": { + "shape": "CopyTagsNullable", + "documentation": "[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
" + }, + "ExtendDeletion": { + "shape": "ExtendDeletion", + "documentation": "[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
By default (ExtendDeletion=false):
If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true
.
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true
.
If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.
Default: false
" + }, + "CrossRegionCopyTargets": { + "shape": "CrossRegionCopyTargetList", + "documentation": "[Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
" + }, + "Exclusions": { + "shape": "Exclusions", + "documentation": "[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
" } } }, @@ -1430,6 +1618,9 @@ }, "max": 45, "min": 0 + }, + "VolumeTypeValues": { + "type": "string" } }, "documentation": "With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create lifecycle policies, which are used to automate operations on the specified resources.
Amazon Data Lifecycle Manager supports Amazon EBS volumes and snapshots. For information about using Amazon Data Lifecycle Manager with Amazon EBS, see Amazon Data Lifecycle Manager in the Amazon EC2 User Guide.
" diff --git a/apis/ec2-2016-11-15.min.json b/apis/ec2-2016-11-15.min.json index 05e4d31730..11cc9f3af7 100644 --- a/apis/ec2-2016-11-15.min.json +++ b/apis/ec2-2016-11-15.min.json @@ -4765,7 +4765,8 @@ "DeviceOptions": { "type": "structure", "members": { - "TenantId": {} + "TenantId": {}, + "PublicSigningKeyUrl": {} } }, "PolicyReferenceName": {}, @@ -22070,6 +22071,12 @@ "Scope": {} } }, + "DeviceOptions": { + "type": "structure", + "members": { + "PublicSigningKeyUrl": {} + } + }, "Description": {}, "DryRun": { "type": "boolean" @@ -22395,13 +22402,13 @@ ], "members": { "AccepterPeeringConnectionOptions": { - "shape": "S284" + "shape": "S285" }, "DryRun": { "type": "boolean" }, "RequesterPeeringConnectionOptions": { - "shape": "S284" + "shape": "S285" }, "VpcPeeringConnectionId": {} } @@ -22410,11 +22417,11 @@ "type": "structure", "members": { "AccepterPeeringConnectionOptions": { - "shape": "S286", + "shape": "S287", "locationName": "accepterPeeringConnectionOptions" }, "RequesterPeeringConnectionOptions": { - "shape": "S286", + "shape": "S287", "locationName": "requesterPeeringConnectionOptions" } } @@ -22638,7 +22645,7 @@ "type": "structure", "members": { "InstanceMonitorings": { - "shape": "S28l", + "shape": "S28m", "locationName": "instancesSet" } } @@ -24567,7 +24574,7 @@ "type": "integer" }, "Groups": { - "shape": "S2cc", + "shape": "S2cd", "locationName": "Group" }, "Ipv6AddressCount": { @@ -24616,7 +24623,7 @@ }, "RamdiskId": {}, "SecurityGroupIds": { - "shape": "S2cc", + "shape": "S2cd", "locationName": "SecurityGroupId" }, "SubnetId": {}, @@ -24830,7 +24837,7 @@ "type": "structure", "members": { "StartingInstances": { - "shape": "S2d0", + "shape": "S2d1", "locationName": "instancesSet" } } @@ -24957,7 +24964,7 @@ "type": "structure", "members": { "StoppingInstances": { - "shape": "S2d0", + "shape": "S2d1", "locationName": "instancesSet" } } @@ -25032,7 +25039,7 @@ "type": "structure", "members": { "TerminatingInstances": { - "shape": "S2d0", + "shape": "S2d1", "locationName": "instancesSet" } } @@ -25173,7 +25180,7 @@ "type": "structure", "members": { "InstanceMonitorings": { - "shape": "S28l", + "shape": "S28m", "locationName": "instancesSet" } } @@ -25192,7 +25199,7 @@ "shape": "S6q" }, "SecurityGroupRuleDescriptions": { - "shape": "S2dq", + "shape": "S2dr", "locationName": "SecurityGroupRuleDescription" } } @@ -25220,7 +25227,7 @@ "shape": "S6q" }, "SecurityGroupRuleDescriptions": { - "shape": "S2dq", + "shape": "S2dr", "locationName": "SecurityGroupRuleDescription" } } @@ -26159,6 +26166,9 @@ "members": { "TenantId": { "locationName": "tenantId" + }, + "PublicSigningKeyUrl": { + "locationName": "publicSigningKeyUrl" } } }, @@ -35132,7 +35142,7 @@ } } }, - "S284": { + "S285": { "type": "structure", "members": { "AllowDnsResolutionFromRemoteVpc": { @@ -35146,7 +35156,7 @@ } } }, - "S286": { + "S287": { "type": "structure", "members": { "AllowDnsResolutionFromRemoteVpc": { @@ -35163,7 +35173,7 @@ } } }, - "S28l": { + "S28m": { "type": "list", "member": { "locationName": "item", @@ -35179,13 +35189,13 @@ } } }, - "S2cc": { + "S2cd": { "type": "list", "member": { "locationName": "SecurityGroupId" } }, - "S2d0": { + "S2d1": { "type": "list", "member": { "locationName": "item", @@ -35205,7 +35215,7 @@ } } }, - "S2dq": { + "S2dr": { "type": "list", "member": { "locationName": "item", diff --git a/apis/ec2-2016-11-15.normal.json b/apis/ec2-2016-11-15.normal.json index b7d5cf656c..f1cb5173e9 100644 --- a/apis/ec2-2016-11-15.normal.json +++ b/apis/ec2-2016-11-15.normal.json @@ -17821,6 +17821,10 @@ "TenantId": { "shape": "String", "documentation": "The ID of the tenant application with the device-identity provider.
" + }, + "PublicSigningKeyUrl": { + "shape": "String", + "documentation": "The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.
" } }, "documentation": "Describes the options when creating an Amazon Web Services Verified Access trust provider using the device
type.
The ID of the tenant application with the device-identity provider.
", "locationName": "tenantId" + }, + "PublicSigningKeyUrl": { + "shape": "String", + "documentation": "The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.
", + "locationName": "publicSigningKeyUrl" } }, "documentation": "Describes the options for an Amazon Web Services Verified Access device-identity based trust provider.
" @@ -27868,7 +27877,8 @@ "type": "string", "enum": [ "jamf", - "crowdstrike" + "crowdstrike", + "jumpcloud" ] }, "DeviceType": { @@ -45821,6 +45831,16 @@ } } }, + "ModifyVerifiedAccessTrustProviderDeviceOptions": { + "type": "structure", + "members": { + "PublicSigningKeyUrl": { + "shape": "String", + "documentation": "The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.
" + } + }, + "documentation": "Modifies the configuration of the specified device-based Amazon Web Services Verified Access trust provider.
" + }, "ModifyVerifiedAccessTrustProviderOidcOptions": { "type": "structure", "members": { @@ -45869,6 +45889,10 @@ "shape": "ModifyVerifiedAccessTrustProviderOidcOptions", "documentation": "The options for an OpenID Connect-compatible user-identity trust provider.
" }, + "DeviceOptions": { + "shape": "ModifyVerifiedAccessTrustProviderDeviceOptions", + "documentation": "The options for a device-based trust provider. This parameter is required when the provider type is device
.
A description for the Verified Access trust provider.
" diff --git a/apis/fsx-2018-03-01.min.json b/apis/fsx-2018-03-01.min.json index 4895538f36..9bdc5a97d2 100644 --- a/apis/fsx-2018-03-01.min.json +++ b/apis/fsx-2018-03-01.min.json @@ -1449,6 +1449,9 @@ }, "RootSquashConfiguration": { "shape": "S2a" + }, + "PerUnitStorageThroughput": { + "type": "integer" } } }, diff --git a/apis/fsx-2018-03-01.normal.json b/apis/fsx-2018-03-01.normal.json index 87ed5dafe7..9eb96de411 100644 --- a/apis/fsx-2018-03-01.normal.json +++ b/apis/fsx-2018-03-01.normal.json @@ -1279,7 +1279,7 @@ "shape": "ServiceLimitExceeded" } ], - "documentation": "Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
StorageType
ThroughputCapacity
DiskIopsConfiguration
WeeklyMaintenanceStartTime
For FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
LogConfiguration
LustreRootSquashConfiguration
StorageCapacity
WeeklyMaintenanceStartTime
For FSx for ONTAP file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For FSx for OpenZFS file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
DiskIopsConfiguration
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
StorageType
ThroughputCapacity
DiskIopsConfiguration
WeeklyMaintenanceStartTime
For FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
LogConfiguration
LustreRootSquashConfiguration
PerUnitStorageThroughput
StorageCapacity
WeeklyMaintenanceStartTime
For FSx for ONTAP file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For FSx for OpenZFS file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
DiskIopsConfiguration
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE
- A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem
), or CLI (update-file-system
).
THROUGHPUT_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the ProgressPercent
property. When THROUGHPUT_OPTIMIZATION
has been completed successfully, the parent FILE_SYSTEM_UPDATE
action status changes to COMPLETED
. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.
STORAGE_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
task to increase a file system's storage capacity has been completed successfully, a STORAGE_OPTIMIZATION
task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage-optimization progress using the ProgressPercent
property. When STORAGE_OPTIMIZATION
has been completed successfully, the parent FILE_SYSTEM_UPDATE
action status changes to COMPLETED
. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
FILE_SYSTEM_ALIAS_ASSOCIATION
- A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.
FILE_SYSTEM_ALIAS_DISASSOCIATION
- A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.
IOPS_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the ProgressPercent
property. When IOPS_OPTIMIZATION
has been completed successfully, the parent FILE_SYSTEM_UPDATE
action status changes to COMPLETED
. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.
STORAGE_TYPE_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the ProgressPercent
property. When STORAGE_TYPE_OPTIMIZATION
has been completed successfully, the parent FILE_SYSTEM_UPDATE
action status changes to COMPLETED
.
VOLUME_UPDATE
- A volume update to an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume
), or CLI (update-volume
).
VOLUME_RESTORE
- An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot
) or CLI (restore-volume-from-snapshot
).
SNAPSHOT_UPDATE
- A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot
), or CLI (update-snapshot
).
RELEASE_NFS_V3_LOCKS
- Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE
- A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem
), or CLI (update-file-system
).
THROUGHPUT_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the ProgressPercent
property. When THROUGHPUT_OPTIMIZATION
has been completed successfully, the parent FILE_SYSTEM_UPDATE
action status changes to COMPLETED
. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.
STORAGE_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
task to increase a file system's storage capacity has been completed successfully, a STORAGE_OPTIMIZATION
task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage-optimization progress using the ProgressPercent
property. When STORAGE_OPTIMIZATION
has been completed successfully, the parent FILE_SYSTEM_UPDATE
action status changes to COMPLETED
. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
FILE_SYSTEM_ALIAS_ASSOCIATION
- A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.
FILE_SYSTEM_ALIAS_DISASSOCIATION
- A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.
IOPS_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the ProgressPercent
property. When IOPS_OPTIMIZATION
has been completed successfully, the parent FILE_SYSTEM_UPDATE
action status changes to COMPLETED
. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.
STORAGE_TYPE_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the ProgressPercent
property. When STORAGE_TYPE_OPTIMIZATION
has been completed successfully, the parent FILE_SYSTEM_UPDATE
action status changes to COMPLETED
.
VOLUME_UPDATE
- A volume update to an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume
), or CLI (update-volume
).
VOLUME_RESTORE
- An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot
) or CLI (restore-volume-from-snapshot
).
SNAPSHOT_UPDATE
- A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot
), or CLI (update-snapshot
).
RELEASE_NFS_V3_LOCKS
- Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
The Lustre root squash configuration used when updating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
" + }, + "PerUnitStorageThroughput": { + "shape": "PerUnitStorageThroughput", + "documentation": "The throughput of an Amazon FSx for Lustre Persistent SSD-based file system, measured in megabytes per second per tebibyte (MB/s/TiB). You can increase or decrease your file system's throughput. Valid values depend on the deployment type of the file system, as follows:
For PERSISTENT_1
SSD-based deployment types, valid values are 50, 100, and 200 MB/s/TiB.
For PERSISTENT_2
SSD-based deployment types, valid values are 125, 250, 500, and 1000 MB/s/TiB.
For more information, see Managing throughput capacity.
" } }, "documentation": "The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem
operation.
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
For MULTI_AZ_1
and SINGLE_AZ_2
, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
For SINGLE_AZ_1
, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
For MULTI_AZ_1
and SINGLE_AZ_2
, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.
For SINGLE_AZ_1
, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is GetTable
.
Get the associated metadata/information for a task run, given a task run ID.
" + }, + "GetColumnStatisticsTaskRuns": { + "name": "GetColumnStatisticsTaskRuns", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetColumnStatisticsTaskRunsRequest" + }, + "output": { + "shape": "GetColumnStatisticsTaskRunsResponse" + }, + "errors": [ + { + "shape": "OperationTimeoutException" + } + ], + "documentation": "Retrieves information about all runs associated with the specified table.
" + }, "GetConnection": { "name": "GetConnection", "http": { @@ -4087,6 +4131,25 @@ ], "documentation": "Lists all the blueprint names in an account.
" }, + "ListColumnStatisticsTaskRuns": { + "name": "ListColumnStatisticsTaskRuns", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListColumnStatisticsTaskRunsRequest" + }, + "output": { + "shape": "ListColumnStatisticsTaskRunsResponse" + }, + "errors": [ + { + "shape": "OperationTimeoutException" + } + ], + "documentation": "List all task runs for a particular account.
" + }, "ListCrawlers": { "name": "ListCrawlers", "http": { @@ -4936,6 +4999,40 @@ ], "documentation": "Starts a new run of the specified blueprint.
" }, + "StartColumnStatisticsTaskRun": { + "name": "StartColumnStatisticsTaskRun", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "StartColumnStatisticsTaskRunRequest" + }, + "output": { + "shape": "StartColumnStatisticsTaskRunResponse" + }, + "errors": [ + { + "shape": "AccessDeniedException" + }, + { + "shape": "EntityNotFoundException" + }, + { + "shape": "ColumnStatisticsTaskRunningException" + }, + { + "shape": "OperationTimeoutException" + }, + { + "shape": "ResourceNumberLimitExceededException" + }, + { + "shape": "InvalidInputException" + } + ], + "documentation": "Starts a column statistics task run, for a specified table and columns.
" + }, "StartCrawler": { "name": "StartCrawler", "http": { @@ -5279,6 +5376,34 @@ ], "documentation": "Starts a new run of the specified workflow.
" }, + "StopColumnStatisticsTaskRun": { + "name": "StopColumnStatisticsTaskRun", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "StopColumnStatisticsTaskRunRequest" + }, + "output": { + "shape": "StopColumnStatisticsTaskRunResponse" + }, + "errors": [ + { + "shape": "EntityNotFoundException" + }, + { + "shape": "ColumnStatisticsTaskNotRunningException" + }, + { + "shape": "ColumnStatisticsTaskStoppingException" + }, + { + "shape": "OperationTimeoutException" + } + ], + "documentation": "Stops a task run for the specified table.
" + }, "StopCrawler": { "name": "StopCrawler", "http": { @@ -8595,6 +8720,12 @@ "shape": "Column" } }, + "ColumnNameList": { + "type": "list", + "member": { + "shape": "NameString" + } + }, "ColumnNameString": { "type": "string", "max": 1024, @@ -8716,6 +8847,108 @@ "shape": "ColumnStatistics" } }, + "ColumnStatisticsState": { + "type": "string", + "enum": [ + "STARTING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "STOPPED" + ] + }, + "ColumnStatisticsTaskRun": { + "type": "structure", + "members": { + "CustomerId": { + "shape": "AccountId", + "documentation": "The Amazon Web Services account ID.
" + }, + "ColumnStatisticsTaskRunId": { + "shape": "HashString", + "documentation": "The identifier for the particular column statistics task run.
" + }, + "DatabaseName": { + "shape": "DatabaseName", + "documentation": "The database where the table resides.
" + }, + "TableName": { + "shape": "TableName", + "documentation": "The name of the table for which column statistics is generated.
" + }, + "ColumnNameList": { + "shape": "ColumnNameList", + "documentation": "A list of the column names. If none is supplied, all column names for the table will be used by default.
" + }, + "CatalogID": { + "shape": "CatalogIdString", + "documentation": "The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
" + }, + "Role": { + "shape": "Role", + "documentation": "The IAM role that the service assumes to generate statistics.
" + }, + "SampleSize": { + "shape": "SampleSizePercentage", + "documentation": "The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
" + }, + "SecurityConfiguration": { + "shape": "CrawlerSecurityConfiguration", + "documentation": "Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
" + }, + "NumberOfWorkers": { + "shape": "PositiveInteger", + "documentation": "The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
" + }, + "WorkerType": { + "shape": "NameString", + "documentation": "The type of workers being used for generating stats. The default is g.1x
.
The status of the task run.
" + }, + "CreationTime": { + "shape": "Timestamp", + "documentation": "The time that this task was created.
" + }, + "LastUpdated": { + "shape": "Timestamp", + "documentation": "The last point in time when this task was modified.
" + }, + "StartTime": { + "shape": "Timestamp", + "documentation": "The start time of the task.
" + }, + "EndTime": { + "shape": "Timestamp", + "documentation": "The end time of the task.
" + }, + "ErrorMessage": { + "shape": "DescriptionString", + "documentation": "The error message for the job.
" + }, + "DPUSeconds": { + "shape": "NonNegativeDouble", + "documentation": "The calculated DPU usage in seconds for all autoscaled workers.
" + } + }, + "documentation": "The object that shows the details of the column stats run.
" + }, + "ColumnStatisticsTaskRunIdList": { + "type": "list", + "member": { + "shape": "HashString" + }, + "max": 100, + "min": 0 + }, + "ColumnStatisticsTaskRunsList": { + "type": "list", + "member": { + "shape": "ColumnStatisticsTaskRun" + } + }, "ColumnStatisticsType": { "type": "string", "enum": [ @@ -13556,6 +13789,65 @@ } } }, + "GetColumnStatisticsTaskRunRequest": { + "type": "structure", + "required": [ + "ColumnStatisticsTaskRunId" + ], + "members": { + "ColumnStatisticsTaskRunId": { + "shape": "HashString", + "documentation": "The identifier for the particular column statistics task run.
" + } + } + }, + "GetColumnStatisticsTaskRunResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRun": { + "shape": "ColumnStatisticsTaskRun", + "documentation": "A ColumnStatisticsTaskRun
object representing the details of the column stats run.
The name of the database where the table resides.
" + }, + "TableName": { + "shape": "NameString", + "documentation": "The name of the table.
" + }, + "MaxResults": { + "shape": "PageSize", + "documentation": "The maximum size of the response.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "A continuation token, if this is a continuation call.
" + } + } + }, + "GetColumnStatisticsTaskRunsResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRuns": { + "shape": "ColumnStatisticsTaskRunsList", + "documentation": "A list of column statistics task runs.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "A continuation token, if not all task runs have yet been returned.
" + } + } + }, "GetConnectionRequest": { "type": "structure", "required": [ @@ -17282,6 +17574,32 @@ } } }, + "ListColumnStatisticsTaskRunsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "PageSize", + "documentation": "The maximum size of the response.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "A continuation token, if this is a continuation call.
" + } + } + }, + "ListColumnStatisticsTaskRunsResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRunIds": { + "shape": "ColumnStatisticsTaskRunIdList", + "documentation": "A list of column statistics task run IDs.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "A continuation token, if not all task run IDs have yet been returned.
" + } + } + }, "ListCrawlersRequest": { "type": "structure", "members": { @@ -19142,6 +19460,10 @@ "box": true, "min": 10 }, + "PositiveInteger": { + "type": "integer", + "min": 1 + }, "PositiveLong": { "type": "long", "box": true, @@ -20772,6 +21094,11 @@ "shape": "S3Target" } }, + "SampleSizePercentage": { + "type": "double", + "max": 100, + "min": 0 + }, "ScalaCode": { "type": "string" }, @@ -21793,6 +22120,53 @@ } } }, + "StartColumnStatisticsTaskRunRequest": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName", + "Role" + ], + "members": { + "DatabaseName": { + "shape": "NameString", + "documentation": "The name of the database where the table resides.
" + }, + "TableName": { + "shape": "NameString", + "documentation": "The name of the table to generate statistics.
" + }, + "ColumnNameList": { + "shape": "ColumnNameList", + "documentation": "A list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
" + }, + "Role": { + "shape": "NameString", + "documentation": "The IAM role that the service assumes to generate statistics.
" + }, + "SampleSize": { + "shape": "SampleSizePercentage", + "documentation": "The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
" + }, + "CatalogID": { + "shape": "NameString", + "documentation": "The ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
" + }, + "SecurityConfiguration": { + "shape": "NameString", + "documentation": "Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
" + } + } + }, + "StartColumnStatisticsTaskRunResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRunId": { + "shape": "HashString", + "documentation": "The identifier for the column statistics task run.
" + } + } + }, "StartCrawlerRequest": { "type": "structure", "required": [ @@ -22244,6 +22618,27 @@ "ERROR" ] }, + "StopColumnStatisticsTaskRunRequest": { + "type": "structure", + "required": [ + "DatabaseName", + "TableName" + ], + "members": { + "DatabaseName": { + "shape": "DatabaseName", + "documentation": "The name of the database where the table resides.
" + }, + "TableName": { + "shape": "NameString", + "documentation": "The name of the table.
" + } + } + }, + "StopColumnStatisticsTaskRunResponse": { + "type": "structure", + "members": {} + }, "StopCrawlerRequest": { "type": "structure", "required": [ diff --git a/apis/glue-2017-03-31.paginators.json b/apis/glue-2017-03-31.paginators.json index a1dfea9c20..7b7558dae2 100644 --- a/apis/glue-2017-03-31.paginators.json +++ b/apis/glue-2017-03-31.paginators.json @@ -10,6 +10,11 @@ "limit_key": "MaxResults", "output_token": "NextToken" }, + "GetColumnStatisticsTaskRuns": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, "GetConnections": { "input_token": "NextToken", "limit_key": "MaxResults", @@ -112,6 +117,11 @@ "limit_key": "MaxResults", "output_token": "NextToken" }, + "ListColumnStatisticsTaskRuns": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, "ListCrawlers": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/apis/imagebuilder-2019-12-02.min.json b/apis/imagebuilder-2019-12-02.min.json index 18100cc485..d3f8421f1e 100644 --- a/apis/imagebuilder-2019-12-02.min.json +++ b/apis/imagebuilder-2019-12-02.min.json @@ -40,6 +40,31 @@ } } }, + "CancelLifecycleExecution": { + "http": { + "method": "PUT", + "requestUri": "/CancelLifecycleExecution" + }, + "input": { + "type": "structure", + "required": [ + "lifecycleExecutionId", + "clientToken" + ], + "members": { + "lifecycleExecutionId": {}, + "clientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "lifecycleExecutionId": {} + } + } + }, "CreateComponent": { "http": { "method": "PUT", @@ -60,13 +85,13 @@ "changeDescription": {}, "platform": {}, "supportedOsVersions": { - "shape": "Sa" + "shape": "Sd" }, "data": {}, "uri": {}, "kmsKeyId": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "clientToken": { "idempotencyToken": true @@ -104,10 +129,10 @@ "description": {}, "semanticVersion": {}, "components": { - "shape": "Sl" + "shape": "So" }, "instanceConfiguration": { - "shape": "St" + "shape": "Sw" }, "dockerfileTemplateData": {}, "dockerfileTemplateUri": {}, @@ -115,11 +140,11 @@ "imageOsVersionOverride": {}, "parentImage": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "workingDirectory": {}, "targetRepository": { - "shape": "S14" + "shape": "S17" }, "kmsKeyId": {}, "clientToken": { @@ -152,10 +177,10 @@ "name": {}, "description": {}, "distributions": { - "shape": "S19" + "shape": "S1c" }, "tags": { - "shape": "Se" + "shape": "Sh" }, "clientToken": { "idempotencyToken": true @@ -188,19 +213,19 @@ "distributionConfigurationArn": {}, "infrastructureConfigurationArn": {}, "imageTestsConfiguration": { - "shape": "S25" + "shape": "S28" }, "enhancedImageMetadataEnabled": { "type": "boolean" }, "tags": { - "shape": "Se" + "shape": "Sh" }, "clientToken": { "idempotencyToken": true }, "imageScanningConfiguration": { - "shape": "S27" + "shape": "S2a" } } }, @@ -233,23 +258,23 @@ "infrastructureConfigurationArn": {}, "distributionConfigurationArn": {}, "imageTestsConfiguration": { - "shape": "S25" + "shape": "S28" }, "enhancedImageMetadataEnabled": { "type": "boolean" }, "schedule": { - "shape": "S2b" + "shape": "S2e" }, "status": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "clientToken": { "idempotencyToken": true }, "imageScanningConfiguration": { - "shape": "S27" + "shape": "S2a" } } }, @@ -281,18 +306,18 @@ "description": {}, "semanticVersion": {}, "components": { - "shape": "Sl" + "shape": "So" }, "parentImage": {}, "blockDeviceMappings": { - "shape": "Su" + "shape": "Sx" }, "tags": { - "shape": "Se" + "shape": "Sh" }, "workingDirectory": {}, "additionalInstanceConfiguration": { - "shape": "S2i" + "shape": "S2l" }, "clientToken": { "idempotencyToken": true @@ -324,15 +349,15 @@ "name": {}, "description": {}, "instanceTypes": { - "shape": "S2n" + "shape": "S2q" }, "instanceProfileName": {}, "securityGroupIds": { - "shape": "S2q" + "shape": "S2t" }, "subnetId": {}, "logging": { - "shape": "S2r" + "shape": "S2u" }, "keyPair": {}, "terminateInstanceOnFailure": { @@ -340,13 +365,13 @@ }, "snsTopicArn": {}, "resourceTags": { - "shape": "S2u" + "shape": "S2x" }, "instanceMetadataOptions": { - "shape": "S2v" + "shape": "S2y" }, "tags": { - "shape": "Se" + "shape": "Sh" }, "clientToken": { "idempotencyToken": true @@ -362,6 +387,49 @@ } } }, + "CreateLifecyclePolicy": { + "http": { + "method": "PUT", + "requestUri": "/CreateLifecyclePolicy" + }, + "input": { + "type": "structure", + "required": [ + "name", + "executionRole", + "resourceType", + "policyDetails", + "resourceSelection", + "clientToken" + ], + "members": { + "name": {}, + "description": {}, + "status": {}, + "executionRole": {}, + "resourceType": {}, + "policyDetails": { + "shape": "S36" + }, + "resourceSelection": { + "shape": "S3k" + }, + "tags": { + "shape": "Sh" + }, + "clientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "clientToken": {}, + "lifecyclePolicyArn": {} + } + } + }, "DeleteComponent": { "http": { "method": "DELETE", @@ -537,6 +605,30 @@ } } }, + "DeleteLifecyclePolicy": { + "http": { + "method": "DELETE", + "requestUri": "/DeleteLifecyclePolicy" + }, + "input": { + "type": "structure", + "required": [ + "lifecyclePolicyArn" + ], + "members": { + "lifecyclePolicyArn": { + "location": "querystring", + "locationName": "lifecyclePolicyArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "lifecyclePolicyArn": {} + } + } + }, "GetComponent": { "http": { "method": "GET", @@ -569,10 +661,10 @@ "type": {}, "platform": {}, "supportedOsVersions": { - "shape": "Sa" + "shape": "Sd" }, "state": { - "shape": "S3i" + "shape": "S4a" }, "parameters": { "type": "list", @@ -586,7 +678,7 @@ "name": {}, "type": {}, "defaultValue": { - "shape": "Sr" + "shape": "Su" }, "description": {} } @@ -600,7 +692,7 @@ }, "dateCreated": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "publisher": {}, "obfuscate": { @@ -658,7 +750,7 @@ "members": { "requestId": {}, "containerRecipe": { - "shape": "S3v" + "shape": "S4n" } } } @@ -710,7 +802,7 @@ "members": { "requestId": {}, "distributionConfiguration": { - "shape": "S41" + "shape": "S4t" } } } @@ -749,31 +841,31 @@ }, "osVersion": {}, "state": { - "shape": "S48" + "shape": "S50" }, "imageRecipe": { - "shape": "S4a" + "shape": "S52" }, "containerRecipe": { - "shape": "S3v" + "shape": "S4n" }, "sourcePipelineName": {}, "sourcePipelineArn": {}, "infrastructureConfiguration": { - "shape": "S4c" + "shape": "S54" }, "distributionConfiguration": { - "shape": "S41" + "shape": "S4t" }, "imageTestsConfiguration": { - "shape": "S25" + "shape": "S28" }, "dateCreated": {}, "outputResources": { - "shape": "S4d" + "shape": "S55" }, "tags": { - "shape": "Se" + "shape": "Sh" }, "buildType": {}, "imageSource": {}, @@ -785,8 +877,12 @@ } }, "imageScanningConfiguration": { - "shape": "S27" - } + "shape": "S2a" + }, + "deprecationTime": { + "type": "timestamp" + }, + "lifecycleExecutionId": {} } } } @@ -814,7 +910,7 @@ "members": { "requestId": {}, "imagePipeline": { - "shape": "S4o" + "shape": "S5h" } } } @@ -866,7 +962,7 @@ "members": { "requestId": {}, "imageRecipe": { - "shape": "S4a" + "shape": "S52" } } } @@ -918,7 +1014,85 @@ "members": { "requestId": {}, "infrastructureConfiguration": { - "shape": "S4c" + "shape": "S54" + } + } + } + }, + "GetLifecycleExecution": { + "http": { + "method": "GET", + "requestUri": "/GetLifecycleExecution" + }, + "input": { + "type": "structure", + "required": [ + "lifecycleExecutionId" + ], + "members": { + "lifecycleExecutionId": { + "location": "querystring", + "locationName": "lifecycleExecutionId" + } + } + }, + "output": { + "type": "structure", + "members": { + "lifecycleExecution": { + "shape": "S5s" + } + } + } + }, + "GetLifecyclePolicy": { + "http": { + "method": "GET", + "requestUri": "/GetLifecyclePolicy" + }, + "input": { + "type": "structure", + "required": [ + "lifecyclePolicyArn" + ], + "members": { + "lifecyclePolicyArn": { + "location": "querystring", + "locationName": "lifecyclePolicyArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "lifecyclePolicy": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "description": {}, + "status": {}, + "executionRole": {}, + "resourceType": {}, + "policyDetails": { + "shape": "S36" + }, + "resourceSelection": { + "shape": "S3k" + }, + "dateCreated": { + "type": "timestamp" + }, + "dateUpdated": { + "type": "timestamp" + }, + "dateLastRun": { + "type": "timestamp" + }, + "tags": { + "shape": "Sh" + } + } } } } @@ -1036,7 +1210,7 @@ "uri": {}, "kmsKeyId": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "clientToken": { "idempotencyToken": true @@ -1074,7 +1248,7 @@ "osVersion": {}, "vmImportTaskId": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "clientToken": { "idempotencyToken": true @@ -1121,10 +1295,10 @@ "version": {}, "platform": {}, "supportedOsVersions": { - "shape": "Sa" + "shape": "Sd" }, "state": { - "shape": "S3i" + "shape": "S4a" }, "type": {}, "owner": {}, @@ -1132,7 +1306,7 @@ "changeDescription": {}, "dateCreated": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "publisher": {}, "obfuscate": { @@ -1154,7 +1328,7 @@ "members": { "owner": {}, "filters": { - "shape": "S5v" + "shape": "S6x" }, "byName": { "type": "boolean" @@ -1180,7 +1354,7 @@ "description": {}, "platform": {}, "supportedOsVersions": { - "shape": "Sa" + "shape": "Sd" }, "type": {}, "owner": {}, @@ -1201,7 +1375,7 @@ "members": { "owner": {}, "filters": { - "shape": "S5v" + "shape": "S6x" }, "maxResults": { "type": "integer" @@ -1226,7 +1400,7 @@ "parentImage": {}, "dateCreated": {}, "tags": { - "shape": "Se" + "shape": "Sh" } } } @@ -1243,7 +1417,7 @@ "type": "structure", "members": { "filters": { - "shape": "S5v" + "shape": "S6x" }, "maxResults": { "type": "integer" @@ -1266,7 +1440,7 @@ "dateCreated": {}, "dateUpdated": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "regions": { "type": "list", @@ -1291,7 +1465,7 @@ "members": { "imageVersionArn": {}, "filters": { - "shape": "S5v" + "shape": "S6x" }, "maxResults": { "type": "integer" @@ -1304,7 +1478,7 @@ "members": { "requestId": {}, "imageSummaryList": { - "shape": "S6f" + "shape": "S7h" }, "nextToken": {} } @@ -1357,7 +1531,7 @@ "members": { "imagePipelineArn": {}, "filters": { - "shape": "S5v" + "shape": "S6x" }, "maxResults": { "type": "integer" @@ -1370,7 +1544,7 @@ "members": { "requestId": {}, "imageSummaryList": { - "shape": "S6f" + "shape": "S7h" }, "nextToken": {} } @@ -1384,7 +1558,7 @@ "type": "structure", "members": { "filters": { - "shape": "S5v" + "shape": "S6x" }, "maxResults": { "type": "integer" @@ -1399,7 +1573,7 @@ "imagePipelineList": { "type": "list", "member": { - "shape": "S4o" + "shape": "S5h" } }, "nextToken": {} @@ -1415,7 +1589,7 @@ "members": { "owner": {}, "filters": { - "shape": "S5v" + "shape": "S6x" }, "maxResults": { "type": "integer" @@ -1439,7 +1613,7 @@ "parentImage": {}, "dateCreated": {}, "tags": { - "shape": "Se" + "shape": "Sh" } } } @@ -1456,7 +1630,7 @@ "type": "structure", "members": { "filter": { - "shape": "S5w" + "shape": "S6y" }, "nextToken": {} } @@ -1476,7 +1650,7 @@ "members": { "accountId": {}, "severityCounts": { - "shape": "S6z" + "shape": "S81" } } }, @@ -1485,7 +1659,7 @@ "members": { "imageBuildVersionArn": {}, "severityCounts": { - "shape": "S6z" + "shape": "S81" } } }, @@ -1494,7 +1668,7 @@ "members": { "imagePipelineArn": {}, "severityCounts": { - "shape": "S6z" + "shape": "S81" } } }, @@ -1503,7 +1677,7 @@ "members": { "vulnerabilityId": {}, "severityCounts": { - "shape": "S6z" + "shape": "S81" } } } @@ -1681,7 +1855,7 @@ "members": { "owner": {}, "filters": { - "shape": "S5v" + "shape": "S6x" }, "byName": { "type": "boolean" @@ -1729,7 +1903,7 @@ "type": "structure", "members": { "filters": { - "shape": "S5v" + "shape": "S6x" }, "maxResults": { "type": "integer" @@ -1752,13 +1926,13 @@ "dateCreated": {}, "dateUpdated": {}, "resourceTags": { - "shape": "S2u" + "shape": "S2x" }, "tags": { - "shape": "Se" + "shape": "Sh" }, "instanceTypes": { - "shape": "S2n" + "shape": "S2q" }, "instanceProfileName": {} } @@ -1768,6 +1942,150 @@ } } }, + "ListLifecycleExecutionResources": { + "http": { + "requestUri": "/ListLifecycleExecutionResources" + }, + "input": { + "type": "structure", + "required": [ + "lifecycleExecutionId" + ], + "members": { + "lifecycleExecutionId": {}, + "parentResourceId": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "lifecycleExecutionId": {}, + "lifecycleExecutionState": { + "shape": "S5u" + }, + "resources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "accountId": {}, + "resourceId": {}, + "state": { + "shape": "S97" + }, + "action": { + "type": "structure", + "members": { + "name": {}, + "reason": {} + } + }, + "region": {}, + "snapshots": { + "type": "list", + "member": { + "type": "structure", + "members": { + "snapshotId": {}, + "state": { + "shape": "S97" + } + } + } + }, + "imageUris": { + "shape": "S1j" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListLifecycleExecutions": { + "http": { + "requestUri": "/ListLifecycleExecutions" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "maxResults": { + "type": "integer" + }, + "nextToken": {}, + "resourceArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "lifecycleExecutions": { + "type": "list", + "member": { + "shape": "S5s" + } + }, + "nextToken": {} + } + } + }, + "ListLifecyclePolicies": { + "http": { + "requestUri": "/ListLifecyclePolicies" + }, + "input": { + "type": "structure", + "members": { + "filters": { + "shape": "S6x" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "members": { + "lifecyclePolicySummaryList": { + "type": "list", + "member": { + "type": "structure", + "members": { + "arn": {}, + "name": {}, + "description": {}, + "status": {}, + "executionRole": {}, + "resourceType": {}, + "dateCreated": { + "type": "timestamp" + }, + "dateUpdated": { + "type": "timestamp" + }, + "dateLastRun": { + "type": "timestamp" + }, + "tags": { + "shape": "Sh" + } + } + } + }, + "nextToken": {} + } + } + }, "ListTagsForResource": { "http": { "method": "GET", @@ -1789,7 +2107,7 @@ "type": "structure", "members": { "tags": { - "shape": "Se" + "shape": "Sh" } } } @@ -2019,6 +2337,65 @@ } } }, + "StartResourceStateUpdate": { + "http": { + "method": "PUT", + "requestUri": "/StartResourceStateUpdate" + }, + "input": { + "type": "structure", + "required": [ + "resourceArn", + "state", + "clientToken" + ], + "members": { + "resourceArn": {}, + "state": { + "type": "structure", + "members": { + "status": {} + } + }, + "executionRole": {}, + "includeResources": { + "type": "structure", + "members": { + "amis": { + "type": "boolean" + }, + "snapshots": { + "type": "boolean" + }, + "containers": { + "type": "boolean" + } + } + }, + "exclusionRules": { + "type": "structure", + "members": { + "amis": { + "shape": "S3h" + } + } + }, + "updateAt": { + "type": "timestamp" + }, + "clientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "lifecycleExecutionId": {}, + "resourceArn": {} + } + } + }, "TagResource": { "http": { "requestUri": "/tags/{resourceArn}" @@ -2035,7 +2412,7 @@ "locationName": "resourceArn" }, "tags": { - "shape": "Se" + "shape": "Sh" } } }, @@ -2089,7 +2466,7 @@ "distributionConfigurationArn": {}, "description": {}, "distributions": { - "shape": "S19" + "shape": "S1c" }, "clientToken": { "idempotencyToken": true @@ -2125,20 +2502,20 @@ "infrastructureConfigurationArn": {}, "distributionConfigurationArn": {}, "imageTestsConfiguration": { - "shape": "S25" + "shape": "S28" }, "enhancedImageMetadataEnabled": { "type": "boolean" }, "schedule": { - "shape": "S2b" + "shape": "S2e" }, "status": {}, "clientToken": { "idempotencyToken": true }, "imageScanningConfiguration": { - "shape": "S27" + "shape": "S2a" } } }, @@ -2167,15 +2544,15 @@ "infrastructureConfigurationArn": {}, "description": {}, "instanceTypes": { - "shape": "S2n" + "shape": "S2q" }, "instanceProfileName": {}, "securityGroupIds": { - "shape": "S2q" + "shape": "S2t" }, "subnetId": {}, "logging": { - "shape": "S2r" + "shape": "S2u" }, "keyPair": {}, "terminateInstanceOnFailure": { @@ -2186,10 +2563,10 @@ "idempotencyToken": true }, "resourceTags": { - "shape": "S2u" + "shape": "S2x" }, "instanceMetadataOptions": { - "shape": "S2v" + "shape": "S2y" } } }, @@ -2201,19 +2578,58 @@ "infrastructureConfigurationArn": {} } } + }, + "UpdateLifecyclePolicy": { + "http": { + "method": "PUT", + "requestUri": "/UpdateLifecyclePolicy" + }, + "input": { + "type": "structure", + "required": [ + "lifecyclePolicyArn", + "executionRole", + "resourceType", + "policyDetails", + "resourceSelection", + "clientToken" + ], + "members": { + "lifecyclePolicyArn": {}, + "description": {}, + "status": {}, + "executionRole": {}, + "resourceType": {}, + "policyDetails": { + "shape": "S36" + }, + "resourceSelection": { + "shape": "S3k" + }, + "clientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "lifecyclePolicyArn": {} + } + } } }, "shapes": { - "Sa": { + "Sd": { "type": "list", "member": {} }, - "Se": { + "Sh": { "type": "map", "key": {}, "value": {} }, - "Sl": { + "So": { "type": "list", "member": { "type": "structure", @@ -2233,7 +2649,7 @@ "members": { "name": {}, "value": { - "shape": "Sr" + "shape": "Su" } } } @@ -2241,20 +2657,20 @@ } } }, - "Sr": { + "Su": { "type": "list", "member": {} }, - "St": { + "Sw": { "type": "structure", "members": { "image": {}, "blockDeviceMappings": { - "shape": "Su" + "shape": "Sx" } } }, - "Su": { + "Sx": { "type": "list", "member": { "type": "structure", @@ -2288,7 +2704,7 @@ } } }, - "S14": { + "S17": { "type": "structure", "required": [ "service", @@ -2299,7 +2715,7 @@ "repositoryName": {} } }, - "S19": { + "S1c": { "type": "list", "member": { "type": "structure", @@ -2314,20 +2730,20 @@ "name": {}, "description": {}, "targetAccountIds": { - "shape": "S1d" + "shape": "S1g" }, "amiTags": { - "shape": "Se" + "shape": "Sh" }, "kmsKeyId": {}, "launchPermission": { "type": "structure", "members": { "userIds": { - "shape": "S1d" + "shape": "S1g" }, "userGroups": { - "shape": "S1g" + "shape": "S1j" }, "organizationArns": { "type": "list", @@ -2349,10 +2765,10 @@ "members": { "description": {}, "containerTags": { - "shape": "S1g" + "shape": "S1j" }, "targetRepository": { - "shape": "S14" + "shape": "S17" } } }, @@ -2427,15 +2843,15 @@ } } }, - "S1d": { + "S1g": { "type": "list", "member": {} }, - "S1g": { + "S1j": { "type": "list", "member": {} }, - "S25": { + "S28": { "type": "structure", "members": { "imageTestsEnabled": { @@ -2446,7 +2862,7 @@ } } }, - "S27": { + "S2a": { "type": "structure", "members": { "imageScanningEnabled": { @@ -2457,13 +2873,13 @@ "members": { "repositoryName": {}, "containerTags": { - "shape": "S1g" + "shape": "S1j" } } } } }, - "S2b": { + "S2e": { "type": "structure", "members": { "scheduleExpression": {}, @@ -2471,7 +2887,7 @@ "pipelineExecutionStartCondition": {} } }, - "S2i": { + "S2l": { "type": "structure", "members": { "systemsManagerAgent": { @@ -2485,15 +2901,15 @@ "userDataOverride": {} } }, - "S2n": { + "S2q": { "type": "list", "member": {} }, - "S2q": { + "S2t": { "type": "list", "member": {} }, - "S2r": { + "S2u": { "type": "structure", "members": { "s3Logs": { @@ -2505,12 +2921,12 @@ } } }, - "S2u": { + "S2x": { "type": "map", "key": {}, "value": {} }, - "S2v": { + "S2y": { "type": "structure", "members": { "httpTokens": {}, @@ -2519,14 +2935,129 @@ } } }, - "S3i": { + "S36": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "action", + "filter" + ], + "members": { + "action": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": {}, + "includeResources": { + "type": "structure", + "members": { + "amis": { + "type": "boolean" + }, + "snapshots": { + "type": "boolean" + }, + "containers": { + "type": "boolean" + } + } + } + } + }, + "filter": { + "type": "structure", + "required": [ + "type", + "value" + ], + "members": { + "type": {}, + "value": { + "type": "integer" + }, + "unit": {}, + "retainAtLeast": { + "type": "integer" + } + } + }, + "exclusionRules": { + "type": "structure", + "members": { + "tagMap": { + "shape": "Sh" + }, + "amis": { + "shape": "S3h" + } + } + } + } + } + }, + "S3h": { + "type": "structure", + "members": { + "isPublic": { + "type": "boolean" + }, + "regions": { + "shape": "S1j" + }, + "sharedAccounts": { + "shape": "S1g" + }, + "lastLaunched": { + "type": "structure", + "required": [ + "value", + "unit" + ], + "members": { + "value": { + "type": "integer" + }, + "unit": {} + } + }, + "tagMap": { + "shape": "Sh" + } + } + }, + "S3k": { + "type": "structure", + "members": { + "recipes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name", + "semanticVersion" + ], + "members": { + "name": {}, + "semanticVersion": {} + } + } + }, + "tagMap": { + "shape": "Sh" + } + } + }, + "S4a": { "type": "structure", "members": { "status": {}, "reason": {} } }, - "S3v": { + "S4n": { "type": "structure", "members": { "arn": {}, @@ -2537,10 +3068,10 @@ "owner": {}, "version": {}, "components": { - "shape": "Sl" + "shape": "So" }, "instanceConfiguration": { - "shape": "St" + "shape": "Sw" }, "dockerfileTemplateData": {}, "kmsKeyId": {}, @@ -2550,15 +3081,15 @@ "parentImage": {}, "dateCreated": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "workingDirectory": {}, "targetRepository": { - "shape": "S14" + "shape": "S17" } } }, - "S41": { + "S4t": { "type": "structure", "required": [ "timeoutMinutes" @@ -2568,7 +3099,7 @@ "name": {}, "description": {}, "distributions": { - "shape": "S19" + "shape": "S1c" }, "timeoutMinutes": { "type": "integer" @@ -2576,18 +3107,18 @@ "dateCreated": {}, "dateUpdated": {}, "tags": { - "shape": "Se" + "shape": "Sh" } } }, - "S48": { + "S50": { "type": "structure", "members": { "status": {}, "reason": {} } }, - "S4a": { + "S52": { "type": "structure", "members": { "arn": {}, @@ -2598,38 +3129,38 @@ "owner": {}, "version": {}, "components": { - "shape": "Sl" + "shape": "So" }, "parentImage": {}, "blockDeviceMappings": { - "shape": "Su" + "shape": "Sx" }, "dateCreated": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "workingDirectory": {}, "additionalInstanceConfiguration": { - "shape": "S2i" + "shape": "S2l" } } }, - "S4c": { + "S54": { "type": "structure", "members": { "arn": {}, "name": {}, "description": {}, "instanceTypes": { - "shape": "S2n" + "shape": "S2q" }, "instanceProfileName": {}, "securityGroupIds": { - "shape": "S2q" + "shape": "S2t" }, "subnetId": {}, "logging": { - "shape": "S2r" + "shape": "S2u" }, "keyPair": {}, "terminateInstanceOnFailure": { @@ -2639,17 +3170,17 @@ "dateCreated": {}, "dateUpdated": {}, "resourceTags": { - "shape": "S2u" + "shape": "S2x" }, "instanceMetadataOptions": { - "shape": "S2v" + "shape": "S2y" }, "tags": { - "shape": "Se" + "shape": "Sh" } } }, - "S4d": { + "S55": { "type": "structure", "members": { "amis": { @@ -2662,7 +3193,7 @@ "name": {}, "description": {}, "state": { - "shape": "S48" + "shape": "S50" }, "accountId": {} } @@ -2675,14 +3206,14 @@ "members": { "region": {}, "imageUris": { - "shape": "S1g" + "shape": "S1j" } } } } } }, - "S4o": { + "S5h": { "type": "structure", "members": { "arn": {}, @@ -2697,10 +3228,10 @@ "infrastructureConfigurationArn": {}, "distributionConfigurationArn": {}, "imageTestsConfiguration": { - "shape": "S25" + "shape": "S28" }, "schedule": { - "shape": "S2b" + "shape": "S2e" }, "status": {}, "dateCreated": {}, @@ -2708,20 +3239,51 @@ "dateLastRun": {}, "dateNextRun": {}, "tags": { - "shape": "Se" + "shape": "Sh" }, "imageScanningConfiguration": { - "shape": "S27" + "shape": "S2a" } } }, - "S5v": { + "S5s": { + "type": "structure", + "members": { + "lifecycleExecutionId": {}, + "lifecyclePolicyArn": {}, + "resourcesImpactedSummary": { + "type": "structure", + "members": { + "hasImpactedResources": { + "type": "boolean" + } + } + }, + "state": { + "shape": "S5u" + }, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + } + } + }, + "S5u": { + "type": "structure", + "members": { + "status": {}, + "reason": {} + } + }, + "S6x": { "type": "list", "member": { - "shape": "S5w" + "shape": "S6y" } }, - "S5w": { + "S6y": { "type": "structure", "members": { "name": {}, @@ -2731,7 +3293,7 @@ } } }, - "S6f": { + "S7h": { "type": "list", "member": { "type": "structure", @@ -2743,22 +3305,26 @@ "platform": {}, "osVersion": {}, "state": { - "shape": "S48" + "shape": "S50" }, "owner": {}, "dateCreated": {}, "outputResources": { - "shape": "S4d" + "shape": "S55" }, "tags": { - "shape": "Se" + "shape": "Sh" }, "buildType": {}, - "imageSource": {} + "imageSource": {}, + "deprecationTime": { + "type": "timestamp" + }, + "lifecycleExecutionId": {} } } }, - "S6z": { + "S81": { "type": "structure", "members": { "all": { @@ -2774,6 +3340,13 @@ "type": "long" } } + }, + "S97": { + "type": "structure", + "members": { + "status": {}, + "reason": {} + } } } } \ No newline at end of file diff --git a/apis/imagebuilder-2019-12-02.normal.json b/apis/imagebuilder-2019-12-02.normal.json index 04a6b0cd80..766c6d9c8e 100644 --- a/apis/imagebuilder-2019-12-02.normal.json +++ b/apis/imagebuilder-2019-12-02.normal.json @@ -53,6 +53,46 @@ ], "documentation": "CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
" }, + "CancelLifecycleExecution": { + "name": "CancelLifecycleExecution", + "http": { + "method": "PUT", + "requestUri": "/CancelLifecycleExecution" + }, + "input": { + "shape": "CancelLifecycleExecutionRequest" + }, + "output": { + "shape": "CancelLifecycleExecutionResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "IdempotentParameterMismatchException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + }, + { + "shape": "ResourceInUseException" + } + ], + "documentation": "Cancel a specific image lifecycle policy runtime instance.
" + }, "CreateComponent": { "name": "CreateComponent", "http": { @@ -384,6 +424,52 @@ ], "documentation": "Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
" }, + "CreateLifecyclePolicy": { + "name": "CreateLifecyclePolicy", + "http": { + "method": "PUT", + "requestUri": "/CreateLifecyclePolicy" + }, + "input": { + "shape": "CreateLifecyclePolicyRequest" + }, + "output": { + "shape": "CreateLifecyclePolicyResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "IdempotentParameterMismatchException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ResourceAlreadyExistsException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "documentation": "Create a lifecycle policy resource.
" + }, "DeleteComponent": { "name": "DeleteComponent", "http": { @@ -643,6 +729,43 @@ ], "documentation": "Deletes an infrastructure configuration.
" }, + "DeleteLifecyclePolicy": { + "name": "DeleteLifecyclePolicy", + "http": { + "method": "DELETE", + "requestUri": "/DeleteLifecyclePolicy" + }, + "input": { + "shape": "DeleteLifecyclePolicyRequest" + }, + "output": { + "shape": "DeleteLifecyclePolicyResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + }, + { + "shape": "ResourceDependencyException" + } + ], + "documentation": "Delete the specified lifecycle policy resource.
" + }, "GetComponent": { "name": "GetComponent", "http": { @@ -1017,6 +1140,74 @@ ], "documentation": "Gets an infrastructure configuration.
" }, + "GetLifecycleExecution": { + "name": "GetLifecycleExecution", + "http": { + "method": "GET", + "requestUri": "/GetLifecycleExecution" + }, + "input": { + "shape": "GetLifecycleExecutionRequest" + }, + "output": { + "shape": "GetLifecycleExecutionResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + } + ], + "documentation": "Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.
" + }, + "GetLifecyclePolicy": { + "name": "GetLifecyclePolicy", + "http": { + "method": "GET", + "requestUri": "/GetLifecyclePolicy" + }, + "input": { + "shape": "GetLifecyclePolicyRequest" + }, + "output": { + "shape": "GetLifecyclePolicyResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + } + ], + "documentation": "Get details for the specified image lifecycle policy.
" + }, "GetWorkflowExecution": { "name": "GetWorkflowExecution", "http": { @@ -1643,6 +1834,117 @@ ], "documentation": "Returns a list of infrastructure configurations.
" }, + "ListLifecycleExecutionResources": { + "name": "ListLifecycleExecutionResources", + "http": { + "method": "POST", + "requestUri": "/ListLifecycleExecutionResources" + }, + "input": { + "shape": "ListLifecycleExecutionResourcesRequest" + }, + "output": { + "shape": "ListLifecycleExecutionResourcesResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "InvalidPaginationTokenException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + } + ], + "documentation": "List resources that the runtime instance of the image lifecycle identified for lifecycle actions.
" + }, + "ListLifecycleExecutions": { + "name": "ListLifecycleExecutions", + "http": { + "method": "POST", + "requestUri": "/ListLifecycleExecutions" + }, + "input": { + "shape": "ListLifecycleExecutionsRequest" + }, + "output": { + "shape": "ListLifecycleExecutionsResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "InvalidPaginationTokenException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + } + ], + "documentation": "Get the lifecycle runtime history for the specified resource.
" + }, + "ListLifecyclePolicies": { + "name": "ListLifecyclePolicies", + "http": { + "method": "POST", + "requestUri": "/ListLifecyclePolicies" + }, + "input": { + "shape": "ListLifecyclePoliciesRequest" + }, + "output": { + "shape": "ListLifecyclePoliciesResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "InvalidPaginationTokenException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + } + ], + "documentation": "Get a list of lifecycle policies in your Amazon Web Services account.
" + }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { @@ -1945,8 +2247,51 @@ ], "documentation": "Manually triggers a pipeline to create an image.
" }, - "TagResource": { - "name": "TagResource", + "StartResourceStateUpdate": { + "name": "StartResourceStateUpdate", + "http": { + "method": "PUT", + "requestUri": "/StartResourceStateUpdate" + }, + "input": { + "shape": "StartResourceStateUpdateRequest" + }, + "output": { + "shape": "StartResourceStateUpdateResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "IdempotentParameterMismatchException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + }, + { + "shape": "ResourceInUseException" + } + ], + "documentation": "Begin asynchronous resource state update for lifecycle changes to the specified image resources.
" + }, + "TagResource": { + "name": "TagResource", "http": { "method": "POST", "requestUri": "/tags/{resourceArn}" @@ -2117,6 +2462,49 @@ } ], "documentation": "Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
" + }, + "UpdateLifecyclePolicy": { + "name": "UpdateLifecyclePolicy", + "http": { + "method": "PUT", + "requestUri": "/UpdateLifecyclePolicy" + }, + "input": { + "shape": "UpdateLifecyclePolicyRequest" + }, + "output": { + "shape": "UpdateLifecyclePolicyResponse" + }, + "errors": [ + { + "shape": "ServiceException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "IdempotentParameterMismatchException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "CallRateLimitExceededException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "InvalidParameterCombinationException" + } + ], + "documentation": "Update the specified lifecycle policy.
" } }, "shapes": { @@ -2272,7 +2660,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token that was used for this request.
" + "documentation": "The client token that uniquely identifies the request.
" }, "imageBuildVersionArn": { "shape": "ImageBuildVersionArn", @@ -2280,6 +2668,33 @@ } } }, + "CancelLifecycleExecutionRequest": { + "type": "structure", + "required": [ + "lifecycleExecutionId", + "clientToken" + ], + "members": { + "lifecycleExecutionId": { + "shape": "LifecycleExecutionId", + "documentation": "Identifies the specific runtime instance of the image lifecycle to cancel.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", + "idempotencyToken": true + } + } + }, + "CancelLifecycleExecutionResponse": { + "type": "structure", + "members": { + "lifecycleExecutionId": { + "shape": "LifecycleExecutionId", + "documentation": "The unique identifier for the image lifecycle runtime instance that was canceled.
" + } + } + }, "ClientToken": { "type": "string", "max": 36, @@ -2863,7 +3278,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token of the component.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true } } @@ -2877,11 +3292,11 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "componentBuildVersionArn": { "shape": "ComponentBuildVersionArn", - "documentation": "The Amazon Resource Name (ARN) of the component that this request created.
" + "documentation": "The Amazon Resource Name (ARN) of the component that the request created.
" } } }, @@ -2959,7 +3374,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The client token used to make this request idempotent.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true } } @@ -2973,7 +3388,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The client token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "containerRecipeArn": { "shape": "ContainerRecipeArn", @@ -3007,7 +3422,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token of the distribution configuration.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true } } @@ -3021,7 +3436,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "distributionConfigurationArn": { "shape": "DistributionConfigurationArn", @@ -3083,7 +3498,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true }, "imageScanningConfiguration": { @@ -3101,7 +3516,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "imagePipelineArn": { "shape": "ImagePipelineArn", @@ -3157,7 +3572,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true } } @@ -3171,7 +3586,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "imageRecipeArn": { "shape": "ImageRecipeArn", @@ -3216,7 +3631,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true }, "imageScanningConfiguration": { @@ -3234,11 +3649,11 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "imageBuildVersionArn": { "shape": "ImageBuildVersionArn", - "documentation": "The Amazon Resource Name (ARN) of the image that this request created.
" + "documentation": "The Amazon Resource Name (ARN) of the image that the request created.
" } } }, @@ -3304,7 +3719,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true } } @@ -3318,7 +3733,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "infrastructureConfigurationArn": { "shape": "InfrastructureConfigurationArn", @@ -3326,6 +3741,69 @@ } } }, + "CreateLifecyclePolicyRequest": { + "type": "structure", + "required": [ + "name", + "executionRole", + "resourceType", + "policyDetails", + "resourceSelection", + "clientToken" + ], + "members": { + "name": { + "shape": "ResourceName", + "documentation": "The name of the lifecycle policy to create.
" + }, + "description": { + "shape": "NonEmptyString", + "documentation": "Optional description for the lifecycle policy.
" + }, + "status": { + "shape": "LifecyclePolicyStatus", + "documentation": "Indicates whether the lifecycle policy resource is enabled.
" + }, + "executionRole": { + "shape": "RoleNameOrArn", + "documentation": "The role name or Amazon Resource Name (ARN) for the IAM role that grants Image Builder access to run lifecycle actions.
" + }, + "resourceType": { + "shape": "LifecyclePolicyResourceType", + "documentation": "The type of Image Builder resource that the lifecycle policy applies to.
" + }, + "policyDetails": { + "shape": "LifecyclePolicyDetails", + "documentation": "Configuration details for the lifecycle policy rules.
" + }, + "resourceSelection": { + "shape": "LifecyclePolicyResourceSelection", + "documentation": "Selection criteria for the resources that the lifecycle policy applies to.
" + }, + "tags": { + "shape": "TagMap", + "documentation": "Tags to apply to the lifecycle policy resource.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", + "idempotencyToken": true + } + } + }, + "CreateLifecyclePolicyResponse": { + "type": "structure", + "members": { + "clientToken": { + "shape": "ClientToken", + "documentation": "The client token that uniquely identifies the request.
" + }, + "lifecyclePolicyArn": { + "shape": "LifecyclePolicyArn", + "documentation": "The Amazon Resource Name (ARN) of the lifecycle policy that the request created.
" + } + } + }, "CvssScore": { "type": "structure", "members": { @@ -3599,6 +4077,29 @@ } } }, + "DeleteLifecyclePolicyRequest": { + "type": "structure", + "required": [ + "lifecyclePolicyArn" + ], + "members": { + "lifecyclePolicyArn": { + "shape": "LifecyclePolicyArn", + "documentation": "The Amazon Resource Name (ARN) of the lifecycle policy resource to delete.
", + "location": "querystring", + "locationName": "lifecyclePolicyArn" + } + } + }, + "DeleteLifecyclePolicyResponse": { + "type": "structure", + "members": { + "lifecyclePolicyArn": { + "shape": "LifecyclePolicyArn", + "documentation": "The ARN of the lifecycle policy that was deleted.
" + } + } + }, "DiskImageFormat": { "type": "string", "enum": [ @@ -4229,6 +4730,52 @@ }, "documentation": "GetInfrastructureConfiguration response object.
" }, + "GetLifecycleExecutionRequest": { + "type": "structure", + "required": [ + "lifecycleExecutionId" + ], + "members": { + "lifecycleExecutionId": { + "shape": "LifecycleExecutionId", + "documentation": "Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.
", + "location": "querystring", + "locationName": "lifecycleExecutionId" + } + } + }, + "GetLifecycleExecutionResponse": { + "type": "structure", + "members": { + "lifecycleExecution": { + "shape": "LifecycleExecution", + "documentation": "Runtime details for the specified runtime instance of the lifecycle policy.
" + } + } + }, + "GetLifecyclePolicyRequest": { + "type": "structure", + "required": [ + "lifecyclePolicyArn" + ], + "members": { + "lifecyclePolicyArn": { + "shape": "LifecyclePolicyArn", + "documentation": "Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.
", + "location": "querystring", + "locationName": "lifecyclePolicyArn" + } + } + }, + "GetLifecyclePolicyResponse": { + "type": "structure", + "members": { + "lifecyclePolicy": { + "shape": "LifecyclePolicy", + "documentation": "The ARN of the image lifecycle policy resource that was returned.
" + } + } + }, "GetWorkflowExecutionRequest": { "type": "structure", "required": [ @@ -4486,6 +5033,14 @@ "imageScanningConfiguration": { "shape": "ImageScanningConfiguration", "documentation": "Contains settings for vulnerability scans.
" + }, + "deprecationTime": { + "shape": "DateTimeTimestamp", + "documentation": "The time when deprecation occurs for an image resource. This can be a past or future date.
" + }, + "lifecycleExecutionId": { + "shape": "LifecycleExecutionId", + "documentation": "Identifies the last runtime instance of the lifecycle policy to take action on the image.
" } }, "documentation": "An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (containerRecipe
), which creates a container image, or an image recipe (imageRecipe
), which creates an AMI.
The origin of the base image that Image Builder used to build this image.
" + }, + "deprecationTime": { + "shape": "DateTimeTimestamp", + "documentation": "The time when deprecation occurs for an image resource. This can be a past or future date.
" + }, + "lifecycleExecutionId": { + "shape": "LifecycleExecutionId", + "documentation": "Identifies the last runtime instance of the lifecycle policy to take action on the image.
" } }, "documentation": "An image summary.
" @@ -5158,7 +5722,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token of the component.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true } } @@ -5172,7 +5736,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "componentBuildVersionArn": { "shape": "ComponentBuildVersionArn", @@ -5238,7 +5802,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token that was used for this request.
" + "documentation": "The client token that uniquely identifies the request.
" } } }, @@ -5524,84 +6088,617 @@ "max": 50, "min": 1 }, - "ListComponentBuildVersionsRequest": { + "LifecycleExecution": { "type": "structure", - "required": [ - "componentVersionArn" - ], "members": { - "componentVersionArn": { - "shape": "ComponentVersionArn", - "documentation": "The component version Amazon Resource Name (ARN) whose versions you want to list.
" + "lifecycleExecutionId": { + "shape": "LifecycleExecutionId", + "documentation": "Identifies the lifecycle policy runtime instance.
" }, - "maxResults": { - "shape": "RestrictedInteger", - "documentation": "The maximum items to return in a request.
", - "box": true + "lifecyclePolicyArn": { + "shape": "LifecyclePolicyArn", + "documentation": "The Amazon Resource Name (ARN) of the lifecycle policy that ran.
" }, - "nextToken": { - "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "resourcesImpactedSummary": { + "shape": "LifecycleExecutionResourcesImpactedSummary", + "documentation": "Contains information about associated resources that are identified for action by the runtime instance of the lifecycle policy.
" + }, + "state": { + "shape": "LifecycleExecutionState", + "documentation": "Runtime state that reports if the policy action ran successfully, failed, or was skipped.
" + }, + "startTime": { + "shape": "DateTimeTimestamp", + "documentation": "The timestamp when the lifecycle runtime instance started.
" + }, + "endTime": { + "shape": "DateTimeTimestamp", + "documentation": "The timestamp when the lifecycle runtime instance completed.
" } - } + }, + "documentation": "Contains metadata from a runtime instance of a lifecycle policy.
" }, - "ListComponentBuildVersionsResponse": { + "LifecycleExecutionId": { + "type": "string", + "pattern": "^lce-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + "LifecycleExecutionResource": { "type": "structure", "members": { - "requestId": { + "accountId": { "shape": "NonEmptyString", - "documentation": "The request ID that uniquely identifies this request.
" + "documentation": "The account that owns the impacted resource.
" }, - "componentSummaryList": { - "shape": "ComponentSummaryList", - "documentation": "The list of component summaries for the specified semantic version.
" + "resourceId": { + "shape": "NonEmptyString", + "documentation": "Identifies the impacted resource. The resource ID depends on the type of resource, as follows.
Image Builder image resources: Amazon Resource Name (ARN)
Distributed AMIs: AMI ID
Container images distributed to an ECR repository: image URI or SHA Digest
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" - } - } - }, - "ListComponentsRequest": { - "type": "structure", - "members": { - "owner": { - "shape": "Ownership", - "documentation": "Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, third party components, or components that other accounts have shared with you.
" + "state": { + "shape": "LifecycleExecutionResourceState", + "documentation": "The runtime state for the lifecycle execution.
" }, - "filters": { - "shape": "FilterList", - "documentation": "Use the following filters to streamline results:
description
name
platform
supportedOsVersion
type
version
The action to take for the identified resource.
" }, - "byName": { - "shape": "Boolean", - "documentation": "Returns the list of components for the specified name.
" + "region": { + "shape": "NonEmptyString", + "documentation": "The Amazon Web Services Region where the lifecycle execution resource is stored.
" }, - "maxResults": { - "shape": "RestrictedInteger", - "documentation": "The maximum items to return in a request.
", - "box": true + "snapshots": { + "shape": "LifecycleExecutionSnapshotResourceList", + "documentation": "A list of associated resource snapshots for the impacted resource if it’s an AMI.
" }, - "nextToken": { - "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "imageUris": { + "shape": "StringList", + "documentation": "For an impacted container image, this identifies a list of URIs for associated container images distributed to ECR repositories.
" } - } + }, + "documentation": "Contains details for a resource that the runtime instance of the lifecycle policy identified for action.
" }, - "ListComponentsResponse": { + "LifecycleExecutionResourceAction": { "type": "structure", "members": { - "requestId": { - "shape": "NonEmptyString", - "documentation": "The request ID that uniquely identifies this request.
" - }, - "componentVersionList": { - "shape": "ComponentVersionList", - "documentation": "The list of component semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
The name of the resource that was identified for a lifecycle policy action.
" + }, + "reason": { + "shape": "NonEmptyString", + "documentation": "The reason why the lifecycle policy action is taken.
" + } + }, + "documentation": "The lifecycle policy action that was identified for the impacted resource.
" + }, + "LifecycleExecutionResourceActionName": { + "type": "string", + "enum": [ + "AVAILABLE", + "DELETE", + "DEPRECATE", + "DISABLE" + ] + }, + "LifecycleExecutionResourceList": { + "type": "list", + "member": { + "shape": "LifecycleExecutionResource" + } + }, + "LifecycleExecutionResourceState": { + "type": "structure", + "members": { + "status": { + "shape": "LifecycleExecutionResourceStatus", + "documentation": "The runtime status of the lifecycle action taken for the impacted resource.
" + }, + "reason": { + "shape": "NonEmptyString", + "documentation": "Messaging that clarifies the reason for the assigned status.
" + } + }, + "documentation": "Contains the state of an impacted resource that the runtime instance of the lifecycle policy identified for action.
" + }, + "LifecycleExecutionResourceStatus": { + "type": "string", + "enum": [ + "FAILED", + "IN_PROGRESS", + "SKIPPED", + "SUCCESS" + ] + }, + "LifecycleExecutionResourcesImpactedSummary": { + "type": "structure", + "members": { + "hasImpactedResources": { + "shape": "Boolean", + "documentation": "Indicates whether an image resource that was identified for a lifecycle action has associated resources that are also impacted.
" + } + }, + "documentation": "Contains details for an image resource that was identified for a lifecycle action.
" + }, + "LifecycleExecutionSnapshotResource": { + "type": "structure", + "members": { + "snapshotId": { + "shape": "NonEmptyString", + "documentation": "Identifies the impacted snapshot resource.
" + }, + "state": { + "shape": "LifecycleExecutionResourceState", + "documentation": "The runtime status of the lifecycle action taken for the snapshot.
" + } + }, + "documentation": "Contains the state of an impacted snapshot resource that the runtime instance of the lifecycle policy identified for action.
" + }, + "LifecycleExecutionSnapshotResourceList": { + "type": "list", + "member": { + "shape": "LifecycleExecutionSnapshotResource" + } + }, + "LifecycleExecutionState": { + "type": "structure", + "members": { + "status": { + "shape": "LifecycleExecutionStatus", + "documentation": "The runtime status of the lifecycle execution.
" + }, + "reason": { + "shape": "NonEmptyString", + "documentation": "The reason for the current status.
" + } + }, + "documentation": "The current state of the runtime instance of the lifecycle policy.
" + }, + "LifecycleExecutionStatus": { + "type": "string", + "enum": [ + "IN_PROGRESS", + "CANCELLED", + "CANCELLING", + "FAILED", + "SUCCESS" + ] + }, + "LifecycleExecutionsList": { + "type": "list", + "member": { + "shape": "LifecycleExecution" + } + }, + "LifecyclePolicy": { + "type": "structure", + "members": { + "arn": { + "shape": "LifecyclePolicyArn", + "documentation": "The Amazon Resource Name (ARN) of the lifecycle policy resource.
" + }, + "name": { + "shape": "ResourceName", + "documentation": "The name of the lifecycle policy.
" + }, + "description": { + "shape": "NonEmptyString", + "documentation": "Optional description for the lifecycle policy.
" + }, + "status": { + "shape": "LifecyclePolicyStatus", + "documentation": "Indicates whether the lifecycle policy resource is enabled.
" + }, + "executionRole": { + "shape": "RoleNameOrArn", + "documentation": "The name of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create.
" + }, + "resourceType": { + "shape": "LifecyclePolicyResourceType", + "documentation": "The type of resources the lifecycle policy targets.
" + }, + "policyDetails": { + "shape": "LifecyclePolicyDetails", + "documentation": "The configuration details for a lifecycle policy resource.
" + }, + "resourceSelection": { + "shape": "LifecyclePolicyResourceSelection", + "documentation": "Resource selection criteria used to run the lifecycle policy.
" + }, + "dateCreated": { + "shape": "DateTimeTimestamp", + "documentation": "The timestamp when Image Builder created the lifecycle policy resource.
" + }, + "dateUpdated": { + "shape": "DateTimeTimestamp", + "documentation": "The timestamp when Image Builder updated the lifecycle policy resource.
" + }, + "dateLastRun": { + "shape": "DateTimeTimestamp", + "documentation": "The timestamp for the last time Image Builder ran the lifecycle policy.
" + }, + "tags": { + "shape": "TagMap", + "documentation": "To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.
" + } + }, + "documentation": "The configuration details for a lifecycle policy resource.
" + }, + "LifecyclePolicyArn": { + "type": "string", + "max": 1024, + "pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):lifecycle-policy/[a-z0-9-_]+$" + }, + "LifecyclePolicyDetail": { + "type": "structure", + "required": [ + "action", + "filter" + ], + "members": { + "action": { + "shape": "LifecyclePolicyDetailAction", + "documentation": "Configuration details for the policy action.
" + }, + "filter": { + "shape": "LifecyclePolicyDetailFilter", + "documentation": "Specifies the resources that the lifecycle policy applies to.
" + }, + "exclusionRules": { + "shape": "LifecyclePolicyDetailExclusionRules", + "documentation": "Additional rules to specify resources that should be exempt from policy actions.
" + } + }, + "documentation": "The configuration details for a lifecycle policy resource.
" + }, + "LifecyclePolicyDetailAction": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": { + "shape": "LifecyclePolicyDetailActionType", + "documentation": "Specifies the lifecycle action to take.
" + }, + "includeResources": { + "shape": "LifecyclePolicyDetailActionIncludeResources", + "documentation": "Specifies the resources that the lifecycle policy applies to.
" + } + }, + "documentation": "Contains selection criteria for the lifecycle policy.
" + }, + "LifecyclePolicyDetailActionIncludeResources": { + "type": "structure", + "members": { + "amis": { + "shape": "Boolean", + "documentation": "Specifies whether the lifecycle action should apply to distributed AMIs.
" + }, + "snapshots": { + "shape": "Boolean", + "documentation": "Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.
" + }, + "containers": { + "shape": "Boolean", + "documentation": "Specifies whether the lifecycle action should apply to distributed containers.
" + } + }, + "documentation": "Specifies how the lifecycle policy should apply actions to selected resources.
" + }, + "LifecyclePolicyDetailActionType": { + "type": "string", + "enum": [ + "DELETE", + "DEPRECATE", + "DISABLE" + ] + }, + "LifecyclePolicyDetailExclusionRules": { + "type": "structure", + "members": { + "tagMap": { + "shape": "TagMap", + "documentation": "Contains a list of tags that Image Builder uses to skip lifecycle actions for AMIs that have them.
" + }, + "amis": { + "shape": "LifecyclePolicyDetailExclusionRulesAmis", + "documentation": "Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
" + } + }, + "documentation": "Specifies resources that lifecycle policy actions should not apply to.
" + }, + "LifecyclePolicyDetailExclusionRulesAmis": { + "type": "structure", + "members": { + "isPublic": { + "shape": "Boolean", + "documentation": "Configures whether public AMIs are excluded from the lifecycle action.
" + }, + "regions": { + "shape": "StringList", + "documentation": "Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.
" + }, + "sharedAccounts": { + "shape": "AccountList", + "documentation": "Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions.
" + }, + "lastLaunched": { + "shape": "LifecyclePolicyDetailExclusionRulesAmisLastLaunched", + "documentation": "Configures Amazon Web Services Regions that are excluded from the lifecycle action.
" + }, + "tagMap": { + "shape": "TagMap", + "documentation": "Lists tags that should be excluded from lifecycle actions for the AMIs that have them.
" + } + }, + "documentation": "Defines criteria for AMIs that are excluded from lifecycle actions.
" + }, + "LifecyclePolicyDetailExclusionRulesAmisLastLaunched": { + "type": "structure", + "required": [ + "value", + "unit" + ], + "members": { + "value": { + "shape": "LifecyclePolicyDetailExclusionRulesAmisLastLaunchedValue", + "documentation": "The integer number of units for the time period. For example 6
(months).
Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years.
" + } + }, + "documentation": "Defines criteria to exclude AMIs from lifecycle actions based on the last time they were used to launch an instance.
" + }, + "LifecyclePolicyDetailExclusionRulesAmisLastLaunchedValue": { + "type": "integer", + "max": 365, + "min": 1 + }, + "LifecyclePolicyDetailFilter": { + "type": "structure", + "required": [ + "type", + "value" + ], + "members": { + "type": { + "shape": "LifecyclePolicyDetailFilterType", + "documentation": "Filter resources based on either age
or count
.
The number of units for the time period or for the count. For example, a value of 6
might refer to six months or six AMIs.
For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.
Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules.
" + }, + "retainAtLeast": { + "shape": "LifecyclePolicyDetailFilterRetainAtLeast", + "documentation": "For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE
action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.
Defines filters that the lifecycle policy uses to determine impacted resource.
" + }, + "LifecyclePolicyDetailFilterRetainAtLeast": { + "type": "integer", + "max": 10, + "min": 1 + }, + "LifecyclePolicyDetailFilterType": { + "type": "string", + "enum": [ + "AGE", + "COUNT" + ] + }, + "LifecyclePolicyDetailFilterValue": { + "type": "integer", + "max": 1000, + "min": 1 + }, + "LifecyclePolicyDetails": { + "type": "list", + "member": { + "shape": "LifecyclePolicyDetail" + }, + "max": 3, + "min": 1 + }, + "LifecyclePolicyResourceSelection": { + "type": "structure", + "members": { + "recipes": { + "shape": "LifecyclePolicyResourceSelectionRecipes", + "documentation": "A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.
" + }, + "tagMap": { + "shape": "TagMap", + "documentation": "A list of tags that are used as selection criteria for the resources that the lifecycle policy applies to.
" + } + }, + "documentation": "Resource selection criteria for the lifecycle policy.
" + }, + "LifecyclePolicyResourceSelectionRecipe": { + "type": "structure", + "required": [ + "name", + "semanticVersion" + ], + "members": { + "name": { + "shape": "ResourceName", + "documentation": "The name of an Image Builder recipe that the lifecycle policy uses for resource selection.
" + }, + "semanticVersion": { + "shape": "VersionNumber", + "documentation": "The version of the Image Builder recipe specified by the name
field.
Specifies an Image Builder recipe that the lifecycle policy uses for resource selection.
" + }, + "LifecyclePolicyResourceSelectionRecipes": { + "type": "list", + "member": { + "shape": "LifecyclePolicyResourceSelectionRecipe" + }, + "max": 50, + "min": 1 + }, + "LifecyclePolicyResourceType": { + "type": "string", + "enum": [ + "AMI_IMAGE", + "CONTAINER_IMAGE" + ] + }, + "LifecyclePolicyStatus": { + "type": "string", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "LifecyclePolicySummary": { + "type": "structure", + "members": { + "arn": { + "shape": "LifecyclePolicyArn", + "documentation": "The Amazon Resource Name (ARN) of the lifecycle policy summary resource.
" + }, + "name": { + "shape": "ResourceName", + "documentation": "The name of the lifecycle policy.
" + }, + "description": { + "shape": "NonEmptyString", + "documentation": "Optional description for the lifecycle policy.
" + }, + "status": { + "shape": "LifecyclePolicyStatus", + "documentation": "The lifecycle policy resource status.
" + }, + "executionRole": { + "shape": "RoleNameOrArn", + "documentation": "The name of the IAM role that Image Builder uses to run the lifecycle policy.
" + }, + "resourceType": { + "shape": "LifecyclePolicyResourceType", + "documentation": "The type of resources the lifecycle policy targets.
" + }, + "dateCreated": { + "shape": "DateTimeTimestamp", + "documentation": "The timestamp when Image Builder created the lifecycle policy resource.
" + }, + "dateUpdated": { + "shape": "DateTimeTimestamp", + "documentation": "The timestamp when Image Builder updated the lifecycle policy resource.
" + }, + "dateLastRun": { + "shape": "DateTimeTimestamp", + "documentation": "The timestamp for the last time Image Builder ran the lifecycle policy.
" + }, + "tags": { + "shape": "TagMap", + "documentation": "To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.
" + } + }, + "documentation": "Contains a summary of lifecycle policy resources.
" + }, + "LifecyclePolicySummaryList": { + "type": "list", + "member": { + "shape": "LifecyclePolicySummary" + } + }, + "LifecyclePolicyTimeUnit": { + "type": "string", + "enum": [ + "DAYS", + "WEEKS", + "MONTHS", + "YEARS" + ] + }, + "ListComponentBuildVersionsRequest": { + "type": "structure", + "required": [ + "componentVersionArn" + ], + "members": { + "componentVersionArn": { + "shape": "ComponentVersionArn", + "documentation": "The component version Amazon Resource Name (ARN) whose versions you want to list.
" + }, + "maxResults": { + "shape": "RestrictedInteger", + "documentation": "The maximum items to return in a request.
", + "box": true + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + } + } + }, + "ListComponentBuildVersionsResponse": { + "type": "structure", + "members": { + "requestId": { + "shape": "NonEmptyString", + "documentation": "The request ID that uniquely identifies this request.
" + }, + "componentSummaryList": { + "shape": "ComponentSummaryList", + "documentation": "The list of component summaries for the specified semantic version.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" + } + } + }, + "ListComponentsRequest": { + "type": "structure", + "members": { + "owner": { + "shape": "Ownership", + "documentation": "Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, third party components, or components that other accounts have shared with you.
" + }, + "filters": { + "shape": "FilterList", + "documentation": "Use the following filters to streamline results:
description
name
platform
supportedOsVersion
type
version
Returns the list of components for the specified name.
" + }, + "maxResults": { + "shape": "RestrictedInteger", + "documentation": "The maximum items to return in a request.
", + "box": true + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + } + } + }, + "ListComponentsResponse": { + "type": "structure", + "members": { + "requestId": { + "shape": "NonEmptyString", + "documentation": "The request ID that uniquely identifies this request.
" + }, + "componentVersionList": { + "shape": "ComponentVersionList", + "documentation": "The list of component semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5623,7 +6720,7 @@ }, "nextToken": { "shape": "NonEmptyString", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -5640,7 +6737,7 @@ }, "nextToken": { "shape": "NonEmptyString", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5658,7 +6755,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -5675,7 +6772,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5700,7 +6797,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -5717,7 +6814,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5738,7 +6835,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -5755,7 +6852,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5780,7 +6877,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -5797,7 +6894,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5815,7 +6912,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -5832,7 +6929,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5854,7 +6951,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -5871,7 +6968,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5883,7 +6980,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -5904,7 +7001,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5922,7 +7019,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -5939,7 +7036,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -5965,7 +7062,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" }, "includeDeprecated": { "shape": "NullableBoolean", @@ -5986,7 +7083,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -6004,7 +7101,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" } } }, @@ -6021,7 +7118,118 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" + } + } + }, + "ListLifecycleExecutionResourcesRequest": { + "type": "structure", + "required": [ + "lifecycleExecutionId" + ], + "members": { + "lifecycleExecutionId": { + "shape": "LifecycleExecutionId", + "documentation": "Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.
" + }, + "parentResourceId": { + "shape": "NonEmptyString", + "documentation": "You can leave this empty to get a list of Image Builder resources that were identified for lifecycle actions.
To get a list of associated resources that are impacted for an individual resource (the parent), specify its Amazon Resource Name (ARN). Associated resources are produced from your image and distributed when you run a build, such as AMIs or container images stored in ECR repositories.
" + }, + "maxResults": { + "shape": "RestrictedInteger", + "documentation": "The maximum items to return in a request.
", + "box": true + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + } + } + }, + "ListLifecycleExecutionResourcesResponse": { + "type": "structure", + "members": { + "lifecycleExecutionId": { + "shape": "LifecycleExecutionId", + "documentation": "Runtime details for the specified runtime instance of the lifecycle policy.
" + }, + "lifecycleExecutionState": { + "shape": "LifecycleExecutionState", + "documentation": "The current state of the lifecycle runtime instance.
" + }, + "resources": { + "shape": "LifecycleExecutionResourceList", + "documentation": "A list of resources that were identified for lifecycle actions.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" + } + } + }, + "ListLifecycleExecutionsRequest": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "maxResults": { + "shape": "RestrictedInteger", + "documentation": "The maximum items to return in a request.
", + "box": true + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + }, + "resourceArn": { + "shape": "ImageBuilderArn", + "documentation": "The Amazon Resource Name (ARN) of the resource for which to get a list of lifecycle runtime instances.
" + } + } + }, + "ListLifecycleExecutionsResponse": { + "type": "structure", + "members": { + "lifecycleExecutions": { + "shape": "LifecycleExecutionsList", + "documentation": "A list of lifecycle runtime instances for the specified resource.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" + } + } + }, + "ListLifecyclePoliciesRequest": { + "type": "structure", + "members": { + "filters": { + "shape": "FilterList", + "documentation": "Streamline results based on one of the following values: Name
, Status
.
The maximum items to return in a request.
", + "box": true + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" + } + } + }, + "ListLifecyclePoliciesResponse": { + "type": "structure", + "members": { + "lifecyclePolicySummaryList": { + "shape": "LifecyclePolicySummaryList", + "documentation": "A list of lifecycle policies in your Amazon Web Services account that meet the criteria specified in the request.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -6061,7 +7269,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" }, "imageBuildVersionArn": { "shape": "ImageBuildVersionArn", @@ -6090,7 +7298,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -6107,7 +7315,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "A token to specify where to start paginating. This is the NextToken from a previously truncated response.
" + "documentation": "A token to specify where to start paginating. This is the nextToken from a previously truncated response.
" }, "workflowExecutionId": { "shape": "WorkflowExecutionId", @@ -6144,7 +7352,7 @@ }, "nextToken": { "shape": "PaginationToken", - "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
" + "documentation": "The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
" } } }, @@ -6160,7 +7368,6 @@ }, "MaxParallelLaunches": { "type": "integer", - "max": 10000, "min": 1 }, "NonEmptyString": { @@ -6481,6 +7688,52 @@ "max": 30000, "min": 1 }, + "ResourceState": { + "type": "structure", + "members": { + "status": { + "shape": "ResourceStatus", + "documentation": "Shows the current lifecycle policy action that was applied to an impacted resource.
" + } + }, + "documentation": "The current state of an impacted resource.
" + }, + "ResourceStateUpdateExclusionRules": { + "type": "structure", + "members": { + "amis": { + "shape": "LifecyclePolicyDetailExclusionRulesAmis" + } + }, + "documentation": "Additional rules to specify resources that should be exempt from ad-hoc lifecycle actions.
" + }, + "ResourceStateUpdateIncludeResources": { + "type": "structure", + "members": { + "amis": { + "shape": "Boolean", + "documentation": "Specifies whether the lifecycle action should apply to distributed AMIs
" + }, + "snapshots": { + "shape": "Boolean", + "documentation": "Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.
" + }, + "containers": { + "shape": "Boolean", + "documentation": "Specifies whether the lifecycle action should apply to distributed containers.
" + } + }, + "documentation": "Specifies if the lifecycle policy should apply actions to selected resources.
" + }, + "ResourceStatus": { + "type": "string", + "enum": [ + "AVAILABLE", + "DELETED", + "DEPRECATED", + "DISABLED" + ] + }, "ResourceTagMap": { "type": "map", "key": { @@ -6497,6 +7750,12 @@ "max": 25, "min": 1 }, + "RoleNameOrArn": { + "type": "string", + "max": 2048, + "min": 1, + "pattern": "^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, "S3ExportConfiguration": { "type": "structure", "required": [ @@ -6607,7 +7866,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true } } @@ -6621,11 +7880,63 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "imageBuildVersionArn": { "shape": "ImageBuildVersionArn", - "documentation": "The Amazon Resource Name (ARN) of the image that was created by this request.
" + "documentation": "The Amazon Resource Name (ARN) of the image that the request created.
" + } + } + }, + "StartResourceStateUpdateRequest": { + "type": "structure", + "required": [ + "resourceArn", + "state", + "clientToken" + ], + "members": { + "resourceArn": { + "shape": "ImageBuildVersionArn", + "documentation": "The ARN of the Image Builder resource that is updated. The state update might also impact associated resources.
" + }, + "state": { + "shape": "ResourceState", + "documentation": "Indicates the lifecycle action to take for this request.
" + }, + "executionRole": { + "shape": "RoleNameOrArn", + "documentation": "The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.
" + }, + "includeResources": { + "shape": "ResourceStateUpdateIncludeResources", + "documentation": "A list of image resources to update state for.
" + }, + "exclusionRules": { + "shape": "ResourceStateUpdateExclusionRules", + "documentation": "Skip action on the image resource and associated resources if specified exclusion rules are met.
" + }, + "updateAt": { + "shape": "DateTimeTimestamp", + "documentation": "The timestamp that indicates when resources are updated by a lifecycle action.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", + "idempotencyToken": true + } + } + }, + "StartResourceStateUpdateResponse": { + "type": "structure", + "members": { + "lifecycleExecutionId": { + "shape": "LifecycleExecutionId", + "documentation": "Identifies the lifecycle runtime instance that started the resource state update.
" + }, + "resourceArn": { + "shape": "ImageBuildVersionArn", + "documentation": "The requested ARN of the Image Builder resource for the asynchronous update.
" } } }, @@ -6773,7 +8084,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token of the distribution configuration.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true } } @@ -6787,7 +8098,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "distributionConfigurationArn": { "shape": "DistributionConfigurationArn", @@ -6845,7 +8156,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true }, "imageScanningConfiguration": { @@ -6863,7 +8174,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "imagePipelineArn": { "shape": "ImagePipelineArn", @@ -6921,7 +8232,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "idempotencyToken": true }, "resourceTags": { @@ -6943,7 +8254,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "The idempotency token used to make this request idempotent.
" + "documentation": "The client token that uniquely identifies the request.
" }, "infrastructureConfigurationArn": { "shape": "InfrastructureConfigurationArn", @@ -6951,6 +8262,61 @@ } } }, + "UpdateLifecyclePolicyRequest": { + "type": "structure", + "required": [ + "lifecyclePolicyArn", + "executionRole", + "resourceType", + "policyDetails", + "resourceSelection", + "clientToken" + ], + "members": { + "lifecyclePolicyArn": { + "shape": "LifecyclePolicyArn", + "documentation": "The Amazon Resource Name (ARN) of the lifecycle policy resource.
" + }, + "description": { + "shape": "NonEmptyString", + "documentation": "Optional description for the lifecycle policy.
" + }, + "status": { + "shape": "LifecyclePolicyStatus", + "documentation": "Indicates whether the lifecycle policy resource is enabled.
" + }, + "executionRole": { + "shape": "RoleNameOrArn", + "documentation": "The name of the IAM role that Image Builder should use to update the lifecycle policy.
" + }, + "resourceType": { + "shape": "LifecyclePolicyResourceType", + "documentation": "The type of image resource that the lifecycle policy applies to.
" + }, + "policyDetails": { + "shape": "LifecyclePolicyDetails", + "documentation": "The configuration details for a lifecycle policy resource.
" + }, + "resourceSelection": { + "shape": "LifecyclePolicyResourceSelection", + "documentation": "Selection criteria for resources that the lifecycle policy applies to.
" + }, + "clientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", + "idempotencyToken": true + } + } + }, + "UpdateLifecyclePolicyResponse": { + "type": "structure", + "members": { + "lifecyclePolicyArn": { + "shape": "LifecyclePolicyArn", + "documentation": "The ARN of the image lifecycle policy resource that was updated.
" + } + } + }, "Uri": { "type": "string" }, diff --git a/apis/imagebuilder-2019-12-02.paginators.json b/apis/imagebuilder-2019-12-02.paginators.json index 8053cf4f76..15c8cb41ed 100644 --- a/apis/imagebuilder-2019-12-02.paginators.json +++ b/apis/imagebuilder-2019-12-02.paginators.json @@ -77,6 +77,24 @@ "limit_key": "maxResults", "result_key": "infrastructureConfigurationSummaryList" }, + "ListLifecycleExecutionResources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "resources" + }, + "ListLifecycleExecutions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "lifecycleExecutions" + }, + "ListLifecyclePolicies": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "lifecyclePolicySummaryList" + }, "ListWorkflowExecutions": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/apis/iot-2015-05-28.min.json b/apis/iot-2015-05-28.min.json index 7f7697843d..01a3cbfceb 100644 --- a/apis/iot-2015-05-28.min.json +++ b/apis/iot-2015-05-28.min.json @@ -4120,7 +4120,7 @@ "shape": "Snc" }, "thingGroupIndexingConfiguration": { - "shape": "Sno" + "shape": "Sns" } } } @@ -4282,7 +4282,7 @@ "type": "structure", "members": { "versionUpdateByJobsConfig": { - "shape": "So4" + "shape": "So8" } } } @@ -4667,7 +4667,7 @@ "shape": "S9n" }, "violationEventAdditionalInfo": { - "shape": "Spe" + "shape": "Spi" }, "verificationState": {}, "verificationStateDescription": {}, @@ -4718,7 +4718,7 @@ "type": "structure", "members": { "policies": { - "shape": "Spl" + "shape": "Spp" }, "nextMarker": {} } @@ -5159,7 +5159,7 @@ "type": "structure", "members": { "certificates": { - "shape": "Sqn" + "shape": "Sqr" }, "nextMarker": {} } @@ -5200,7 +5200,7 @@ "type": "structure", "members": { "certificates": { - "shape": "Sqn" + "shape": "Sqr" }, "nextMarker": {} } @@ -5528,7 +5528,7 @@ "members": { "thingArn": {}, "jobExecutionSummary": { - "shape": "Srn" + "shape": "Srr" } } } @@ -5585,7 +5585,7 @@ "members": { "jobId": {}, "jobExecutionSummary": { - "shape": "Srn" + "shape": "Srr" } } } @@ -6083,7 +6083,7 @@ "type": "structure", "members": { "policies": { - "shape": "Spl" + "shape": "Spp" }, "nextMarker": {} } @@ -6124,7 +6124,7 @@ "type": "structure", "members": { "principals": { - "shape": "Ssy" + "shape": "St2" }, "nextMarker": {} } @@ -6204,7 +6204,7 @@ "type": "structure", "members": { "policies": { - "shape": "Spl" + "shape": "Spp" }, "nextMarker": {} } @@ -6241,7 +6241,7 @@ "type": "structure", "members": { "things": { - "shape": "St8" + "shape": "Stc" }, "nextToken": {} } @@ -6487,7 +6487,7 @@ "securityProfileIdentifiers": { "type": "list", "member": { - "shape": "Stt" + "shape": "Stx" } }, "nextToken": {} @@ -6534,10 +6534,10 @@ "type": "structure", "members": { "securityProfileIdentifier": { - "shape": "Stt" + "shape": "Stx" }, "target": { - "shape": "Sty" + "shape": "Su2" } } } @@ -6690,7 +6690,7 @@ "securityProfileTargets": { "type": "list", "member": { - "shape": "Sty" + "shape": "Su2" } }, "nextToken": {} @@ -6805,7 +6805,7 @@ "type": "structure", "members": { "principals": { - "shape": "Ssy" + "shape": "St2" }, "nextToken": {} } @@ -7024,7 +7024,7 @@ "type": "structure", "members": { "things": { - "shape": "St8" + "shape": "Stc" }, "nextToken": {} } @@ -7065,7 +7065,7 @@ "type": "structure", "members": { "things": { - "shape": "St8" + "shape": "Stc" }, "nextToken": {} } @@ -7217,7 +7217,7 @@ "type": "structure", "members": { "logTarget": { - "shape": "Svm" + "shape": "Svq" }, "logLevel": {} } @@ -7299,7 +7299,7 @@ "shape": "S9n" }, "violationEventAdditionalInfo": { - "shape": "Spe" + "shape": "Spi" }, "violationEventType": {}, "verificationState": {}, @@ -7570,7 +7570,7 @@ "thingId": {}, "thingTypeName": {}, "thingGroupNames": { - "shape": "Swi" + "shape": "Swm" }, "attributes": { "shape": "S3o" @@ -7604,7 +7604,7 @@ "shape": "S3o" }, "parentGroupNames": { - "shape": "Swi" + "shape": "Swm" } } } @@ -7692,7 +7692,7 @@ ], "members": { "logTarget": { - "shape": "Svm" + "shape": "Svq" }, "logLevel": {} } @@ -7901,7 +7901,7 @@ "authInfos": { "type": "list", "member": { - "shape": "Sxb" + "shape": "Sxf" } }, "clientId": { @@ -7909,10 +7909,10 @@ "locationName": "clientId" }, "policyNamesToAdd": { - "shape": "Sxf" + "shape": "Sxj" }, "policyNamesToSkip": { - "shape": "Sxf" + "shape": "Sxj" } } }, @@ -7925,13 +7925,13 @@ "type": "structure", "members": { "authInfo": { - "shape": "Sxb" + "shape": "Sxf" }, "allowed": { "type": "structure", "members": { "policies": { - "shape": "Spl" + "shape": "Spp" } } }, @@ -7942,7 +7942,7 @@ "type": "structure", "members": { "policies": { - "shape": "Spl" + "shape": "Spp" } } }, @@ -7950,7 +7950,7 @@ "type": "structure", "members": { "policies": { - "shape": "Spl" + "shape": "Spp" } } } @@ -8467,7 +8467,7 @@ "shape": "Snc" }, "thingGroupIndexingConfiguration": { - "shape": "Sno" + "shape": "Sns" } } }, @@ -8589,7 +8589,7 @@ "type": "structure", "members": { "versionUpdateByJobsConfig": { - "shape": "So4" + "shape": "So8" }, "clientToken": { "idempotencyToken": true, @@ -8936,10 +8936,10 @@ "members": { "thingName": {}, "thingGroupsToAdd": { - "shape": "Szz" + "shape": "S103" }, "thingGroupsToRemove": { - "shape": "Szz" + "shape": "S103" }, "overrideDynamicGroups": { "type": "boolean" @@ -10550,6 +10550,16 @@ "namedShadowNames": { "type": "list", "member": {} + }, + "geoLocations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "order": {} + } + } } } } @@ -10565,7 +10575,7 @@ } } }, - "Sno": { + "Sns": { "type": "structure", "required": [ "thingGroupIndexingMode" @@ -10580,7 +10590,7 @@ } } }, - "So4": { + "So8": { "type": "structure", "members": { "enabled": { @@ -10589,13 +10599,13 @@ "roleArn": {} } }, - "Spe": { + "Spi": { "type": "structure", "members": { "confidenceLevel": {} } }, - "Spl": { + "Spp": { "type": "list", "member": { "type": "structure", @@ -10605,7 +10615,7 @@ } } }, - "Sqn": { + "Sqr": { "type": "list", "member": { "type": "structure", @@ -10620,7 +10630,7 @@ } } }, - "Srn": { + "Srr": { "type": "structure", "members": { "status": {}, @@ -10641,15 +10651,15 @@ } } }, - "Ssy": { + "St2": { "type": "list", "member": {} }, - "St8": { + "Stc": { "type": "list", "member": {} }, - "Stt": { + "Stx": { "type": "structure", "required": [ "name", @@ -10660,7 +10670,7 @@ "arn": {} } }, - "Sty": { + "Su2": { "type": "structure", "required": [ "arn" @@ -10669,7 +10679,7 @@ "arn": {} } }, - "Svm": { + "Svq": { "type": "structure", "required": [ "targetType" @@ -10679,11 +10689,11 @@ "targetName": {} } }, - "Swi": { + "Swm": { "type": "list", "member": {} }, - "Sxb": { + "Sxf": { "type": "structure", "required": [ "resources" @@ -10696,11 +10706,11 @@ } } }, - "Sxf": { + "Sxj": { "type": "list", "member": {} }, - "Szz": { + "S103": { "type": "list", "member": {} } diff --git a/apis/iot-2015-05-28.normal.json b/apis/iot-2015-05-28.normal.json index 301b33810c..b7c864a81d 100644 --- a/apis/iot-2015-05-28.normal.json +++ b/apis/iot-2015-05-28.normal.json @@ -10692,7 +10692,7 @@ }, "destinationPackageVersions": { "shape": "DestinationPackageVersions", - "documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single string. Up to five strings are allowed.
" + "documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
" } } }, @@ -10768,7 +10768,7 @@ }, "destinationPackageVersions": { "shape": "DestinationPackageVersions", - "documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single string. Up to five strings are allowed.
" + "documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
" } } }, @@ -13255,7 +13255,7 @@ }, "destinationPackageVersions": { "shape": "DestinationPackageVersions", - "documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single string. Up to five strings are allowed.
" + "documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
" } } }, @@ -14845,6 +14845,26 @@ "GenericLongValue": { "type": "long" }, + "GeoLocationTarget": { + "type": "structure", + "members": { + "name": { + "shape": "TargetFieldName", + "documentation": "The name
of the geolocation target field. If the target field is part of a named shadow, you must select the named shadow using the namedShadow
filter.
The order
of the geolocation target field. This field is optional. The default value is LatLon
.
A geolocation target that you select to index. Each geolocation target contains a name
and order
key-value pair that specifies the geolocation target fields.
The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
" + }, + "geoLocations": { + "shape": "GeoLocationsFilter", + "documentation": "The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1
. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode
to be ON
and specify your shadow names in filter
.
Provides additional selections for named shadows and geolocation data.
To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode
to be ON and specify your shadow names in namedShadowNames
filter.
To add geolocation data to your fleet indexing configuration:
If you store geolocation data in a class/unnamed shadow, set thingIndexingMode
to be REGISTRY_AND_SHADOW
and specify your geolocation data in geoLocations
filter.
If you store geolocation data in a named shadow, set namedShadowIndexingMode
to be ON
, add the shadow name in namedShadowNames
filter, and specify your geolocation data in geoLocations
filter. For more information, see Managing fleet indexing.
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single string. Up to five strings are allowed.
" + "documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
" } }, "documentation": "The Job
object contains details about a job.
The maximum number of results to return at one time. The response might contain fewer results but will never contain more.
" + "documentation": "The maximum number of results to return per page at one time. The response might contain fewer results but will never contain more.
" }, "queryVersion": { "shape": "QueryVersion", @@ -21555,7 +21579,7 @@ "type": "string", "max": 64, "min": 1, - "pattern": "[a-zA-Z0-9:_-]+" + "pattern": "[$a-zA-Z0-9:_-]+" }, "SigV4Authorization": { "type": "structure", @@ -22216,6 +22240,16 @@ "shape": "AuditCheckName" } }, + "TargetFieldName": { + "type": "string" + }, + "TargetFieldOrder": { + "type": "string", + "enum": [ + "LatLon", + "LonLat" + ] + }, "TargetSelection": { "type": "string", "enum": [ @@ -22728,7 +22762,7 @@ }, "filter": { "shape": "IndexingFilter", - "documentation": "Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode
to be ON
and specify your shadow names in filter
.
Provides additional selections for named shadows and geolocation data.
To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode
to be ON and specify your shadow names in namedShadowNames
filter.
To add geolocation data to your fleet indexing configuration:
If you store geolocation data in a class/unnamed shadow, set thingIndexingMode
to be REGISTRY_AND_SHADOW
and specify your geolocation data in geoLocations
filter.
If you store geolocation data in a named shadow, set namedShadowIndexingMode
to be ON
, add the shadow name in namedShadowNames
filter, and specify your geolocation data in geoLocations
filter. For more information, see Managing fleet indexing.
The thing indexing configuration. For more information, see Managing Thing Indexing.
" diff --git a/apis/ivs-realtime-2020-07-14.min.json b/apis/ivs-realtime-2020-07-14.min.json index d4442542b0..c8e694afa3 100644 --- a/apis/ivs-realtime-2020-07-14.min.json +++ b/apis/ivs-realtime-2020-07-14.min.json @@ -13,6 +13,32 @@ "uid": "ivs-realtime-2020-07-14" }, "operations": { + "CreateEncoderConfiguration": { + "http": { + "requestUri": "/CreateEncoderConfiguration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "name": {}, + "tags": { + "shape": "S3" + }, + "video": { + "shape": "S6" + } + } + }, + "output": { + "type": "structure", + "members": { + "encoderConfiguration": { + "shape": "Sc" + } + } + } + }, "CreateParticipantToken": { "http": { "requestUri": "/CreateParticipantToken", @@ -25,10 +51,10 @@ ], "members": { "attributes": { - "shape": "S2" + "shape": "Sf" }, "capabilities": { - "shape": "S4" + "shape": "Sh" }, "duration": { "type": "integer" @@ -41,7 +67,7 @@ "type": "structure", "members": { "participantToken": { - "shape": "Sa" + "shape": "Sn" } } } @@ -61,10 +87,10 @@ "type": "structure", "members": { "attributes": { - "shape": "S2" + "shape": "Sf" }, "capabilities": { - "shape": "S4" + "shape": "Sh" }, "duration": { "type": "integer" @@ -74,7 +100,7 @@ } }, "tags": { - "shape": "Si" + "shape": "S3" } } }, @@ -84,13 +110,61 @@ "participantTokens": { "type": "list", "member": { - "shape": "Sa" + "shape": "Sn" } }, "stage": { - "shape": "Sn" + "shape": "Sx" + } + } + } + }, + "CreateStorageConfiguration": { + "http": { + "requestUri": "/CreateStorageConfiguration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "s3" + ], + "members": { + "name": {}, + "s3": { + "shape": "S11" + }, + "tags": { + "shape": "S3" } } + }, + "output": { + "type": "structure", + "members": { + "storageConfiguration": { + "shape": "S14" + } + } + } + }, + "DeleteEncoderConfiguration": { + "http": { + "requestUri": "/DeleteEncoderConfiguration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} } }, "DeleteStage": { @@ -112,6 +186,25 @@ "members": {} } }, + "DeleteStorageConfiguration": { + "http": { + "requestUri": "/DeleteStorageConfiguration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, "DisconnectParticipant": { "http": { "requestUri": "/DisconnectParticipant", @@ -134,6 +227,52 @@ "members": {} } }, + "GetComposition": { + "http": { + "requestUri": "/GetComposition", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "composition": { + "shape": "S1i" + } + } + } + }, + "GetEncoderConfiguration": { + "http": { + "requestUri": "/GetEncoderConfiguration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "encoderConfiguration": { + "shape": "Sc" + } + } + } + }, "GetParticipant": { "http": { "requestUri": "/GetParticipant", @@ -166,7 +305,7 @@ "browserName": {}, "browserVersion": {}, "firstJoinTime": { - "shape": "S10" + "shape": "S1v" }, "ispName": {}, "osName": {}, @@ -201,7 +340,7 @@ "type": "structure", "members": { "stage": { - "shape": "Sn" + "shape": "Sx" } } } @@ -229,17 +368,152 @@ "type": "structure", "members": { "endTime": { - "shape": "S10" + "shape": "S1v" }, "sessionId": {}, "startTime": { - "shape": "S10" + "shape": "S1v" } } } } } }, + "GetStorageConfiguration": { + "http": { + "requestUri": "/GetStorageConfiguration", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": { + "storageConfiguration": { + "shape": "S14" + } + } + } + }, + "ListCompositions": { + "http": { + "requestUri": "/ListCompositions", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "filterByEncoderConfigurationArn": {}, + "filterByStageArn": {}, + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "compositions" + ], + "members": { + "compositions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn", + "destinations", + "stageArn", + "state" + ], + "members": { + "arn": {}, + "destinations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "id", + "state" + ], + "members": { + "endTime": { + "shape": "S1v" + }, + "id": {}, + "startTime": { + "shape": "S1v" + }, + "state": {} + } + } + }, + "endTime": { + "shape": "S1v" + }, + "stageArn": {}, + "startTime": { + "shape": "S1v" + }, + "state": {}, + "tags": { + "shape": "S3" + } + } + } + }, + "nextToken": {} + } + } + }, + "ListEncoderConfigurations": { + "http": { + "requestUri": "/ListEncoderConfigurations", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "encoderConfigurations" + ], + "members": { + "encoderConfigurations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "name": {}, + "tags": { + "shape": "S3" + } + } + } + }, + "nextToken": {} + } + } + }, "ListParticipantEvents": { "http": { "requestUri": "/ListParticipantEvents", @@ -275,7 +549,7 @@ "members": { "errorCode": {}, "eventTime": { - "shape": "S10" + "shape": "S1v" }, "name": {}, "participantId": {}, @@ -325,7 +599,7 @@ "type": "structure", "members": { "firstJoinTime": { - "shape": "S10" + "shape": "S1v" }, "participantId": {}, "published": { @@ -370,11 +644,11 @@ "type": "structure", "members": { "endTime": { - "shape": "S10" + "shape": "S1v" }, "sessionId": {}, "startTime": { - "shape": "S10" + "shape": "S1v" } } } @@ -415,7 +689,50 @@ "arn": {}, "name": {}, "tags": { - "shape": "Si" + "shape": "S3" + } + } + } + } + } + } + }, + "ListStorageConfigurations": { + "http": { + "requestUri": "/ListStorageConfigurations", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "maxResults": { + "type": "integer" + }, + "nextToken": {} + } + }, + "output": { + "type": "structure", + "required": [ + "storageConfigurations" + ], + "members": { + "nextToken": {}, + "storageConfigurations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "name": {}, + "s3": { + "shape": "S11" + }, + "tags": { + "shape": "S3" } } } @@ -448,11 +765,69 @@ ], "members": { "tags": { - "shape": "Si" + "shape": "S3" + } + } + } + }, + "StartComposition": { + "http": { + "requestUri": "/StartComposition", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "destinations", + "stageArn" + ], + "members": { + "destinations": { + "type": "list", + "member": { + "shape": "S1l" + } + }, + "idempotencyToken": { + "idempotencyToken": true + }, + "layout": { + "shape": "S1x" + }, + "stageArn": {}, + "tags": { + "shape": "S3" + } + } + }, + "output": { + "type": "structure", + "members": { + "composition": { + "shape": "S1i" } } } }, + "StopComposition": { + "http": { + "requestUri": "/StopComposition", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + }, "TagResource": { "http": { "requestUri": "/tags/{resourceArn}", @@ -470,7 +845,7 @@ "locationName": "resourceArn" }, "tags": { - "shape": "Si" + "shape": "S3" } } }, @@ -529,30 +904,68 @@ "type": "structure", "members": { "stage": { - "shape": "Sn" + "shape": "Sx" } } } } }, "shapes": { - "S2": { + "S3": { + "type": "map", + "key": {}, + "value": {} + }, + "S6": { + "type": "structure", + "members": { + "bitrate": { + "type": "integer" + }, + "framerate": { + "type": "float" + }, + "height": { + "type": "integer" + }, + "width": { + "type": "integer" + } + } + }, + "Sc": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "name": {}, + "tags": { + "shape": "S3" + }, + "video": { + "shape": "S6" + } + } + }, + "Sf": { "type": "map", "key": {}, "value": {} }, - "S4": { + "Sh": { "type": "list", "member": {} }, - "Sa": { + "Sn": { "type": "structure", "members": { "attributes": { - "shape": "S2" + "shape": "Sf" }, "capabilities": { - "shape": "S4" + "shape": "Sh" }, "duration": { "type": "integer" @@ -569,12 +982,7 @@ "userId": {} } }, - "Si": { - "type": "map", - "key": {}, - "value": {} - }, - "Sn": { + "Sx": { "type": "structure", "required": [ "arn" @@ -584,13 +992,150 @@ "arn": {}, "name": {}, "tags": { - "shape": "Si" + "shape": "S3" } } }, - "S10": { + "S11": { + "type": "structure", + "required": [ + "bucketName" + ], + "members": { + "bucketName": {} + } + }, + "S14": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": {}, + "name": {}, + "s3": { + "shape": "S11" + }, + "tags": { + "shape": "S3" + } + } + }, + "S1i": { + "type": "structure", + "required": [ + "arn", + "destinations", + "layout", + "stageArn", + "state" + ], + "members": { + "arn": {}, + "destinations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "configuration", + "id", + "state" + ], + "members": { + "configuration": { + "shape": "S1l" + }, + "detail": { + "type": "structure", + "members": { + "s3": { + "type": "structure", + "required": [ + "recordingPrefix" + ], + "members": { + "recordingPrefix": {} + } + } + } + }, + "endTime": { + "shape": "S1v" + }, + "id": {}, + "startTime": { + "shape": "S1v" + }, + "state": {} + } + } + }, + "endTime": { + "shape": "S1v" + }, + "layout": { + "shape": "S1x" + }, + "stageArn": {}, + "startTime": { + "shape": "S1v" + }, + "state": {}, + "tags": { + "shape": "S3" + } + } + }, + "S1l": { + "type": "structure", + "members": { + "channel": { + "type": "structure", + "required": [ + "channelArn" + ], + "members": { + "channelArn": {}, + "encoderConfigurationArn": {} + } + }, + "name": {}, + "s3": { + "type": "structure", + "required": [ + "encoderConfigurationArns", + "storageConfigurationArn" + ], + "members": { + "encoderConfigurationArns": { + "type": "list", + "member": {} + }, + "recordingConfiguration": { + "type": "structure", + "members": { + "format": {} + } + }, + "storageConfigurationArn": {} + } + } + } + }, + "S1v": { "type": "timestamp", "timestampFormat": "iso8601" + }, + "S1x": { + "type": "structure", + "members": { + "grid": { + "type": "structure", + "members": { + "featuredParticipantAttribute": {} + } + } + } } } } \ No newline at end of file diff --git a/apis/ivs-realtime-2020-07-14.normal.json b/apis/ivs-realtime-2020-07-14.normal.json index 39b897c718..5ab93df0f1 100644 --- a/apis/ivs-realtime-2020-07-14.normal.json +++ b/apis/ivs-realtime-2020-07-14.normal.json @@ -13,6 +13,44 @@ "uid": "ivs-realtime-2020-07-14" }, "operations": { + "CreateEncoderConfiguration": { + "name": "CreateEncoderConfiguration", + "http": { + "method": "POST", + "requestUri": "/CreateEncoderConfiguration", + "responseCode": 200 + }, + "input": { + "shape": "CreateEncoderConfigurationRequest" + }, + "output": { + "shape": "CreateEncoderConfigurationResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "PendingVerification" + } + ], + "documentation": "Creates an EncoderConfiguration object.
" + }, "CreateParticipantToken": { "name": "CreateParticipantToken", "http": { @@ -74,18 +112,18 @@ ], "documentation": "Creates a new stage (and optionally participant tokens).
" }, - "DeleteStage": { - "name": "DeleteStage", + "CreateStorageConfiguration": { + "name": "CreateStorageConfiguration", "http": { "method": "POST", - "requestUri": "/DeleteStage", + "requestUri": "/CreateStorageConfiguration", "responseCode": 200 }, "input": { - "shape": "DeleteStageRequest" + "shape": "CreateStorageConfigurationRequest" }, "output": { - "shape": "DeleteStageResponse" + "shape": "CreateStorageConfigurationResponse" }, "errors": [ { @@ -97,6 +135,12 @@ { "shape": "AccessDeniedException" }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, { "shape": "ConflictException" }, @@ -104,20 +148,20 @@ "shape": "PendingVerification" } ], - "documentation": "Shuts down and deletes the specified stage (disconnecting all participants).
" + "documentation": "Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.
" }, - "DisconnectParticipant": { - "name": "DisconnectParticipant", + "DeleteEncoderConfiguration": { + "name": "DeleteEncoderConfiguration", "http": { "method": "POST", - "requestUri": "/DisconnectParticipant", + "requestUri": "/DeleteEncoderConfiguration", "responseCode": 200 }, "input": { - "shape": "DisconnectParticipantRequest" + "shape": "DeleteEncoderConfigurationRequest" }, "output": { - "shape": "DisconnectParticipantResponse" + "shape": "DeleteEncoderConfigurationResponse" }, "errors": [ { @@ -130,23 +174,29 @@ "shape": "AccessDeniedException" }, { - "shape": "PendingVerification" + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Disconnects a specified participant and revokes the participant permanently from a specified stage.
" + "documentation": "Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
" }, - "GetParticipant": { - "name": "GetParticipant", + "DeleteStage": { + "name": "DeleteStage", "http": { "method": "POST", - "requestUri": "/GetParticipant", + "requestUri": "/DeleteStage", "responseCode": 200 }, "input": { - "shape": "GetParticipantRequest" + "shape": "DeleteStageRequest" }, "output": { - "shape": "GetParticipantResponse" + "shape": "DeleteStageResponse" }, "errors": [ { @@ -157,22 +207,28 @@ }, { "shape": "AccessDeniedException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "PendingVerification" } ], - "documentation": "Gets information about the specified participant token.
" + "documentation": "Shuts down and deletes the specified stage (disconnecting all participants).
" }, - "GetStage": { - "name": "GetStage", + "DeleteStorageConfiguration": { + "name": "DeleteStorageConfiguration", "http": { "method": "POST", - "requestUri": "/GetStage", + "requestUri": "/DeleteStorageConfiguration", "responseCode": 200 }, "input": { - "shape": "GetStageRequest" + "shape": "DeleteStorageConfigurationRequest" }, "output": { - "shape": "GetStageResponse" + "shape": "DeleteStorageConfigurationResponse" }, "errors": [ { @@ -183,22 +239,31 @@ }, { "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Gets information for the specified stage.
" + "documentation": "Deletes the storage configuration for the specified ARN.
If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.
" }, - "GetStageSession": { - "name": "GetStageSession", + "DisconnectParticipant": { + "name": "DisconnectParticipant", "http": { "method": "POST", - "requestUri": "/GetStageSession", + "requestUri": "/DisconnectParticipant", "responseCode": 200 }, "input": { - "shape": "GetStageSessionRequest" + "shape": "DisconnectParticipantRequest" }, "output": { - "shape": "GetStageSessionResponse" + "shape": "DisconnectParticipantResponse" }, "errors": [ { @@ -209,70 +274,100 @@ }, { "shape": "AccessDeniedException" + }, + { + "shape": "PendingVerification" } ], - "documentation": "Gets information for the specified stage session.
" + "documentation": "Disconnects a specified participant and revokes the participant permanently from a specified stage.
" }, - "ListParticipantEvents": { - "name": "ListParticipantEvents", + "GetComposition": { + "name": "GetComposition", "http": { "method": "POST", - "requestUri": "/ListParticipantEvents", + "requestUri": "/GetComposition", "responseCode": 200 }, "input": { - "shape": "ListParticipantEventsRequest" + "shape": "GetCompositionRequest" }, "output": { - "shape": "ListParticipantEventsResponse" + "shape": "GetCompositionResponse" }, "errors": [ + { + "shape": "ResourceNotFoundException" + }, { "shape": "ValidationException" }, { "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Lists events for a specified participant that occurred during a specified stage session.
" + "documentation": "Get information about the specified Composition resource.
" }, - "ListParticipants": { - "name": "ListParticipants", + "GetEncoderConfiguration": { + "name": "GetEncoderConfiguration", "http": { "method": "POST", - "requestUri": "/ListParticipants", + "requestUri": "/GetEncoderConfiguration", "responseCode": 200 }, "input": { - "shape": "ListParticipantsRequest" + "shape": "GetEncoderConfigurationRequest" }, "output": { - "shape": "ListParticipantsResponse" + "shape": "GetEncoderConfigurationResponse" }, "errors": [ + { + "shape": "ResourceNotFoundException" + }, { "shape": "ValidationException" }, { "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Lists all participants in a specified stage session.
" + "documentation": "Gets information about the specified EncoderConfiguration resource.
" }, - "ListStageSessions": { - "name": "ListStageSessions", + "GetParticipant": { + "name": "GetParticipant", "http": { "method": "POST", - "requestUri": "/ListStageSessions", + "requestUri": "/GetParticipant", "responseCode": 200 }, "input": { - "shape": "ListStageSessionsRequest" + "shape": "GetParticipantRequest" }, "output": { - "shape": "ListStageSessionsResponse" + "shape": "GetParticipantResponse" }, "errors": [ + { + "shape": "ResourceNotFoundException" + }, { "shape": "ValidationException" }, @@ -280,46 +375,46 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets all sessions for a specified stage.
" + "documentation": "Gets information about the specified participant token.
" }, - "ListStages": { - "name": "ListStages", + "GetStage": { + "name": "GetStage", "http": { "method": "POST", - "requestUri": "/ListStages", + "requestUri": "/GetStage", "responseCode": 200 }, "input": { - "shape": "ListStagesRequest" + "shape": "GetStageRequest" }, "output": { - "shape": "ListStagesResponse" + "shape": "GetStageResponse" }, "errors": [ { - "shape": "ValidationException" + "shape": "ResourceNotFoundException" }, { - "shape": "AccessDeniedException" + "shape": "ValidationException" }, { - "shape": "ConflictException" + "shape": "AccessDeniedException" } ], - "documentation": "Gets summary information about all stages in your account, in the AWS region where the API request is processed.
" + "documentation": "Gets information for the specified stage.
" }, - "ListTagsForResource": { - "name": "ListTagsForResource", + "GetStageSession": { + "name": "GetStageSession", "http": { - "method": "GET", - "requestUri": "/tags/{resourceArn}", + "method": "POST", + "requestUri": "/GetStageSession", "responseCode": 200 }, "input": { - "shape": "ListTagsForResourceRequest" + "shape": "GetStageSessionRequest" }, "output": { - "shape": "ListTagsForResourceResponse" + "shape": "GetStageSessionResponse" }, "errors": [ { @@ -329,23 +424,23 @@ "shape": "ValidationException" }, { - "shape": "InternalServerException" + "shape": "AccessDeniedException" } ], - "documentation": "Gets information about AWS tags for the specified ARN.
" + "documentation": "Gets information for the specified stage session.
" }, - "TagResource": { - "name": "TagResource", + "GetStorageConfiguration": { + "name": "GetStorageConfiguration", "http": { "method": "POST", - "requestUri": "/tags/{resourceArn}", + "requestUri": "/GetStorageConfiguration", "responseCode": 200 }, "input": { - "shape": "TagResourceRequest" + "shape": "GetStorageConfigurationRequest" }, "output": { - "shape": "TagResourceResponse" + "shape": "GetStorageConfigurationResponse" }, "errors": [ { @@ -354,87 +449,586 @@ { "shape": "ValidationException" }, + { + "shape": "AccessDeniedException" + }, { "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Adds or updates tags for the AWS resource with the specified ARN.
" + "documentation": "Gets the storage configuration for the specified ARN.
" }, - "UntagResource": { - "name": "UntagResource", + "ListCompositions": { + "name": "ListCompositions", "http": { - "method": "DELETE", - "requestUri": "/tags/{resourceArn}", + "method": "POST", + "requestUri": "/ListCompositions", "responseCode": 200 }, "input": { - "shape": "UntagResourceRequest" + "shape": "ListCompositionsRequest" }, "output": { - "shape": "UntagResourceResponse" + "shape": "ListCompositionsResponse" }, "errors": [ { - "shape": "ResourceNotFoundException" + "shape": "ValidationException" }, { - "shape": "ValidationException" + "shape": "AccessDeniedException" }, { "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Removes tags from the resource with the specified ARN.
", - "idempotent": true + "documentation": "Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
" }, - "UpdateStage": { - "name": "UpdateStage", + "ListEncoderConfigurations": { + "name": "ListEncoderConfigurations", "http": { "method": "POST", - "requestUri": "/UpdateStage", + "requestUri": "/ListEncoderConfigurations", "responseCode": 200 }, "input": { - "shape": "UpdateStageRequest" + "shape": "ListEncoderConfigurationsRequest" }, "output": { - "shape": "UpdateStageResponse" + "shape": "ListEncoderConfigurationsResponse" }, "errors": [ - { - "shape": "ResourceNotFoundException" - }, { "shape": "ValidationException" }, { "shape": "AccessDeniedException" }, + { + "shape": "InternalServerException" + }, { "shape": "ServiceQuotaExceededException" }, { - "shape": "PendingVerification" + "shape": "ConflictException" } ], - "documentation": "Updates a stage’s configuration.
" - } - }, - "shapes": { - "CreateParticipantTokenRequest": { - "type": "structure", - "required": [ - "stageArn" - ], - "members": { - "attributes": { - "shape": "ParticipantTokenAttributes", - "documentation": "Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" - }, - "capabilities": { - "shape": "ParticipantTokenCapabilities", - "documentation": "Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE
.
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
" + }, + "ListParticipantEvents": { + "name": "ListParticipantEvents", + "http": { + "method": "POST", + "requestUri": "/ListParticipantEvents", + "responseCode": 200 + }, + "input": { + "shape": "ListParticipantEventsRequest" + }, + "output": { + "shape": "ListParticipantEventsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "documentation": "Lists events for a specified participant that occurred during a specified stage session.
" + }, + "ListParticipants": { + "name": "ListParticipants", + "http": { + "method": "POST", + "requestUri": "/ListParticipants", + "responseCode": 200 + }, + "input": { + "shape": "ListParticipantsRequest" + }, + "output": { + "shape": "ListParticipantsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "documentation": "Lists all participants in a specified stage session.
" + }, + "ListStageSessions": { + "name": "ListStageSessions", + "http": { + "method": "POST", + "requestUri": "/ListStageSessions", + "responseCode": 200 + }, + "input": { + "shape": "ListStageSessionsRequest" + }, + "output": { + "shape": "ListStageSessionsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + } + ], + "documentation": "Gets all sessions for a specified stage.
" + }, + "ListStages": { + "name": "ListStages", + "http": { + "method": "POST", + "requestUri": "/ListStages", + "responseCode": 200 + }, + "input": { + "shape": "ListStagesRequest" + }, + "output": { + "shape": "ListStagesResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Gets summary information about all stages in your account, in the AWS region where the API request is processed.
" + }, + "ListStorageConfigurations": { + "name": "ListStorageConfigurations", + "http": { + "method": "POST", + "requestUri": "/ListStorageConfigurations", + "responseCode": 200 + }, + "input": { + "shape": "ListStorageConfigurationsRequest" + }, + "output": { + "shape": "ListStorageConfigurationsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
" + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets information about AWS tags for the specified ARN.
" + }, + "StartComposition": { + "name": "StartComposition", + "http": { + "method": "POST", + "requestUri": "/StartComposition", + "responseCode": 200 + }, + "input": { + "shape": "StartCompositionRequest" + }, + "output": { + "shape": "StartCompositionResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "PendingVerification" + } + ], + "documentation": "Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted:
When StopComposition is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
" + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "TagResourceRequest" + }, + "output": { + "shape": "TagResourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Adds or updates tags for the AWS resource with the specified ARN.
" + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "output": { + "shape": "UntagResourceResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Removes tags from the resource with the specified ARN.
", + "idempotent": true + }, + "UpdateStage": { + "name": "UpdateStage", + "http": { + "method": "POST", + "requestUri": "/UpdateStage", + "responseCode": 200 + }, + "input": { + "shape": "UpdateStageRequest" + }, + "output": { + "shape": "UpdateStageResponse" + }, + "errors": [ + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "PendingVerification" + } + ], + "documentation": "Updates a stage’s configuration.
" + } + }, + "shapes": { + "AttributeKey": { + "type": "string", + "max": 128, + "min": 0, + "pattern": "^[a-zA-Z0-9-_]*$" + }, + "Bitrate": { + "type": "integer", + "box": true, + "max": 8500000, + "min": 1 + }, + "ChannelArn": { + "type": "string", + "max": 128, + "min": 1, + "pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$" + }, + "ChannelDestinationConfiguration": { + "type": "structure", + "required": [ + "channelArn" + ], + "members": { + "channelArn": { + "shape": "ChannelArn", + "documentation": "ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).
" + }, + "encoderConfigurationArn": { + "shape": "EncoderConfigurationArn", + "documentation": "ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
" + } + }, + "documentation": "Object specifying a channel as a destination.
" + }, + "Composition": { + "type": "structure", + "required": [ + "arn", + "destinations", + "layout", + "stageArn", + "state" + ], + "members": { + "arn": { + "shape": "CompositionArn", + "documentation": "ARN of the Composition resource.
" + }, + "destinations": { + "shape": "DestinationList", + "documentation": "Array of Destination objects. A Composition can contain either one destination (channel
or s3
) or two (one channel
and one s3
).
UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "layout": { + "shape": "LayoutConfiguration", + "documentation": "Layout object to configure composition parameters.
" + }, + "stageArn": { + "shape": "StageArn", + "documentation": "ARN of the stage used as input
" + }, + "startTime": { + "shape": "Time", + "documentation": "UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "state": { + "shape": "CompositionState", + "documentation": "State of the Composition.
" + }, + "tags": { + "shape": "Tags", + "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Object specifying a Composition resource.
" + }, + "CompositionArn": { + "type": "string", + "max": 128, + "min": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:composition/[a-zA-Z0-9-]+$" + }, + "CompositionClientToken": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "^[a-zA-Z0-9-_]*$" + }, + "CompositionState": { + "type": "string", + "enum": [ + "STARTING", + "ACTIVE", + "STOPPING", + "FAILED", + "STOPPED" + ] + }, + "CompositionSummary": { + "type": "structure", + "required": [ + "arn", + "destinations", + "stageArn", + "state" + ], + "members": { + "arn": { + "shape": "CompositionArn", + "documentation": "ARN of the Composition resource.
" + }, + "destinations": { + "shape": "DestinationSummaryList", + "documentation": "Array of Destination objects.
" + }, + "endTime": { + "shape": "Time", + "documentation": "UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "stageArn": { + "shape": "StageArn", + "documentation": "ARN of the attached stage.
" + }, + "startTime": { + "shape": "Time", + "documentation": "UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "state": { + "shape": "CompositionState", + "documentation": "State of the Composition resource.
" + }, + "tags": { + "shape": "Tags", + "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about a Composition.
" + }, + "CompositionSummaryList": { + "type": "list", + "member": { + "shape": "CompositionSummary" + } + }, + "CreateEncoderConfigurationRequest": { + "type": "structure", + "members": { + "name": { + "shape": "EncoderConfigurationName", + "documentation": "Optional name to identify the resource.
" + }, + "tags": { + "shape": "Tags", + "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.
" + } + } + }, + "CreateEncoderConfigurationResponse": { + "type": "structure", + "members": { + "encoderConfiguration": { + "shape": "EncoderConfiguration", + "documentation": "The EncoderConfiguration that was created.
" + } + } + }, + "CreateParticipantTokenRequest": { + "type": "structure", + "required": [ + "stageArn" + ], + "members": { + "attributes": { + "shape": "ParticipantTokenAttributes", + "documentation": "Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" + }, + "capabilities": { + "shape": "ParticipantTokenCapabilities", + "documentation": "Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE
.
Duration (in minutes), after which the token expires. Default: 720 (12 hours).
" @@ -488,6 +1082,51 @@ } } }, + "CreateStorageConfigurationRequest": { + "type": "structure", + "required": [ + "s3" + ], + "members": { + "name": { + "shape": "StorageConfigurationName", + "documentation": "Storage configuration name. The value does not need to be unique.
" + }, + "s3": { + "shape": "S3StorageConfiguration", + "documentation": "A complex type that contains a storage configuration for where recorded video will be stored.
" + }, + "tags": { + "shape": "Tags", + "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The StorageConfiguration that was created.
" + } + } + }, + "DeleteEncoderConfigurationRequest": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "EncoderConfigurationArn", + "documentation": "ARN of the EncoderConfiguration.
" + } + } + }, + "DeleteEncoderConfigurationResponse": { + "type": "structure", + "members": {} + }, "DeleteStageRequest": { "type": "structure", "required": [ @@ -504,6 +1143,152 @@ "type": "structure", "members": {} }, + "DeleteStorageConfigurationRequest": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "StorageConfigurationArn", + "documentation": "ARN of the storage configuration to be deleted.
" + } + } + }, + "DeleteStorageConfigurationResponse": { + "type": "structure", + "members": {} + }, + "Destination": { + "type": "structure", + "required": [ + "configuration", + "id", + "state" + ], + "members": { + "configuration": { + "shape": "DestinationConfiguration", + "documentation": "Configuration used to create this destination.
" + }, + "detail": { + "shape": "DestinationDetail", + "documentation": "Optional details regarding the status of the destination.
" + }, + "endTime": { + "shape": "Time", + "documentation": "UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "id": { + "shape": "String", + "documentation": "Unique identifier for this destination, assigned by IVS.
" + }, + "startTime": { + "shape": "Time", + "documentation": "UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "state": { + "shape": "DestinationState", + "documentation": "State of the Composition Destination.
" + } + }, + "documentation": "Object specifying the status of a Destination.
" + }, + "DestinationConfiguration": { + "type": "structure", + "members": { + "channel": { + "shape": "ChannelDestinationConfiguration", + "documentation": "An IVS channel to be used for broadcasting, for server-side composition. Either a channel
or an s3
must be specified.
Name that can be specified to help identify the destination.
" + }, + "s3": { + "shape": "S3DestinationConfiguration", + "documentation": "An S3 storage configuration to be used for recording video data. Either a channel
or an s3
must be specified.
Complex data type that defines destination-configuration objects.
" + }, + "DestinationConfigurationList": { + "type": "list", + "member": { + "shape": "DestinationConfiguration" + }, + "max": 2, + "min": 1 + }, + "DestinationConfigurationName": { + "type": "string", + "max": 128, + "min": 0, + "pattern": "^[a-zA-Z0-9-_]*$" + }, + "DestinationDetail": { + "type": "structure", + "members": { + "s3": { + "shape": "S3Detail", + "documentation": "An S3 detail object to return information about the S3 destination.
" + } + }, + "documentation": "Complex data type that defines destination-detail objects.
" + }, + "DestinationList": { + "type": "list", + "member": { + "shape": "Destination" + }, + "max": 2, + "min": 1 + }, + "DestinationState": { + "type": "string", + "enum": [ + "STARTING", + "ACTIVE", + "STOPPING", + "RECONNECTING", + "FAILED", + "STOPPED" + ] + }, + "DestinationSummary": { + "type": "structure", + "required": [ + "id", + "state" + ], + "members": { + "endTime": { + "shape": "Time", + "documentation": "UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "id": { + "shape": "String", + "documentation": "Unique identifier for this destination, assigned by IVS.
" + }, + "startTime": { + "shape": "Time", + "documentation": "UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "state": { + "shape": "DestinationState", + "documentation": "State of the Composition Destination.
" + } + }, + "documentation": "Summary information about a Destination.
" + }, + "DestinationSummaryList": { + "type": "list", + "member": { + "shape": "DestinationSummary" + }, + "max": 2, + "min": 1 + }, "DisconnectParticipantReason": { "type": "string", "max": 128, @@ -534,6 +1319,78 @@ "type": "structure", "members": {} }, + "EncoderConfiguration": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "EncoderConfigurationArn", + "documentation": "ARN of the EncoderConfiguration resource.
" + }, + "name": { + "shape": "EncoderConfigurationName", + "documentation": "Optional name to identify the resource.
" + }, + "tags": { + "shape": "Tags", + "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
" + } + }, + "documentation": "Settings for transcoding.
" + }, + "EncoderConfigurationArn": { + "type": "string", + "max": 128, + "min": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+$" + }, + "EncoderConfigurationArnList": { + "type": "list", + "member": { + "shape": "EncoderConfigurationArn" + }, + "max": 1, + "min": 1 + }, + "EncoderConfigurationName": { + "type": "string", + "max": 128, + "min": 0, + "pattern": "^[a-zA-Z0-9-_]*$" + }, + "EncoderConfigurationSummary": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "EncoderConfigurationArn", + "documentation": "ARN of the EncoderConfiguration resource.
" + }, + "name": { + "shape": "EncoderConfigurationName", + "documentation": "Optional name to identify the resource.
" + }, + "tags": { + "shape": "Tags", + "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about an EncoderConfiguration.
" + }, + "EncoderConfigurationSummaryList": { + "type": "list", + "member": { + "shape": "EncoderConfigurationSummary" + } + }, "Event": { "type": "structure", "members": { @@ -568,25 +1425,73 @@ "PUBLISHER_NOT_FOUND" ] }, - "EventList": { - "type": "list", - "member": { - "shape": "Event" + "EventList": { + "type": "list", + "member": { + "shape": "Event" + } + }, + "EventName": { + "type": "string", + "enum": [ + "JOINED", + "LEFT", + "PUBLISH_STARTED", + "PUBLISH_STOPPED", + "SUBSCRIBE_STARTED", + "SUBSCRIBE_STOPPED", + "PUBLISH_ERROR", + "SUBSCRIBE_ERROR", + "JOIN_ERROR" + ] + }, + "Framerate": { + "type": "float", + "box": true, + "max": 60, + "min": 1 + }, + "GetCompositionRequest": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "CompositionArn", + "documentation": "ARN of the Composition resource.
" + } + } + }, + "GetCompositionResponse": { + "type": "structure", + "members": { + "composition": { + "shape": "Composition", + "documentation": "The Composition that was returned.
" + } + } + }, + "GetEncoderConfigurationRequest": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "EncoderConfigurationArn", + "documentation": "ARN of the EncoderConfiguration resource.
" + } } }, - "EventName": { - "type": "string", - "enum": [ - "JOINED", - "LEFT", - "PUBLISH_STARTED", - "PUBLISH_STOPPED", - "SUBSCRIBE_STARTED", - "SUBSCRIBE_STOPPED", - "PUBLISH_ERROR", - "SUBSCRIBE_ERROR", - "JOIN_ERROR" - ] + "GetEncoderConfigurationResponse": { + "type": "structure", + "members": { + "encoderConfiguration": { + "shape": "EncoderConfiguration", + "documentation": "The EncoderConfiguration that was returned.
" + } + } }, "GetParticipantRequest": { "type": "structure", @@ -666,6 +1571,119 @@ } } }, + "GetStorageConfigurationRequest": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "StorageConfigurationArn", + "documentation": "ARN of the storage configuration to be retrieved.
" + } + } + }, + "GetStorageConfigurationResponse": { + "type": "structure", + "members": { + "storageConfiguration": { + "shape": "StorageConfiguration", + "documentation": "The StorageConfiguration that was returned.
" + } + } + }, + "GridConfiguration": { + "type": "structure", + "members": { + "featuredParticipantAttribute": { + "shape": "AttributeKey", + "documentation": "This attribute name identifies the featured slot. A participant with this attribute set to \"true\"
(as a string value) in ParticipantTokenConfiguration is placed in the featured slot.
Configuration information specific to Grid layout, for server-side composition. See \"Layouts\" in Server-Side Composition.
" + }, + "Height": { + "type": "integer", + "box": true, + "max": 1920, + "min": 1 + }, + "LayoutConfiguration": { + "type": "structure", + "members": { + "grid": { + "shape": "GridConfiguration", + "documentation": "Configuration related to grid layout. Default: Grid layout.
" + } + }, + "documentation": "Configuration information of supported layouts for server-side composition.
" + }, + "ListCompositionsRequest": { + "type": "structure", + "members": { + "filterByEncoderConfigurationArn": { + "shape": "EncoderConfigurationArn", + "documentation": "Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
" + }, + "filterByStageArn": { + "shape": "StageArn", + "documentation": "Filters the Composition list to match the specified Stage ARN.
" + }, + "maxResults": { + "shape": "MaxCompositionResults", + "documentation": "Maximum number of results to return. Default: 100.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "The first Composition to retrieve. This is used for pagination; see the nextToken
response field.
List of the matching Compositions (summary information only).
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "If there are more compositions than maxResults
, use nextToken
in the request to get the next set.
Maximum number of results to return. Default: 100.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "The first encoder configuration to retrieve. This is used for pagination; see the nextToken
response field.
List of the matching EncoderConfigurations (summary information only).
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "If there are more encoder configurations than maxResults
, use nextToken
in the request to get the next set.
The first participant to retrieve. This is used for pagination; see the nextToken
response field.
The first participant event to retrieve. This is used for pagination; see the nextToken
response field.
If there are more rooms than maxResults
, use nextToken
in the request to get the next set.
If there are more events than maxResults
, use nextToken
in the request to get the next set.
If there are more rooms than maxResults
, use nextToken
in the request to get the next set.
If there are more participants than maxResults
, use nextToken
in the request to get the next set.
The first stage to retrieve. This is used for pagination; see the nextToken
response field.
The first stage session to retrieve. This is used for pagination; see the nextToken
response field.
If there are more rooms than maxResults
, use nextToken
in the request to get the next set.
If there are more stage sessions than maxResults
, use nextToken
in the request to get the next set.
If there are more rooms than maxResults
, use nextToken
in the request to get the next set.
If there are more stages than maxResults
, use nextToken
in the request to get the next set.
Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.
" + }, + "nextToken": { + "shape": "PaginationToken", + "documentation": "The first storage configuration to retrieve. This is used for pagination; see the nextToken
response field.
If there are more storage configurations than maxResults
, use nextToken
in the request to get the next set.
List of the matching storage configurations.
" + } + } + }, "ListTagsForResourceRequest": { "type": "structure", "required": [ @@ -856,23 +1903,45 @@ } } }, + "MaxCompositionResults": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "MaxEncoderConfigurationResults": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, "MaxParticipantEventResults": { "type": "integer", + "box": true, "max": 100, "min": 1 }, "MaxParticipantResults": { "type": "integer", + "box": true, "max": 100, "min": 1 }, "MaxStageResults": { "type": "integer", + "box": true, "max": 100, "min": 1 }, "MaxStageSessionResults": { "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "MaxStorageConfigurationResults": { + "type": "integer", + "box": true, "max": 100, "min": 1 }, @@ -952,7 +2021,10 @@ "pattern": "^[a-zA-Z0-9-_.,:;\\s]*$" }, "ParticipantId": { - "type": "string" + "type": "string", + "max": 64, + "min": 0, + "pattern": "^[a-zA-Z0-9-]*$" }, "ParticipantList": { "type": "list", @@ -1083,6 +2155,7 @@ }, "ParticipantTokenDurationMinutes": { "type": "integer", + "box": true, "max": 20160, "min": 1 }, @@ -1111,12 +2184,82 @@ "Published": { "type": "boolean" }, + "RecordingConfiguration": { + "type": "structure", + "members": { + "format": { + "shape": "RecordingConfigurationFormat", + "documentation": "The recording format for storing a recording in Amazon S3.
" + } + }, + "documentation": "An object representing a configuration to record a stage stream.
" + }, + "RecordingConfigurationFormat": { + "type": "string", + "enum": [ + "HLS" + ] + }, "ResourceArn": { "type": "string", "max": 128, "min": 1, "pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" }, + "S3BucketName": { + "type": "string", + "max": 63, + "min": 3, + "pattern": "^[a-z0-9-.]+$" + }, + "S3DestinationConfiguration": { + "type": "structure", + "required": [ + "encoderConfigurationArns", + "storageConfigurationArn" + ], + "members": { + "encoderConfigurationArns": { + "shape": "EncoderConfigurationArnList", + "documentation": "ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
" + }, + "recordingConfiguration": { + "shape": "RecordingConfiguration", + "documentation": "Array of maps, each of the form string:string (key:value)
. This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.
ARN of the StorageConfiguration where recorded videos will be stored.
" + } + }, + "documentation": "A complex type that describes an S3 location where recorded videos will be stored.
" + }, + "S3Detail": { + "type": "structure", + "required": [ + "recordingPrefix" + ], + "members": { + "recordingPrefix": { + "shape": "String", + "documentation": "The S3 bucket prefix under which the recording is stored.
" + } + }, + "documentation": "Complex data type that defines S3Detail objects.
" + }, + "S3StorageConfiguration": { + "type": "structure", + "required": [ + "bucketName" + ], + "members": { + "bucketName": { + "shape": "S3BucketName", + "documentation": "Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.
" + } + }, + "documentation": "A complex type that describes an S3 location where recorded videos will be stored.
" + }, "Stage": { "type": "structure", "required": [ @@ -1233,6 +2376,129 @@ "shape": "StageSummary" } }, + "StartCompositionRequest": { + "type": "structure", + "required": [ + "destinations", + "stageArn" + ], + "members": { + "destinations": { + "shape": "DestinationConfigurationList", + "documentation": "Array of destination configuration.
" + }, + "idempotencyToken": { + "shape": "CompositionClientToken", + "documentation": "Idempotency token.
", + "idempotencyToken": true + }, + "layout": { + "shape": "LayoutConfiguration", + "documentation": "Layout object to configure composition parameters.
" + }, + "stageArn": { + "shape": "StageArn", + "documentation": "ARN of the stage to be used for compositing.
" + }, + "tags": { + "shape": "Tags", + "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The Composition that was created.
" + } + } + }, + "StopCompositionRequest": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "CompositionArn", + "documentation": "ARN of the Composition.
" + } + } + }, + "StopCompositionResponse": { + "type": "structure", + "members": {} + }, + "StorageConfiguration": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "StorageConfigurationArn", + "documentation": "ARN of the storage configuration.
" + }, + "name": { + "shape": "StorageConfigurationName", + "documentation": "Name of the storage configuration.
" + }, + "s3": { + "shape": "S3StorageConfiguration", + "documentation": "An S3 destination configuration where recorded videos will be stored.
" + }, + "tags": { + "shape": "Tags", + "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
A complex type that describes a location where recorded videos will be stored.
" + }, + "StorageConfigurationArn": { + "type": "string", + "max": 128, + "min": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$" + }, + "StorageConfigurationName": { + "type": "string", + "max": 128, + "min": 0, + "pattern": "^[a-zA-Z0-9-_]*$" + }, + "StorageConfigurationSummary": { + "type": "structure", + "required": [ + "arn" + ], + "members": { + "arn": { + "shape": "StorageConfigurationArn", + "documentation": "ARN of the storage configuration.
" + }, + "name": { + "shape": "StorageConfigurationName", + "documentation": "Name of the storage configuration.
" + }, + "s3": { + "shape": "S3StorageConfiguration", + "documentation": "An S3 destination configuration where recorded videos will be stored.
" + }, + "tags": { + "shape": "Tags", + "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Summary information about a storage configuration.
" + }, + "StorageConfigurationSummaryList": { + "type": "list", + "member": { + "shape": "StorageConfigurationSummary" + } + }, "String": { "type": "string" }, @@ -1346,7 +2612,35 @@ "type": "string", "max": 128, "min": 0 + }, + "Video": { + "type": "structure", + "members": { + "bitrate": { + "shape": "Bitrate", + "documentation": "Bitrate for generated output, in bps. Default: 2500000.
" + }, + "framerate": { + "shape": "Framerate", + "documentation": "Video frame rate, in fps. Default: 30.
" + }, + "height": { + "shape": "Height", + "documentation": "Video-resolution height. Note that the maximum value is determined by width
times height
, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
Video-resolution width. Note that the maximum value is determined by width
times height
, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
Settings for video.
" + }, + "Width": { + "type": "integer", + "box": true, + "max": 1920, + "min": 1 } }, - "documentation": "Introduction
The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Terminology:
A stage is a virtual space where participants can exchange video in real time.
A participant token is a token that authenticates a participant when they join a stage.
A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID There is a 1:1 mapping between participant tokens and participants.
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
Stage — A stage is a virtual space where participants can exchange video in real time.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature
to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
Stages Endpoints
CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
CreateStage — Creates a new stage (and optionally participant tokens).
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
GetParticipant — Gets information about the specified participant token.
GetStage — Gets information for the specified stage.
GetStageSession — Gets information for the specified stage session.
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
ListParticipants — Lists all participants in a specified stage session.
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
ListStageSessions — Gets all sessions for a specified stage.
UpdateStage — Updates a stage’s configuration.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
Introduction
The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Terminology:
A stage is a virtual space where participants can exchange video in real time.
A participant token is a token that authenticates a participant when they join a stage.
A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
Server-side composition: The composition process composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
Server-side composition: A composition controls the look of the outputs, including how participants are positioned in the video.
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
Stage — A stage is a virtual space where participants can exchange video in real time.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature
to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
Stages Endpoints
CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
CreateStage — Creates a new stage (and optionally participant tokens).
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
GetParticipant — Gets information about the specified participant token.
GetStage — Gets information for the specified stage.
GetStageSession — Gets information for the specified stage session.
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
ListParticipants — Lists all participants in a specified stage session.
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
ListStageSessions — Gets all sessions for a specified stage.
UpdateStage — Updates a stage’s configuration.
Composition Endpoints
GetComposition — Gets information about the specified Composition resource.
ListCompositions — Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
StartComposition — Starts a Composition from a stage based on the configuration provided in the request.
StopComposition — Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
EncoderConfiguration Endpoints
CreateEncoderConfiguration — Creates an EncoderConfiguration object.
DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
GetEncoderConfiguration — Gets information about the specified EncoderConfiguration resource.
ListEncoderConfigurations — Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
StorageConfiguration Endpoints
CreateStorageConfiguration — Creates a new storage configuration, used to enable recording to Amazon S3.
DeleteStorageConfiguration — Deletes the storage configuration for the specified ARN.
GetStorageConfiguration — Gets the storage configuration for the specified ARN.
ListStorageConfigurations — Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
This controls storage mode for supported storage tiers.
\n " + }, + "CustomerActionStatus": { + "shape": "CustomerActionStatus", + "locationName": "customerActionStatus", + "documentation": "\nDetermines if there is an action required from the customer.
\n " } }, "documentation": "\nReturns information about a cluster.
\n " @@ -2761,6 +2766,11 @@ "shape": "StorageMode", "locationName": "storageMode", "documentation": "\nThis controls storage mode for supported storage tiers.
\n " + }, + "CustomerActionStatus": { + "shape": "CustomerActionStatus", + "locationName": "customerActionStatus", + "documentation": "\nDetermines if there is an action required from the customer.
\n " } }, "required": [ @@ -3581,6 +3591,15 @@ }, "documentation": "\nReturns information about a cluster operation.
" }, + "CustomerActionStatus": { + "type": "string", + "documentation": "\nA type of an action required from the customer.
", + "enum": [ + "CRITICAL_ACTION_REQUIRED", + "ACTION_RECOMMENDED", + "NONE" + ] + }, "DeleteClusterRequest": { "type": "structure", "members": { diff --git a/apis/lambda-2015-03-31.min.json b/apis/lambda-2015-03-31.min.json index 87e8c49c9f..d841b882fa 100644 --- a/apis/lambda-2015-03-31.min.json +++ b/apis/lambda-2015-03-31.min.json @@ -307,11 +307,14 @@ }, "SnapStart": { "shape": "S3k" + }, + "LoggingConfig": { + "shape": "S3m" } } }, "output": { - "shape": "S3m" + "shape": "S3r" } }, "CreateFunctionUrlConfig": { @@ -336,7 +339,7 @@ }, "AuthType": {}, "Cors": { - "shape": "S4d" + "shape": "S4i" }, "InvokeMode": {} } @@ -354,7 +357,7 @@ "FunctionArn": {}, "AuthType": {}, "Cors": { - "shape": "S4d" + "shape": "S4i" }, "CreationTime": {}, "InvokeMode": {} @@ -738,7 +741,7 @@ "type": "structure", "members": { "Configuration": { - "shape": "S3m" + "shape": "S3r" }, "Code": { "type": "structure", @@ -753,7 +756,7 @@ "shape": "S34" }, "Concurrency": { - "shape": "S5d" + "shape": "S5i" } } } @@ -838,7 +841,7 @@ } }, "output": { - "shape": "S3m" + "shape": "S3r" } }, "GetFunctionEventInvokeConfig": { @@ -864,7 +867,7 @@ } }, "output": { - "shape": "S5l" + "shape": "S5q" } }, "GetFunctionUrlConfig": { @@ -903,7 +906,7 @@ "FunctionArn": {}, "AuthType": {}, "Cors": { - "shape": "S4d" + "shape": "S4i" }, "CreationTime": {}, "LastModifiedTime": {}, @@ -936,7 +939,7 @@ } }, "output": { - "shape": "S5r" + "shape": "S5w" } }, "GetLayerVersionByArn": { @@ -958,7 +961,7 @@ } }, "output": { - "shape": "S5r" + "shape": "S5w" } }, "GetLayerVersionPolicy": { @@ -1424,7 +1427,7 @@ "FunctionEventInvokeConfigs": { "type": "list", "member": { - "shape": "S5l" + "shape": "S5q" } }, "NextMarker": {} @@ -1481,7 +1484,7 @@ "CreationTime": {}, "LastModifiedTime": {}, "Cors": { - "shape": "S4d" + "shape": "S4i" }, "AuthType": {}, "InvokeMode": {} @@ -1525,7 +1528,7 @@ "members": { "NextMarker": {}, "Functions": { - "shape": "S7b" + "shape": "S7g" } } } @@ -1610,7 +1613,7 @@ "LayerVersions": { "type": "list", "member": { - "shape": "S7j" + "shape": "S7o" } } } @@ -1656,7 +1659,7 @@ "LayerName": {}, "LayerArn": {}, "LatestMatchingVersion": { - "shape": "S7j" + "shape": "S7o" } } } @@ -1777,7 +1780,7 @@ "members": { "NextMarker": {}, "Versions": { - "shape": "S7b" + "shape": "S7g" } } } @@ -1811,11 +1814,11 @@ } }, "CompatibleRuntimes": { - "shape": "S5u" + "shape": "S5z" }, "LicenseInfo": {}, "CompatibleArchitectures": { - "shape": "S5w" + "shape": "S61" } } }, @@ -1823,7 +1826,7 @@ "type": "structure", "members": { "Content": { - "shape": "S5s" + "shape": "S5x" }, "LayerArn": {}, "LayerVersionArn": {}, @@ -1833,11 +1836,11 @@ "type": "long" }, "CompatibleRuntimes": { - "shape": "S5u" + "shape": "S5z" }, "LicenseInfo": {}, "CompatibleArchitectures": { - "shape": "S5w" + "shape": "S61" } } } @@ -1863,7 +1866,7 @@ } }, "output": { - "shape": "S3m" + "shape": "S3r" } }, "PutFunctionCodeSigningConfig": { @@ -1921,7 +1924,7 @@ } }, "output": { - "shape": "S5d" + "shape": "S5i" } }, "PutFunctionEventInvokeConfig": { @@ -1956,7 +1959,7 @@ } }, "output": { - "shape": "S5l" + "shape": "S5q" } }, "PutProvisionedConcurrencyConfig": { @@ -2327,7 +2330,7 @@ } }, "output": { - "shape": "S3m" + "shape": "S3r" } }, "UpdateFunctionConfiguration": { @@ -2384,11 +2387,14 @@ }, "SnapStart": { "shape": "S3k" + }, + "LoggingConfig": { + "shape": "S3m" } } }, "output": { - "shape": "S3m" + "shape": "S3r" } }, "UpdateFunctionEventInvokeConfig": { @@ -2422,7 +2428,7 @@ } }, "output": { - "shape": "S5l" + "shape": "S5q" } }, "UpdateFunctionUrlConfig": { @@ -2447,7 +2453,7 @@ }, "AuthType": {}, "Cors": { - "shape": "S4d" + "shape": "S4i" }, "InvokeMode": {} } @@ -2466,7 +2472,7 @@ "FunctionArn": {}, "AuthType": {}, "Cors": { - "shape": "S4d" + "shape": "S4i" }, "CreationTime": {}, "LastModifiedTime": {}, @@ -2826,6 +2832,15 @@ } }, "S3m": { + "type": "structure", + "members": { + "LogFormat": {}, + "ApplicationLogLevel": {}, + "SystemLogLevel": {}, + "LogGroup": {} + } + }, + "S3r": { "type": "structure", "members": { "FunctionName": {}, @@ -2875,7 +2890,7 @@ "members": { "ErrorCode": {}, "Message": { - "shape": "S3u" + "shape": "S3z" } } } @@ -2925,7 +2940,7 @@ "members": { "ErrorCode": {}, "Message": { - "shape": "S3u" + "shape": "S3z" } } } @@ -2955,26 +2970,29 @@ "members": { "ErrorCode": {}, "Message": { - "shape": "S3u" + "shape": "S3z" } } } } + }, + "LoggingConfig": { + "shape": "S3m" } } }, - "S3u": { + "S3z": { "type": "string", "sensitive": true }, - "S4d": { + "S4i": { "type": "structure", "members": { "AllowCredentials": { "type": "boolean" }, "AllowHeaders": { - "shape": "S4f" + "shape": "S4k" }, "AllowMethods": { "type": "list", @@ -2985,18 +3003,18 @@ "member": {} }, "ExposeHeaders": { - "shape": "S4f" + "shape": "S4k" }, "MaxAge": { "type": "integer" } } }, - "S4f": { + "S4k": { "type": "list", "member": {} }, - "S5d": { + "S5i": { "type": "structure", "members": { "ReservedConcurrentExecutions": { @@ -3004,7 +3022,7 @@ } } }, - "S5l": { + "S5q": { "type": "structure", "members": { "LastModified": { @@ -3022,11 +3040,11 @@ } } }, - "S5r": { + "S5w": { "type": "structure", "members": { "Content": { - "shape": "S5s" + "shape": "S5x" }, "LayerArn": {}, "LayerVersionArn": {}, @@ -3036,15 +3054,15 @@ "type": "long" }, "CompatibleRuntimes": { - "shape": "S5u" + "shape": "S5z" }, "LicenseInfo": {}, "CompatibleArchitectures": { - "shape": "S5w" + "shape": "S61" } } }, - "S5s": { + "S5x": { "type": "structure", "members": { "Location": {}, @@ -3056,21 +3074,21 @@ "SigningJobArn": {} } }, - "S5u": { + "S5z": { "type": "list", "member": {} }, - "S5w": { + "S61": { "type": "list", "member": {} }, - "S7b": { + "S7g": { "type": "list", "member": { - "shape": "S3m" + "shape": "S3r" } }, - "S7j": { + "S7o": { "type": "structure", "members": { "LayerVersionArn": {}, @@ -3080,11 +3098,11 @@ "Description": {}, "CreatedDate": {}, "CompatibleRuntimes": { - "shape": "S5u" + "shape": "S5z" }, "LicenseInfo": {}, "CompatibleArchitectures": { - "shape": "S5w" + "shape": "S61" } } } diff --git a/apis/lambda-2015-03-31.normal.json b/apis/lambda-2015-03-31.normal.json index 8b6625fb14..4668998e65 100644 --- a/apis/lambda-2015-03-31.normal.json +++ b/apis/lambda-2015-03-31.normal.json @@ -1127,7 +1127,7 @@ "shape": "ResourceConflictException" } ], - "documentation": "For asynchronous function invocation, use Invoke.
Invokes a function asynchronously.
If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on.
For asynchronous function invocation, use Invoke.
Invokes a function asynchronously.
", "deprecated": true }, "InvokeWithResponseStream": { @@ -2448,6 +2448,17 @@ }, "documentation": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
" }, + "ApplicationLogLevel": { + "type": "string", + "enum": [ + "TRACE", + "DEBUG", + "INFO", + "WARN", + "ERROR", + "FATAL" + ] + }, "Architecture": { "type": "string", "enum": [ @@ -2872,11 +2883,15 @@ }, "EphemeralStorage": { "shape": "EphemeralStorage", - "documentation": "The size of the function's /tmp
directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
The size of the function's /tmp
directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB.
The function's SnapStart setting.
" + }, + "LoggingConfig": { + "shape": "LoggingConfig", + "documentation": "The function's Amazon CloudWatch Logs configuration settings.
" } } }, @@ -3295,7 +3310,7 @@ "documentation": "The size of the function's /tmp
directory.
The size of the function's /tmp
directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
The size of the function's /tmp
directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
The size of the function's /tmp
directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
The size of the function’s /tmp
directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
The ARN of the runtime and any errors that occured.
" + }, + "LoggingConfig": { + "shape": "LoggingConfig", + "documentation": "The function's Amazon CloudWatch Logs configuration settings.
" } }, "documentation": "Details about a function's configuration.
" @@ -5343,6 +5362,19 @@ "max": 160, "pattern": "^/mnt/[a-zA-Z0-9-_.]+$" }, + "LogFormat": { + "type": "string", + "enum": [ + "JSON", + "Text" + ] + }, + "LogGroup": { + "type": "string", + "max": 512, + "min": 1, + "pattern": "[\\.\\-_/#A-Za-z0-9]+" + }, "LogType": { "type": "string", "enum": [ @@ -5350,6 +5382,28 @@ "Tail" ] }, + "LoggingConfig": { + "type": "structure", + "members": { + "LogFormat": { + "shape": "LogFormat", + "documentation": "The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
" + }, + "ApplicationLogLevel": { + "shape": "ApplicationLogLevel", + "documentation": "Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level and lower.
" + }, + "SystemLogLevel": { + "shape": "SystemLogLevel", + "documentation": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level and lower.
" + }, + "LogGroup": { + "shape": "LogGroup", + "documentation": "The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>
. To use a different log group, enter an existing log group or enter a new log group name.
The function's Amazon CloudWatch Logs configuration settings.
" + }, "Long": { "type": "long" }, @@ -6249,6 +6303,14 @@ }, "max": 16 }, + "SystemLogLevel": { + "type": "string", + "enum": [ + "DEBUG", + "INFO", + "WARN" + ] + }, "TagKey": { "type": "string" }, @@ -6646,11 +6708,15 @@ }, "EphemeralStorage": { "shape": "EphemeralStorage", - "documentation": "The size of the function's /tmp
directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
The size of the function's /tmp
directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB.
The function's SnapStart setting.
" + }, + "LoggingConfig": { + "shape": "LoggingConfig", + "documentation": "The function's Amazon CloudWatch Logs configuration settings.
" } } }, diff --git a/apis/macie2-2020-01-01.min.json b/apis/macie2-2020-01-01.min.json index 6d27f33e0b..04c15ce2e5 100644 --- a/apis/macie2-2020-01-01.min.json +++ b/apis/macie2-2020-01-01.min.json @@ -2345,6 +2345,10 @@ "configuration": { "shape": "S7d", "locationName": "configuration" + }, + "retrievalConfiguration": { + "shape": "S7g", + "locationName": "retrievalConfiguration" } } } @@ -2455,11 +2459,11 @@ "locationName": "description" }, "excludes": { - "shape": "S7u", + "shape": "S7x", "locationName": "excludes" }, "includes": { - "shape": "S7v", + "shape": "S7y", "locationName": "includes" }, "name": { @@ -2702,11 +2706,11 @@ "type": "structure", "members": { "excludes": { - "shape": "S8o", + "shape": "S8r", "locationName": "excludes" }, "includes": { - "shape": "S8o", + "shape": "S8r", "locationName": "includes" } } @@ -3413,11 +3417,11 @@ "type": "structure", "members": { "excludes": { - "shape": "Sac", + "shape": "Saf", "locationName": "excludes" }, "includes": { - "shape": "Sac", + "shape": "Saf", "locationName": "includes" } } @@ -3961,6 +3965,21 @@ "configuration": { "shape": "S7d", "locationName": "configuration" + }, + "retrievalConfiguration": { + "locationName": "retrievalConfiguration", + "type": "structure", + "members": { + "retrievalMode": { + "locationName": "retrievalMode" + }, + "roleName": { + "locationName": "roleName" + } + }, + "required": [ + "retrievalMode" + ] } }, "required": [ @@ -3973,6 +3992,10 @@ "configuration": { "shape": "S7d", "locationName": "configuration" + }, + "retrievalConfiguration": { + "shape": "S7g", + "locationName": "retrievalConfiguration" } } } @@ -3990,7 +4013,7 @@ "locationName": "description" }, "excludes": { - "shape": "S7u", + "shape": "S7x", "locationName": "excludes" }, "id": { @@ -3998,7 +4021,7 @@ "locationName": "id" }, "includes": { - "shape": "S7v", + "shape": "S7y", "locationName": "includes" } }, @@ -4775,7 +4798,24 @@ "status" ] }, - "S7u": { + "S7g": { + "type": "structure", + "members": { + "externalId": { + "locationName": "externalId" + }, + "retrievalMode": { + "locationName": "retrievalMode" + }, + "roleName": { + "locationName": "roleName" + } + }, + "required": [ + "retrievalMode" + ] + }, + "S7x": { "type": "structure", "members": { "managedDataIdentifierIds": { @@ -4784,7 +4824,7 @@ } } }, - "S7v": { + "S7y": { "type": "structure", "members": { "allowListIds": { @@ -4801,7 +4841,7 @@ } } }, - "S8o": { + "S8r": { "type": "list", "member": { "type": "structure", @@ -4819,7 +4859,7 @@ } } }, - "Sac": { + "Saf": { "type": "structure", "members": { "and": { diff --git a/apis/macie2-2020-01-01.normal.json b/apis/macie2-2020-01-01.normal.json index b8dec3b0bd..b0d2e9790c 100644 --- a/apis/macie2-2020-01-01.normal.json +++ b/apis/macie2-2020-01-01.normal.json @@ -4405,7 +4405,7 @@ "managedDataIdentifierSelector": { "shape": "ManagedDataIdentifierSelector", "locationName": "managedDataIdentifierSelector", - "documentation": "The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.
RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.
For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.
" + "documentation": "The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.
RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.
For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.
" }, "name": { "shape": "__string", @@ -5197,7 +5197,7 @@ "value": { "shape": "__stringMin1Max128", "locationName": "value", - "documentation": "An occurrence of the specified type of sensitive data. Each occurrence can contain 1-128 characters.
" + "documentation": "An occurrence of the specified type of sensitive data. Each occurrence contains 1-128 characters.
" } }, "documentation": "Specifies 1-10 occurrences of a specific type of sensitive data reported by a finding.
", @@ -6177,7 +6177,7 @@ "updatedAt": { "shape": "__timestampIso8601", "locationName": "updatedAt", - "documentation": "The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.
" + "documentation": "The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status or configuration settings for the Amazon Macie account.
" } } }, @@ -6308,7 +6308,12 @@ "configuration": { "shape": "RevealConfiguration", "locationName": "configuration", - "documentation": "The current configuration settings and the status of the configuration for the account.
" + "documentation": "The KMS key that's used to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.
" + }, + "retrievalConfiguration": { + "shape": "RetrievalConfiguration", + "locationName": "retrievalConfiguration", + "documentation": "The access method and settings that are used to retrieve the sensitive data.
" } } }, @@ -6337,7 +6342,7 @@ "reasons": { "shape": "__listOfUnavailabilityReasonCode", "locationName": "reasons", - "documentation": "Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:
INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the classificationDetails.detailedResultsLocation field of the finding isn't available, is malformed or corrupted, or uses an unsupported storage format.
OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.
OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might have been renamed, moved, or deleted. Or the object was changed after Macie created the finding.
UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding.
UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn't support for retrieving occurrences of sensitive data.
This value is null if sensitive data can be retrieved for the finding.
" + "documentation": "Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:
ACCOUNT_NOT_IN_ORGANIZATION - The affected account isn't currently part of your organization. Or the account is part of your organization but Macie isn't currently enabled for the account. You're not allowed to access the affected S3 object by using Macie.
INVALID_CLASSIFICATION_RESULT - There isn't a corresponding sensitive data discovery result for the finding. Or the corresponding sensitive data discovery result isn't available, is malformed or corrupted, or uses an unsupported storage format. Macie can't verify the location of the sensitive data to retrieve.
INVALID_RESULT_SIGNATURE - The corresponding sensitive data discovery result is stored in an S3 object that wasn't signed by Macie. Macie can't verify the integrity and authenticity of the sensitive data discovery result. Therefore, Macie can't verify the location of the sensitive data to retrieve.
MEMBER_ROLE_TOO_PERMISSIVE - The affected member account is configured to retrieve occurrences of sensitive data by using an IAM role whose trust or permissions policy doesn't meet Macie requirements for restricting access to the role. Or the role's trust policy doesn't specify the correct external ID. Macie can't assume the role to retrieve the sensitive data.
MISSING_GET_MEMBER_PERMISSION - You're not allowed to retrieve information about the association between your account and the affected account. Macie can't determine whether you’re allowed to access the affected S3 object as the delegated Macie administrator for the affected account.
OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data from this type of file.
OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object was renamed, moved, or deleted. Or the object was changed after Macie created the finding.
RESULT_NOT_SIGNED - The corresponding sensitive data discovery result is stored in an S3 object that hasn't been signed. Macie can't verify the integrity and authenticity of the sensitive data discovery result. Therefore, Macie can't verify the location of the sensitive data to retrieve.
ROLE_TOO_PERMISSIVE - Your account is configured to retrieve occurrences of sensitive data by using an IAM role whose trust or permissions policy doesn't meet Macie requirements for restricting access to the role. Macie can’t assume the role to retrieve the sensitive data.
UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding.
UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn't support for retrieving occurrences of sensitive data.
This value is null if sensitive data can be retrieved for the finding.
" } } }, @@ -6405,7 +6410,7 @@ "includes": { "shape": "SensitivityInspectionTemplateIncludes", "locationName": "includes", - "documentation": "The allow lists, custom data identifiers, and managed data identifiers that are included (used) when analyzing data.
" + "documentation": "The allow lists, custom data identifiers, and managed data identifiers that are explicitly included (used) when analyzing data.
" }, "name": { "shape": "__string", @@ -7845,7 +7850,7 @@ "jsonPath": { "shape": "__string", "locationName": "jsonPath", - "documentation": "The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.
If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.
" + "documentation": "The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.
If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 240 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.
" }, "recordIndex": { "shape": "__long", @@ -7955,7 +7960,7 @@ "totalItemsSkipped": { "shape": "__long", "locationName": "totalItemsSkipped", - "documentation": "The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to analyze for reasons reported by other statistics in the ResourceStatistics object.
" + "documentation": "The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue or error. For example, an object is a malformed file. This value includes objects that Macie wasn't able to analyze for reasons reported by other statistics in the ResourceStatistics object.
" }, "totalItemsSkippedInvalidEncryption": { "shape": "__long", @@ -7991,13 +7996,45 @@ }, "documentation": "Provides information about the resources that a finding applies to.
" }, + "RetrievalConfiguration": { + "type": "structure", + "members": { + "externalId": { + "shape": "__string", + "locationName": "externalId", + "documentation": "The external ID to specify in the trust policy for the IAM role to assume when retrieving sensitive data from affected S3 objects (roleName). The trust policy must include an sts:ExternalId condition that requires this ID.
This ID is a unique alphanumeric string that Amazon Macie generates automatically after you configure it to assume a role. This value is null if the value for retrievalMode is CALLER_CREDENTIALS.
" + }, + "retrievalMode": { + "shape": "RetrievalMode", + "locationName": "retrievalMode", + "documentation": "The access method that's used when retrieving sensitive data from affected S3 objects. Valid values are: ASSUME_ROLE, assume an IAM role that is in the affected Amazon Web Services account and delegates access to Amazon Macie (roleName); and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data.
" + }, + "roleName": { + "shape": "__stringMin1Max64PatternW", + "locationName": "roleName", + "documentation": "The name of the IAM role that is in the affected Amazon Web Services account and Amazon Macie is allowed to assume when retrieving sensitive data from affected S3 objects for the account. This value is null if the value for retrievalMode is CALLER_CREDENTIALS.
" + } + }, + "documentation": "Provides information about the access method and settings that are used to retrieve occurrences of sensitive data reported by findings.
", + "required": [ + "retrievalMode" + ] + }, + "RetrievalMode": { + "type": "string", + "documentation": "The access method to use when retrieving occurrences of sensitive data reported by findings. Valid values are:
", + "enum": [ + "CALLER_CREDENTIALS", + "ASSUME_ROLE" + ] + }, "RevealConfiguration": { "type": "structure", "members": { "kmsKeyId": { "shape": "__stringMin1Max2048", "locationName": "kmsKeyId", - "documentation": "The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that's retrieved. The key must be an existing, customer managed, symmetric encryption key that's in the same Amazon Web Services Region as the Amazon Macie account.
If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that's owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key's alias.
" + "documentation": "The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that's retrieved. The key must be an existing, customer managed, symmetric encryption key that's enabled in the same Amazon Web Services Region as the Amazon Macie account.
If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that's owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key's alias.
" }, "status": { "shape": "RevealStatus", @@ -8005,7 +8042,7 @@ "documentation": "The status of the configuration for the Amazon Macie account. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account. In a response, possible values are: ENABLED, the configuration is currently enabled for the account; and, DISABLED, the configuration is currently disabled for the account.
" } }, - "documentation": "Specifies the configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account. When you enable the configuration for the first time, your request must specify an Key Management Service (KMS) key. Otherwise, an error occurs. Macie uses the specified key to encrypt the sensitive data that you retrieve.
", + "documentation": "Specifies the status of the Amazon Macie configuration for retrieving occurrences of sensitive data reported by findings, and the Key Management Service (KMS) key to use to encrypt sensitive data that's retrieved. When you enable the configuration for the first time, your request must specify an KMS key. Otherwise, an error occurs.
", "required": [ "status" ] @@ -8208,7 +8245,7 @@ "kmsKeyArn": { "shape": "__string", "locationName": "kmsKeyArn", - "documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key to use for encryption of the results. This must be the ARN of an existing, symmetric encryption KMS key that's in the same Amazon Web Services Region as the bucket.
" + "documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key to use for encryption of the results. This must be the ARN of an existing, symmetric encryption KMS key that's enabled in the same Amazon Web Services Region as the bucket.
" } }, "documentation": "Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.
", @@ -8874,7 +8911,7 @@ "comparator": { "shape": "JobComparator", "locationName": "comparator", - "documentation": "The operator to use in the condition. Valid values for each supported property (key) are:
OBJECT_EXTENSION - EQ (equals) or NE (not equals)
OBJECT_KEY - STARTS_WITH
OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
OBJECT_SIZE - Any operator except CONTAINS
The operator to use in the condition. Valid values for each supported property (key) are:
OBJECT_EXTENSION - EQ (equals) or NE (not equals)
OBJECT_KEY - STARTS_WITH
OBJECT_LAST_MODIFIED_DATE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)
OBJECT_SIZE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)
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 OR logic to join the values. Otherwise, this array can specify only one value.
Valid values for each supported property (key) are:
OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
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.
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
OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
" + "documentation": "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 OR logic to join the values. Otherwise, this array can specify only one value.
Valid values for each supported property (key) are:
OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
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.
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: 2023-09-24T14:31:13Z
OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
" } }, "documentation": "Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.
" @@ -9140,7 +9177,13 @@ "UNSUPPORTED_OBJECT_TYPE", "UNSUPPORTED_FINDING_TYPE", "INVALID_CLASSIFICATION_RESULT", - "OBJECT_UNAVAILABLE" + "OBJECT_UNAVAILABLE", + "ACCOUNT_NOT_IN_ORGANIZATION", + "MISSING_GET_MEMBER_PERMISSION", + "ROLE_TOO_PERMISSIVE", + "MEMBER_ROLE_TOO_PERMISSIVE", + "INVALID_RESULT_SIGNATURE", + "RESULT_NOT_SIGNED" ] }, "Unit": { @@ -9471,13 +9514,37 @@ "type": "structure", "members": {} }, + "UpdateRetrievalConfiguration": { + "type": "structure", + "members": { + "retrievalMode": { + "shape": "RetrievalMode", + "locationName": "retrievalMode", + "documentation": "The access method to use when retrieving sensitive data from affected S3 objects. Valid values are: ASSUME_ROLE, assume an IAM role that is in the affected Amazon Web Services account and delegates access to Amazon Macie; and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data. If you specify ASSUME_ROLE, also specify the name of an existing IAM role for Macie to assume (roleName).
If you change this value from ASSUME_ROLE to CALLER_CREDENTIALS for an existing configuration, Macie permanently deletes the external ID and role name currently specified for the configuration. These settings can't be recovered after they're deleted.
The name of the IAM role that is in the affected Amazon Web Services account and Amazon Macie is allowed to assume when retrieving sensitive data from affected S3 objects for the account. The trust and permissions policies for the role must meet all requirements for Macie to assume the role.
" + } + }, + "documentation": "Specifies the access method and settings to use when retrieving occurrences of sensitive data reported by findings. If your request specifies an Identity and Access Management (IAM) role to assume when retrieving the sensitive data, Amazon Macie verifies that the role exists and the attached policies are configured correctly. If there's an issue, Macie returns an error. For information about addressing the issue, see Retrieving sensitive data samples with findings in the Amazon Macie User Guide.
", + "required": [ + "retrievalMode" + ] + }, "UpdateRevealConfigurationRequest": { "type": "structure", "members": { "configuration": { "shape": "RevealConfiguration", "locationName": "configuration", - "documentation": "The new configuration settings and the status of the configuration for the account.
" + "documentation": "The KMS key to use to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.
" + }, + "retrievalConfiguration": { + "shape": "UpdateRetrievalConfiguration", + "locationName": "retrievalConfiguration", + "documentation": "The access method and settings to use to retrieve the sensitive data.
" } }, "required": [ @@ -9490,7 +9557,12 @@ "configuration": { "shape": "RevealConfiguration", "locationName": "configuration", - "documentation": "The new configuration settings and the status of the configuration for the account.
" + "documentation": "The KMS key to use to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.
" + }, + "retrievalConfiguration": { + "shape": "RetrievalConfiguration", + "locationName": "retrievalConfiguration", + "documentation": "The access method and settings to use to retrieve the sensitive data.
" } } }, @@ -9516,7 +9588,7 @@ "includes": { "shape": "SensitivityInspectionTemplateIncludes", "locationName": "includes", - "documentation": "The allow lists, custom data identifiers, and managed data identifiers to include (use) when analyzing data.
" + "documentation": "The allow lists, custom data identifiers, and managed data identifiers to explicitly include (use) when analyzing data.
" } }, "required": [ @@ -10052,6 +10124,12 @@ "max": 512, "pattern": "^[\\s\\S]+$" }, + "__stringMin1Max64PatternW": { + "type": "string", + "min": 1, + "max": 64, + "pattern": "^[\\w+=,.@-]*$" + }, "__stringMin22Max22PatternAZ0922": { "type": "string", "min": 22, diff --git a/apis/mediapackage-2017-10-12.normal.json b/apis/mediapackage-2017-10-12.normal.json index 80c64043d6..321a857360 100644 --- a/apis/mediapackage-2017-10-12.normal.json +++ b/apis/mediapackage-2017-10-12.normal.json @@ -1225,7 +1225,7 @@ "shape": "__boolean" }, "ManifestLayout": { - "documentation": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.", + "documentation": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. When set to DRM_TOP_LEVEL_COMPACT, content protection elements are placed the MPD level and referenced at the AdaptationSet level.", "locationName": "manifestLayout", "shape": "ManifestLayout" }, @@ -2017,7 +2017,8 @@ "ManifestLayout": { "enum": [ "FULL", - "COMPACT" + "COMPACT", + "DRM_TOP_LEVEL_COMPACT" ], "type": "string" }, diff --git a/apis/pinpoint-sms-voice-v2-2022-03-31.min.json b/apis/pinpoint-sms-voice-v2-2022-03-31.min.json index c21cff1207..5bf7cfb952 100644 --- a/apis/pinpoint-sms-voice-v2-2022-03-31.min.json +++ b/apis/pinpoint-sms-voice-v2-2022-03-31.min.json @@ -174,6 +174,7 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, @@ -193,6 +194,194 @@ } } }, + "CreateRegistration": { + "input": { + "type": "structure", + "required": [ + "RegistrationType" + ], + "members": { + "RegistrationType": {}, + "Tags": { + "shape": "Sa" + }, + "ClientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationStatus", + "CurrentVersionNumber", + "CreatedTimestamp" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "RegistrationType": {}, + "RegistrationStatus": {}, + "CurrentVersionNumber": { + "type": "long" + }, + "AdditionalAttributes": { + "shape": "S19" + }, + "Tags": { + "shape": "Sa" + }, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, + "CreateRegistrationAssociation": { + "input": { + "type": "structure", + "required": [ + "RegistrationId", + "ResourceId" + ], + "members": { + "RegistrationId": {}, + "ResourceId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "ResourceArn", + "ResourceId", + "ResourceType" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "RegistrationType": {}, + "ResourceArn": {}, + "ResourceId": {}, + "ResourceType": {}, + "IsoCountryCode": {}, + "PhoneNumber": {} + } + } + }, + "CreateRegistrationAttachment": { + "input": { + "type": "structure", + "members": { + "AttachmentBody": { + "type": "blob" + }, + "AttachmentUrl": {}, + "Tags": { + "shape": "Sa" + }, + "ClientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationAttachmentArn", + "RegistrationAttachmentId", + "AttachmentStatus", + "CreatedTimestamp" + ], + "members": { + "RegistrationAttachmentArn": {}, + "RegistrationAttachmentId": {}, + "AttachmentStatus": {}, + "Tags": { + "shape": "Sa" + }, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, + "CreateRegistrationVersion": { + "input": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "VersionNumber": { + "type": "long" + }, + "RegistrationVersionStatus": {}, + "RegistrationVersionStatusHistory": { + "shape": "S1n" + } + } + } + }, + "CreateVerifiedDestinationNumber": { + "input": { + "type": "structure", + "required": [ + "DestinationPhoneNumber" + ], + "members": { + "DestinationPhoneNumber": {}, + "Tags": { + "shape": "Sa" + }, + "ClientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "Status", + "CreatedTimestamp" + ], + "members": { + "VerifiedDestinationNumberArn": {}, + "VerifiedDestinationNumberId": {}, + "DestinationPhoneNumber": {}, + "Status": {}, + "Tags": { + "shape": "Sa" + }, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, "DeleteConfigurationSet": { "input": { "type": "structure", @@ -209,7 +398,7 @@ "ConfigurationSetArn": {}, "ConfigurationSetName": {}, "EventDestinations": { - "shape": "S16" + "shape": "S1t" }, "DefaultMessageType": {}, "DefaultSenderId": {}, @@ -372,6 +561,7 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, @@ -385,6 +575,113 @@ } } }, + "DeleteRegistration": { + "input": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationStatus", + "CurrentVersionNumber", + "CreatedTimestamp" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "RegistrationType": {}, + "RegistrationStatus": {}, + "CurrentVersionNumber": { + "type": "long" + }, + "ApprovedVersionNumber": { + "type": "long" + }, + "LatestDeniedVersionNumber": { + "type": "long" + }, + "AdditionalAttributes": { + "shape": "S19" + }, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, + "DeleteRegistrationAttachment": { + "input": { + "type": "structure", + "required": [ + "RegistrationAttachmentId" + ], + "members": { + "RegistrationAttachmentId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationAttachmentArn", + "RegistrationAttachmentId", + "AttachmentStatus", + "CreatedTimestamp" + ], + "members": { + "RegistrationAttachmentArn": {}, + "RegistrationAttachmentId": {}, + "AttachmentStatus": {}, + "AttachmentUploadErrorReason": {}, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, + "DeleteRegistrationFieldValue": { + "input": { + "type": "structure", + "required": [ + "RegistrationId", + "FieldPath" + ], + "members": { + "RegistrationId": {}, + "FieldPath": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "FieldPath" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "VersionNumber": { + "type": "long" + }, + "FieldPath": {}, + "SelectChoices": { + "shape": "S2n" + }, + "TextValue": {}, + "RegistrationAttachmentId": {} + } + } + }, "DeleteTextMessageSpendLimitOverride": { "input": { "type": "structure", @@ -399,6 +696,34 @@ } } }, + "DeleteVerifiedDestinationNumber": { + "input": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberId" + ], + "members": { + "VerifiedDestinationNumberId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "CreatedTimestamp" + ], + "members": { + "VerifiedDestinationNumberArn": {}, + "VerifiedDestinationNumberId": {}, + "DestinationPhoneNumber": {}, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, "DeleteVoiceMessageSpendLimitOverride": { "input": { "type": "structure", @@ -500,7 +825,7 @@ "members": { "Name": {}, "Values": { - "shape": "S2f" + "shape": "S3g" } } } @@ -528,7 +853,7 @@ "ConfigurationSetArn": {}, "ConfigurationSetName": {}, "EventDestinations": { - "shape": "S16" + "shape": "S1t" }, "DefaultMessageType": {}, "DefaultSenderId": {}, @@ -565,7 +890,7 @@ "members": { "Name": {}, "Values": { - "shape": "S2f" + "shape": "S3g" } } } @@ -663,7 +988,7 @@ "members": { "Name": {}, "Values": { - "shape": "S2f" + "shape": "S3g" } } } @@ -722,7 +1047,7 @@ "members": { "Name": {}, "Values": { - "shape": "S2f" + "shape": "S3g" } } } @@ -763,7 +1088,7 @@ "IsoCountryCode": {}, "MessageType": {}, "NumberCapabilities": { - "shape": "S3f" + "shape": "S4g" }, "NumberType": {}, "MonthlyLeasingPrice": {}, @@ -771,6 +1096,7 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, @@ -779,6 +1105,7 @@ "type": "boolean" }, "PoolId": {}, + "RegistrationId": {}, "CreatedTimestamp": { "type": "timestamp" } @@ -808,7 +1135,7 @@ "members": { "Name": {}, "Values": { - "shape": "S2f" + "shape": "S3g" } } } @@ -847,6 +1174,7 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, @@ -867,23 +1195,13 @@ } } }, - "DescribeSenderIds": { + "DescribeRegistrationAttachments": { "input": { "type": "structure", "members": { - "SenderIds": { + "RegistrationAttachmentIds": { "type": "list", - "member": { - "type": "structure", - "required": [ - "SenderId", - "IsoCountryCode" - ], - "members": { - "SenderId": {}, - "IsoCountryCode": {} - } - } + "member": {} }, "Filters": { "type": "list", @@ -896,7 +1214,7 @@ "members": { "Name": {}, "Values": { - "shape": "S2f" + "shape": "S3g" } } } @@ -909,27 +1227,28 @@ }, "output": { "type": "structure", + "required": [ + "RegistrationAttachments" + ], "members": { - "SenderIds": { + "RegistrationAttachments": { "type": "list", "member": { "type": "structure", "required": [ - "SenderIdArn", - "SenderId", - "IsoCountryCode", - "MessageTypes", - "MonthlyLeasingPrice" + "RegistrationAttachmentArn", + "RegistrationAttachmentId", + "AttachmentStatus", + "CreatedTimestamp" ], "members": { - "SenderIdArn": {}, - "SenderId": {}, - "IsoCountryCode": {}, - "MessageTypes": { - "type": "list", - "member": {} - }, - "MonthlyLeasingPrice": {} + "RegistrationAttachmentArn": {}, + "RegistrationAttachmentId": {}, + "AttachmentStatus": {}, + "AttachmentUploadErrorReason": {}, + "CreatedTimestamp": { + "type": "timestamp" + } } } }, @@ -937,10 +1256,18 @@ } } }, - "DescribeSpendLimits": { + "DescribeRegistrationFieldDefinitions": { "input": { "type": "structure", + "required": [ + "RegistrationType" + ], "members": { + "RegistrationType": {}, + "SectionPath": {}, + "FieldPaths": { + "shape": "S51" + }, "NextToken": {}, "MaxResults": { "type": "integer" @@ -949,20 +1276,565 @@ }, "output": { "type": "structure", + "required": [ + "RegistrationType", + "RegistrationFieldDefinitions" + ], "members": { - "SpendLimits": { + "RegistrationType": {}, + "RegistrationFieldDefinitions": { "type": "list", "member": { "type": "structure", "required": [ - "Name", - "EnforcedLimit", - "MaxLimit", - "Overridden" + "SectionPath", + "FieldPath", + "FieldType", + "FieldRequirement", + "DisplayHints" ], "members": { - "Name": {}, - "EnforcedLimit": { + "SectionPath": {}, + "FieldPath": {}, + "FieldType": {}, + "FieldRequirement": {}, + "SelectValidation": { + "type": "structure", + "required": [ + "MinChoices", + "MaxChoices", + "Options" + ], + "members": { + "MinChoices": { + "type": "integer" + }, + "MaxChoices": { + "type": "integer" + }, + "Options": { + "type": "list", + "member": {} + } + } + }, + "TextValidation": { + "type": "structure", + "required": [ + "MinLength", + "MaxLength", + "Pattern" + ], + "members": { + "MinLength": { + "type": "integer" + }, + "MaxLength": { + "type": "integer" + }, + "Pattern": {} + } + }, + "DisplayHints": { + "type": "structure", + "required": [ + "Title", + "ShortDescription" + ], + "members": { + "Title": {}, + "ShortDescription": {}, + "LongDescription": {}, + "DocumentationTitle": {}, + "DocumentationLink": {}, + "SelectOptionDescriptions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Option" + ], + "members": { + "Option": {}, + "Title": {}, + "Description": {} + } + } + }, + "TextValidationDescription": {}, + "ExampleTextValue": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeRegistrationFieldValues": { + "input": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": {}, + "VersionNumber": { + "type": "long" + }, + "SectionPath": {}, + "FieldPaths": { + "shape": "S51" + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationFieldValues" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "VersionNumber": { + "type": "long" + }, + "RegistrationFieldValues": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "FieldPath" + ], + "members": { + "FieldPath": {}, + "SelectChoices": { + "shape": "S2n" + }, + "TextValue": {}, + "RegistrationAttachmentId": {}, + "DeniedReason": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeRegistrationSectionDefinitions": { + "input": { + "type": "structure", + "required": [ + "RegistrationType" + ], + "members": { + "RegistrationType": {}, + "SectionPaths": { + "type": "list", + "member": {} + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationType", + "RegistrationSectionDefinitions" + ], + "members": { + "RegistrationType": {}, + "RegistrationSectionDefinitions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SectionPath", + "DisplayHints" + ], + "members": { + "SectionPath": {}, + "DisplayHints": { + "type": "structure", + "required": [ + "Title", + "ShortDescription" + ], + "members": { + "Title": {}, + "ShortDescription": {}, + "LongDescription": {}, + "DocumentationTitle": {}, + "DocumentationLink": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeRegistrationTypeDefinitions": { + "input": { + "type": "structure", + "members": { + "RegistrationTypes": { + "type": "list", + "member": {} + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "S3g" + } + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationTypeDefinitions" + ], + "members": { + "RegistrationTypeDefinitions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RegistrationType", + "DisplayHints" + ], + "members": { + "RegistrationType": {}, + "SupportedAssociations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ResourceType", + "AssociationBehavior", + "DisassociationBehavior" + ], + "members": { + "ResourceType": {}, + "IsoCountryCode": {}, + "AssociationBehavior": {}, + "DisassociationBehavior": {} + } + } + }, + "DisplayHints": { + "type": "structure", + "required": [ + "Title" + ], + "members": { + "Title": {}, + "ShortDescription": {}, + "LongDescription": {}, + "DocumentationTitle": {}, + "DocumentationLink": {} + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeRegistrationVersions": { + "input": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": {}, + "VersionNumbers": { + "type": "list", + "member": { + "type": "long" + } + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "S3g" + } + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationVersions" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "RegistrationVersions": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members": { + "VersionNumber": { + "type": "long" + }, + "RegistrationVersionStatus": {}, + "RegistrationVersionStatusHistory": { + "shape": "S1n" + }, + "DeniedReasons": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Reason", + "ShortDescription" + ], + "members": { + "Reason": {}, + "ShortDescription": {}, + "LongDescription": {}, + "DocumentationTitle": {}, + "DocumentationLink": {} + } + } + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeRegistrations": { + "input": { + "type": "structure", + "members": { + "RegistrationIds": { + "type": "list", + "member": {} + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "S3g" + } + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "Registrations" + ], + "members": { + "Registrations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationStatus", + "CurrentVersionNumber", + "CreatedTimestamp" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "RegistrationType": {}, + "RegistrationStatus": {}, + "CurrentVersionNumber": { + "type": "long" + }, + "ApprovedVersionNumber": { + "type": "long" + }, + "LatestDeniedVersionNumber": { + "type": "long" + }, + "AdditionalAttributes": { + "shape": "S19" + }, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, + "DescribeSenderIds": { + "input": { + "type": "structure", + "members": { + "SenderIds": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SenderId", + "IsoCountryCode" + ], + "members": { + "SenderId": {}, + "IsoCountryCode": {} + } + } + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "S3g" + } + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SenderIds": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "DeletionProtectionEnabled", + "Registered" + ], + "members": { + "SenderIdArn": {}, + "SenderId": {}, + "IsoCountryCode": {}, + "MessageTypes": { + "shape": "S6t" + }, + "MonthlyLeasingPrice": {}, + "DeletionProtectionEnabled": { + "type": "boolean" + }, + "Registered": { + "type": "boolean" + }, + "RegistrationId": {} + } + } + }, + "NextToken": {} + } + } + }, + "DescribeSpendLimits": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SpendLimits": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "EnforcedLimit", + "MaxLimit", + "Overridden" + ], + "members": { + "Name": {}, + "EnforcedLimit": { "type": "long" }, "MaxLimit": { @@ -978,6 +1850,72 @@ } } }, + "DescribeVerifiedDestinationNumbers": { + "input": { + "type": "structure", + "members": { + "VerifiedDestinationNumberIds": { + "type": "list", + "member": {} + }, + "DestinationPhoneNumbers": { + "type": "list", + "member": {} + }, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "S3g" + } + } + } + }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "VerifiedDestinationNumbers" + ], + "members": { + "VerifiedDestinationNumbers": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "Status", + "CreatedTimestamp" + ], + "members": { + "VerifiedDestinationNumberArn": {}, + "VerifiedDestinationNumberId": {}, + "DestinationPhoneNumber": {}, + "Status": {}, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } + }, + "NextToken": {} + } + } + }, "DisassociateOriginationIdentity": { "input": { "type": "structure", @@ -1006,6 +1944,38 @@ } } }, + "DiscardRegistrationVersion": { + "input": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "VersionNumber": { + "type": "long" + }, + "RegistrationVersionStatus": {}, + "RegistrationVersionStatusHistory": { + "shape": "S1n" + } + } + } + }, "ListPoolOriginationIdentities": { "input": { "type": "structure", @@ -1025,7 +1995,7 @@ "members": { "Name": {}, "Values": { - "shape": "S2f" + "shape": "S3g" } } } @@ -1056,11 +2026,76 @@ "OriginationIdentity": {}, "IsoCountryCode": {}, "NumberCapabilities": { - "shape": "S3f" + "shape": "S4g" + }, + "PhoneNumber": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListRegistrationAssociations": { + "input": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": {}, + "Filters": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": {}, + "Values": { + "shape": "S3g" } } } }, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationAssociations" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "RegistrationType": {}, + "RegistrationAssociations": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ResourceArn", + "ResourceId", + "ResourceType" + ], + "members": { + "ResourceArn": {}, + "ResourceId": {}, + "ResourceType": {}, + "IsoCountryCode": {}, + "PhoneNumber": {} + } + } + }, "NextToken": {} } } @@ -1138,6 +2173,46 @@ } } }, + "PutRegistrationFieldValue": { + "input": { + "type": "structure", + "required": [ + "RegistrationId", + "FieldPath" + ], + "members": { + "RegistrationId": {}, + "FieldPath": {}, + "SelectChoices": { + "shape": "S2n" + }, + "TextValue": {}, + "RegistrationAttachmentId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "FieldPath" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "VersionNumber": { + "type": "long" + }, + "FieldPath": {}, + "SelectChoices": { + "shape": "S2n" + }, + "TextValue": {}, + "RegistrationAttachmentId": {} + } + } + }, "ReleasePhoneNumber": { "input": { "type": "structure", @@ -1158,7 +2233,7 @@ "IsoCountryCode": {}, "MessageType": {}, "NumberCapabilities": { - "shape": "S3f" + "shape": "S4g" }, "NumberType": {}, "MonthlyLeasingPrice": {}, @@ -1166,16 +2241,55 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, "OptOutListName": {}, + "RegistrationId": {}, "CreatedTimestamp": { "type": "timestamp" } } } }, + "ReleaseSenderId": { + "input": { + "type": "structure", + "required": [ + "SenderId", + "IsoCountryCode" + ], + "members": { + "SenderId": {}, + "IsoCountryCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "Registered" + ], + "members": { + "SenderIdArn": {}, + "SenderId": {}, + "IsoCountryCode": {}, + "MessageTypes": { + "shape": "S6t" + }, + "MonthlyLeasingPrice": {}, + "Registered": { + "type": "boolean" + }, + "RegistrationId": {} + } + } + }, "RequestPhoneNumber": { "input": { "type": "structure", @@ -1189,7 +2303,7 @@ "IsoCountryCode": {}, "MessageType": {}, "NumberCapabilities": { - "shape": "S3f" + "shape": "S4g" }, "NumberType": {}, "OptOutListName": {}, @@ -1216,7 +2330,7 @@ "IsoCountryCode": {}, "MessageType": {}, "NumberCapabilities": { - "shape": "S3f" + "shape": "S4g" }, "NumberType": {}, "MonthlyLeasingPrice": {}, @@ -1224,6 +2338,7 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, @@ -1232,6 +2347,7 @@ "type": "boolean" }, "PoolId": {}, + "RegistrationId": {}, "Tags": { "shape": "Sa" }, @@ -1241,6 +2357,92 @@ } } }, + "RequestSenderId": { + "input": { + "type": "structure", + "required": [ + "SenderId", + "IsoCountryCode" + ], + "members": { + "SenderId": {}, + "IsoCountryCode": {}, + "MessageTypes": { + "shape": "S6t" + }, + "DeletionProtectionEnabled": { + "type": "boolean" + }, + "Tags": { + "shape": "Sa" + }, + "ClientToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "required": [ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "DeletionProtectionEnabled", + "Registered" + ], + "members": { + "SenderIdArn": {}, + "SenderId": {}, + "IsoCountryCode": {}, + "MessageTypes": { + "shape": "S6t" + }, + "MonthlyLeasingPrice": {}, + "DeletionProtectionEnabled": { + "type": "boolean" + }, + "Registered": { + "type": "boolean" + }, + "Tags": { + "shape": "Sa" + } + } + } + }, + "SendDestinationNumberVerificationCode": { + "input": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberId", + "VerificationChannel" + ], + "members": { + "VerifiedDestinationNumberId": {}, + "VerificationChannel": {}, + "LanguageCode": {}, + "OriginationIdentity": {}, + "ConfigurationSetName": {}, + "Context": { + "shape": "S8c" + }, + "DestinationCountryParameters": { + "shape": "S8f" + } + } + }, + "output": { + "type": "structure", + "required": [ + "MessageId" + ], + "members": { + "MessageId": {} + } + } + }, "SendTextMessage": { "input": { "type": "structure", @@ -1259,12 +2461,10 @@ "type": "integer" }, "Context": { - "shape": "S4x" + "shape": "S8c" }, "DestinationCountryParameters": { - "type": "map", - "key": {}, - "value": {} + "shape": "S8f" }, "DryRun": { "type": "boolean" @@ -1297,7 +2497,7 @@ "type": "integer" }, "Context": { - "shape": "S4x" + "shape": "S8c" }, "DryRun": { "type": "boolean" @@ -1395,6 +2595,38 @@ } } }, + "SubmitRegistrationVersion": { + "input": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": {} + } + }, + "output": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members": { + "RegistrationArn": {}, + "RegistrationId": {}, + "VersionNumber": { + "type": "long" + }, + "RegistrationVersionStatus": {}, + "RegistrationVersionStatusHistory": { + "shape": "S1n" + } + } + } + }, "TagResource": { "input": { "type": "structure", @@ -1487,6 +2719,7 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, @@ -1506,7 +2739,7 @@ "IsoCountryCode": {}, "MessageType": {}, "NumberCapabilities": { - "shape": "S3f" + "shape": "S4g" }, "NumberType": {}, "MonthlyLeasingPrice": {}, @@ -1514,6 +2747,7 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, @@ -1521,6 +2755,7 @@ "DeletionProtectionEnabled": { "type": "boolean" }, + "RegistrationId": {}, "CreatedTimestamp": { "type": "timestamp" } @@ -1539,6 +2774,7 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, @@ -1562,6 +2798,7 @@ "type": "boolean" }, "TwoWayChannelArn": {}, + "TwoWayChannelRole": {}, "SelfManagedOptOutsEnabled": { "type": "boolean" }, @@ -1577,6 +2814,82 @@ } } } + }, + "UpdateSenderId": { + "input": { + "type": "structure", + "required": [ + "SenderId", + "IsoCountryCode" + ], + "members": { + "SenderId": {}, + "IsoCountryCode": {}, + "DeletionProtectionEnabled": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "required": [ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "DeletionProtectionEnabled", + "Registered" + ], + "members": { + "SenderIdArn": {}, + "SenderId": {}, + "IsoCountryCode": {}, + "MessageTypes": { + "shape": "S6t" + }, + "MonthlyLeasingPrice": {}, + "DeletionProtectionEnabled": { + "type": "boolean" + }, + "Registered": { + "type": "boolean" + }, + "RegistrationId": {} + } + } + }, + "VerifyDestinationNumber": { + "input": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberId", + "VerificationCode" + ], + "members": { + "VerifiedDestinationNumberId": {}, + "VerificationCode": {} + } + }, + "output": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "Status", + "CreatedTimestamp" + ], + "members": { + "VerifiedDestinationNumberArn": {}, + "VerifiedDestinationNumberId": {}, + "DestinationPhoneNumber": {}, + "Status": {}, + "CreatedTimestamp": { + "type": "timestamp" + } + } + } } }, "shapes": { @@ -1658,21 +2971,75 @@ } } }, - "S16": { + "S19": { + "type": "map", + "key": {}, + "value": {} + }, + "S1n": { + "type": "structure", + "required": [ + "DraftTimestamp" + ], + "members": { + "DraftTimestamp": { + "type": "timestamp" + }, + "SubmittedTimestamp": { + "type": "timestamp" + }, + "ReviewingTimestamp": { + "type": "timestamp" + }, + "ApprovedTimestamp": { + "type": "timestamp" + }, + "DiscardedTimestamp": { + "type": "timestamp" + }, + "DeniedTimestamp": { + "type": "timestamp" + }, + "RevokedTimestamp": { + "type": "timestamp" + }, + "ArchivedTimestamp": { + "type": "timestamp" + } + } + }, + "S1t": { "type": "list", "member": { "shape": "St" } }, - "S2f": { + "S2n": { + "type": "list", + "member": {} + }, + "S3g": { + "type": "list", + "member": {} + }, + "S4g": { + "type": "list", + "member": {} + }, + "S51": { "type": "list", "member": {} }, - "S3f": { + "S6t": { "type": "list", "member": {} }, - "S4x": { + "S8c": { + "type": "map", + "key": {}, + "value": {} + }, + "S8f": { "type": "map", "key": {}, "value": {} diff --git a/apis/pinpoint-sms-voice-v2-2022-03-31.normal.json b/apis/pinpoint-sms-voice-v2-2022-03-31.normal.json index fb8bc836d7..e84f6f46fb 100644 --- a/apis/pinpoint-sms-voice-v2-2022-03-31.normal.json +++ b/apis/pinpoint-sms-voice-v2-2022-03-31.normal.json @@ -48,7 +48,7 @@ "shape": "InternalServerException" } ], - "documentation": "Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an Error is returned.
" + "documentation": "Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an error is returned.
" }, "CreateConfigurationSet": { "name": "CreateConfigurationSet", @@ -153,7 +153,7 @@ "shape": "InternalServerException" } ], - "documentation": "Creates a new opt-out list.
If the opt-out list name already exists, an Error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
" + "documentation": "Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
" }, "CreatePool": { "name": "CreatePool", @@ -190,21 +190,24 @@ "shape": "InternalServerException" } ], - "documentation": "Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
" + "documentation": "Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
" }, - "DeleteConfigurationSet": { - "name": "DeleteConfigurationSet", + "CreateRegistration": { + "name": "CreateRegistration", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteConfigurationSetRequest" + "shape": "CreateRegistrationRequest" }, "output": { - "shape": "DeleteConfigurationSetResult" + "shape": "CreateRegistrationResult" }, "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, { "shape": "ThrottlingException" }, @@ -212,30 +215,33 @@ "shape": "AccessDeniedException" }, { - "shape": "ResourceNotFoundException" + "shape": "ValidationException" }, { - "shape": "ValidationException" + "shape": "ConflictException" }, { "shape": "InternalServerException" } ], - "documentation": "Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
" + "documentation": "Creates a new registration based on the RegistrationType field.
" }, - "DeleteDefaultMessageType": { - "name": "DeleteDefaultMessageType", + "CreateRegistrationAssociation": { + "name": "CreateRegistrationAssociation", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteDefaultMessageTypeRequest" + "shape": "CreateRegistrationAssociationRequest" }, "output": { - "shape": "DeleteDefaultMessageTypeResult" + "shape": "CreateRegistrationAssociationResult" }, "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, { "shape": "ThrottlingException" }, @@ -248,25 +254,31 @@ { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
" + "documentation": "Associate the registration with an origination identity such as a phone number or sender ID.
" }, - "DeleteDefaultSenderId": { - "name": "DeleteDefaultSenderId", + "CreateRegistrationAttachment": { + "name": "CreateRegistrationAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteDefaultSenderIdRequest" + "shape": "CreateRegistrationAttachmentRequest" }, "output": { - "shape": "DeleteDefaultSenderIdResult" + "shape": "CreateRegistrationAttachmentResult" }, "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, { "shape": "ThrottlingException" }, @@ -274,30 +286,33 @@ "shape": "AccessDeniedException" }, { - "shape": "ResourceNotFoundException" + "shape": "ValidationException" }, { - "shape": "ValidationException" + "shape": "ConflictException" }, { "shape": "InternalServerException" } ], - "documentation": "Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
" + "documentation": "Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
" }, - "DeleteEventDestination": { - "name": "DeleteEventDestination", + "CreateRegistrationVersion": { + "name": "CreateRegistrationVersion", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteEventDestinationRequest" + "shape": "CreateRegistrationVersionRequest" }, "output": { - "shape": "DeleteEventDestinationResult" + "shape": "CreateRegistrationVersionResult" }, "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, { "shape": "ThrottlingException" }, @@ -310,33 +325,36 @@ { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
" + "documentation": "Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
" }, - "DeleteKeyword": { - "name": "DeleteKeyword", + "CreateVerifiedDestinationNumber": { + "name": "CreateVerifiedDestinationNumber", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteKeywordRequest" + "shape": "CreateVerifiedDestinationNumberRequest" }, "output": { - "shape": "DeleteKeywordResult" + "shape": "CreateVerifiedDestinationNumberResult" }, "errors": [ { - "shape": "ThrottlingException" + "shape": "ServiceQuotaExceededException" }, { - "shape": "AccessDeniedException" + "shape": "ThrottlingException" }, { - "shape": "ResourceNotFoundException" + "shape": "AccessDeniedException" }, { "shape": "ValidationException" @@ -348,19 +366,19 @@ "shape": "InternalServerException" } ], - "documentation": "Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
Keywords \"HELP\" and \"STOP\" can't be deleted or modified.
" + "documentation": "You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
" }, - "DeleteOptOutList": { - "name": "DeleteOptOutList", + "DeleteConfigurationSet": { + "name": "DeleteConfigurationSet", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteOptOutListRequest" + "shape": "DeleteConfigurationSetRequest" }, "output": { - "shape": "DeleteOptOutListResult" + "shape": "DeleteConfigurationSetResult" }, "errors": [ { @@ -375,26 +393,23 @@ { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an Error is returned.
" + "documentation": "Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
" }, - "DeleteOptedOutNumber": { - "name": "DeleteOptedOutNumber", + "DeleteDefaultMessageType": { + "name": "DeleteDefaultMessageType", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteOptedOutNumberRequest" + "shape": "DeleteDefaultMessageTypeRequest" }, "output": { - "shape": "DeleteOptedOutNumberResult" + "shape": "DeleteDefaultMessageTypeResult" }, "errors": [ { @@ -409,26 +424,23 @@ { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an Error is returned.
" + "documentation": "Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
" }, - "DeletePool": { - "name": "DeletePool", + "DeleteDefaultSenderId": { + "name": "DeleteDefaultSenderId", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeletePoolRequest" + "shape": "DeleteDefaultSenderIdRequest" }, "output": { - "shape": "DeletePoolResult" + "shape": "DeleteDefaultSenderIdResult" }, "errors": [ { @@ -443,26 +455,23 @@ { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
" + "documentation": "Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
" }, - "DeleteTextMessageSpendLimitOverride": { - "name": "DeleteTextMessageSpendLimitOverride", + "DeleteEventDestination": { + "name": "DeleteEventDestination", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteTextMessageSpendLimitOverrideRequest" + "shape": "DeleteEventDestinationRequest" }, "output": { - "shape": "DeleteTextMessageSpendLimitOverrideResult" + "shape": "DeleteEventDestinationResult" }, "errors": [ { @@ -471,6 +480,9 @@ { "shape": "AccessDeniedException" }, + { + "shape": "ResourceNotFoundException" + }, { "shape": "ValidationException" }, @@ -478,19 +490,19 @@ "shape": "InternalServerException" } ], - "documentation": "Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit
to equal the MaxLimit
, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
" }, - "DeleteVoiceMessageSpendLimitOverride": { - "name": "DeleteVoiceMessageSpendLimitOverride", + "DeleteKeyword": { + "name": "DeleteKeyword", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteVoiceMessageSpendLimitOverrideRequest" + "shape": "DeleteKeywordRequest" }, "output": { - "shape": "DeleteVoiceMessageSpendLimitOverrideResult" + "shape": "DeleteKeywordResult" }, "errors": [ { @@ -499,26 +511,32 @@ { "shape": "AccessDeniedException" }, + { + "shape": "ResourceNotFoundException" + }, { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit
equal to the MaxLimit
, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
Keywords \"HELP\" and \"STOP\" can't be deleted or modified.
" }, - "DescribeAccountAttributes": { - "name": "DescribeAccountAttributes", + "DeleteOptOutList": { + "name": "DeleteOptOutList", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribeAccountAttributesRequest" + "shape": "DeleteOptOutListRequest" }, "output": { - "shape": "DescribeAccountAttributesResult" + "shape": "DeleteOptOutListResult" }, "errors": [ { @@ -527,26 +545,32 @@ { "shape": "AccessDeniedException" }, + { + "shape": "ResourceNotFoundException" + }, { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
" + "documentation": "Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
" }, - "DescribeAccountLimits": { - "name": "DescribeAccountLimits", + "DeleteOptedOutNumber": { + "name": "DeleteOptedOutNumber", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribeAccountLimitsRequest" + "shape": "DeleteOptedOutNumberRequest" }, "output": { - "shape": "DescribeAccountLimitsResult" + "shape": "DeleteOptedOutNumberResult" }, "errors": [ { @@ -555,26 +579,32 @@ { "shape": "AccessDeniedException" }, + { + "shape": "ResourceNotFoundException" + }, { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
" + "documentation": "Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
" }, - "DescribeConfigurationSets": { - "name": "DescribeConfigurationSets", + "DeletePool": { + "name": "DeletePool", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribeConfigurationSetsRequest" + "shape": "DeletePoolRequest" }, "output": { - "shape": "DescribeConfigurationSetsResult" + "shape": "DeletePoolResult" }, "errors": [ { @@ -589,23 +619,26 @@ { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
" + "documentation": "Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
" }, - "DescribeKeywords": { - "name": "DescribeKeywords", + "DeleteRegistration": { + "name": "DeleteRegistration", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribeKeywordsRequest" + "shape": "DeleteRegistrationRequest" }, "output": { - "shape": "DescribeKeywordsResult" + "shape": "DeleteRegistrationResult" }, "errors": [ { @@ -620,23 +653,26 @@ { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
" + "documentation": "Permanently delete an existing registration from your account.
" }, - "DescribeOptOutLists": { - "name": "DescribeOptOutLists", + "DeleteRegistrationAttachment": { + "name": "DeleteRegistrationAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribeOptOutListsRequest" + "shape": "DeleteRegistrationAttachmentRequest" }, "output": { - "shape": "DescribeOptOutListsResult" + "shape": "DeleteRegistrationAttachmentResult" }, "errors": [ { @@ -651,23 +687,26 @@ { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an Error is returned.
" + "documentation": "Permanently delete the specified registration attachment.
" }, - "DescribeOptedOutNumbers": { - "name": "DescribeOptedOutNumbers", + "DeleteRegistrationFieldValue": { + "name": "DeleteRegistrationFieldValue", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribeOptedOutNumbersRequest" + "shape": "DeleteRegistrationFieldValueRequest" }, "output": { - "shape": "DescribeOptedOutNumbersResult" + "shape": "DeleteRegistrationFieldValueResult" }, "errors": [ { @@ -682,23 +721,26 @@ { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an Error is returned.
" + "documentation": "Delete the value in a registration form field.
" }, - "DescribePhoneNumbers": { - "name": "DescribePhoneNumbers", + "DeleteTextMessageSpendLimitOverride": { + "name": "DeleteTextMessageSpendLimitOverride", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribePhoneNumbersRequest" + "shape": "DeleteTextMessageSpendLimitOverrideRequest" }, "output": { - "shape": "DescribePhoneNumbersResult" + "shape": "DeleteTextMessageSpendLimitOverrideResult" }, "errors": [ { @@ -707,9 +749,6 @@ { "shape": "AccessDeniedException" }, - { - "shape": "ResourceNotFoundException" - }, { "shape": "ValidationException" }, @@ -717,19 +756,19 @@ "shape": "InternalServerException" } ], - "documentation": "Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an Error is returned.
" + "documentation": "Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit
to equal the MaxLimit
, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
" + "documentation": "Delete a verified destination phone number.
" }, - "DescribeSenderIds": { - "name": "DescribeSenderIds", + "DeleteVoiceMessageSpendLimitOverride": { + "name": "DeleteVoiceMessageSpendLimitOverride", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribeSenderIdsRequest" + "shape": "DeleteVoiceMessageSpendLimitOverrideRequest" }, "output": { - "shape": "DescribeSenderIdsResult" + "shape": "DeleteVoiceMessageSpendLimitOverrideResult" }, "errors": [ { @@ -769,9 +811,6 @@ { "shape": "AccessDeniedException" }, - { - "shape": "ResourceNotFoundException" - }, { "shape": "ValidationException" }, @@ -779,19 +818,19 @@ "shape": "InternalServerException" } ], - "documentation": "Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an Error is returned.
" + "documentation": "Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit
equal to the MaxLimit
, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
" + "documentation": "Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
" }, - "DisassociateOriginationIdentity": { - "name": "DisassociateOriginationIdentity", + "DescribeAccountLimits": { + "name": "DescribeAccountLimits", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DisassociateOriginationIdentityRequest" + "shape": "DescribeAccountLimitsRequest" }, "output": { - "shape": "DisassociateOriginationIdentityResult" + "shape": "DescribeAccountLimitsResult" }, "errors": [ { @@ -828,32 +867,26 @@ { "shape": "AccessDeniedException" }, - { - "shape": "ResourceNotFoundException" - }, { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an Error is returned.
" + "documentation": "Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
" }, - "ListPoolOriginationIdentities": { - "name": "ListPoolOriginationIdentities", + "DescribeConfigurationSets": { + "name": "DescribeConfigurationSets", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListPoolOriginationIdentitiesRequest" + "shape": "DescribeConfigurationSetsRequest" }, "output": { - "shape": "ListPoolOriginationIdentitiesResult" + "shape": "DescribeConfigurationSetsResult" }, "errors": [ { @@ -872,19 +905,19 @@ "shape": "InternalServerException" } ], - "documentation": "Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
" + "documentation": "Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
" }, - "ListTagsForResource": { - "name": "ListTagsForResource", + "DescribeKeywords": { + "name": "DescribeKeywords", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListTagsForResourceRequest" + "shape": "DescribeKeywordsRequest" }, "output": { - "shape": "ListTagsForResourceResult" + "shape": "DescribeKeywordsResult" }, "errors": [ { @@ -903,24 +936,21 @@ "shape": "InternalServerException" } ], - "documentation": "List all tags associated with a resource.
" + "documentation": "Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
" }, - "PutKeyword": { - "name": "PutKeyword", + "DescribeOptOutLists": { + "name": "DescribeOptOutLists", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "PutKeywordRequest" + "shape": "DescribeOptOutListsRequest" }, "output": { - "shape": "PutKeywordResult" + "shape": "DescribeOptOutListsResult" }, "errors": [ - { - "shape": "ServiceQuotaExceededException" - }, { "shape": "ThrottlingException" }, @@ -933,26 +963,23 @@ { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
" + "documentation": "Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an error is returned.
" }, - "PutOptedOutNumber": { - "name": "PutOptedOutNumber", + "DescribeOptedOutNumbers": { + "name": "DescribeOptedOutNumbers", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "PutOptedOutNumberRequest" + "shape": "DescribeOptedOutNumbersRequest" }, "output": { - "shape": "PutOptedOutNumberResult" + "shape": "DescribeOptedOutNumbersResult" }, "errors": [ { @@ -971,19 +998,19 @@ "shape": "InternalServerException" } ], - "documentation": "Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an Error is returned.
" + "documentation": "Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an error is returned.
" }, - "ReleasePhoneNumber": { - "name": "ReleasePhoneNumber", + "DescribePhoneNumbers": { + "name": "DescribePhoneNumbers", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ReleasePhoneNumberRequest" + "shape": "DescribePhoneNumbersRequest" }, "output": { - "shape": "ReleasePhoneNumberResult" + "shape": "DescribePhoneNumbersResult" }, "errors": [ { @@ -998,31 +1025,25 @@ { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an Error is returned.
" + "documentation": "Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an error is returned.
" }, - "RequestPhoneNumber": { - "name": "RequestPhoneNumber", + "DescribePools": { + "name": "DescribePools", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "RequestPhoneNumberRequest" + "shape": "DescribePoolsRequest" }, "output": { - "shape": "RequestPhoneNumberResult" + "shape": "DescribePoolsResult" }, "errors": [ - { - "shape": "ServiceQuotaExceededException" - }, { "shape": "ThrottlingException" }, @@ -1035,31 +1056,25 @@ { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
" + "documentation": "Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
" }, - "SendTextMessage": { - "name": "SendTextMessage", + "DescribeRegistrationAttachments": { + "name": "DescribeRegistrationAttachments", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "SendTextMessageRequest" + "shape": "DescribeRegistrationAttachmentsRequest" }, "output": { - "shape": "SendTextMessageResult" + "shape": "DescribeRegistrationAttachmentsResult" }, "errors": [ - { - "shape": "ServiceQuotaExceededException" - }, { "shape": "ThrottlingException" }, @@ -1072,31 +1087,53 @@ { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
" + "documentation": "Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
" }, - "SendVoiceMessage": { - "name": "SendVoiceMessage", + "DescribeRegistrationFieldDefinitions": { + "name": "DescribeRegistrationFieldDefinitions", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "SendVoiceMessageRequest" + "shape": "DescribeRegistrationFieldDefinitionsRequest" }, "output": { - "shape": "SendVoiceMessageResult" + "shape": "DescribeRegistrationFieldDefinitionsResult" }, "errors": [ { - "shape": "ServiceQuotaExceededException" + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
" + }, + "DescribeRegistrationFieldValues": { + "name": "DescribeRegistrationFieldValues", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeRegistrationFieldValuesRequest" + }, + "output": { + "shape": "DescribeRegistrationFieldValuesResult" + }, + "errors": [ { "shape": "ThrottlingException" }, @@ -1110,25 +1147,78 @@ "shape": "ValidationException" }, { - "shape": "ConflictException" + "shape": "InternalServerException" + } + ], + "documentation": "Retrieves the specified registration field values.
" + }, + "DescribeRegistrationSectionDefinitions": { + "name": "DescribeRegistrationSectionDefinitions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeRegistrationSectionDefinitionsRequest" + }, + "output": { + "shape": "DescribeRegistrationSectionDefinitionsResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" }, { "shape": "InternalServerException" } ], - "documentation": "Allows you to send a request that sends a text message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
" + "documentation": "Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
" }, - "SetDefaultMessageType": { - "name": "SetDefaultMessageType", + "DescribeRegistrationTypeDefinitions": { + "name": "DescribeRegistrationTypeDefinitions", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "SetDefaultMessageTypeRequest" + "shape": "DescribeRegistrationTypeDefinitionsRequest" }, "output": { - "shape": "SetDefaultMessageTypeResult" + "shape": "DescribeRegistrationTypeDefinitionsResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
" + }, + "DescribeRegistrationVersions": { + "name": "DescribeRegistrationVersions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeRegistrationVersionsRequest" + }, + "output": { + "shape": "DescribeRegistrationVersionsResult" }, "errors": [ { @@ -1147,19 +1237,19 @@ "shape": "InternalServerException" } ], - "documentation": "Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
" + "documentation": "Retrieves the specified registration version.
" }, - "SetDefaultSenderId": { - "name": "SetDefaultSenderId", + "DescribeRegistrations": { + "name": "DescribeRegistrations", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "SetDefaultSenderIdRequest" + "shape": "DescribeRegistrationsRequest" }, "output": { - "shape": "SetDefaultSenderIdResult" + "shape": "DescribeRegistrationsResult" }, "errors": [ { @@ -1178,19 +1268,19 @@ "shape": "InternalServerException" } ], - "documentation": "Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
" + "documentation": "Retrieves the specified registrations.
" }, - "SetTextMessageSpendLimitOverride": { - "name": "SetTextMessageSpendLimitOverride", + "DescribeSenderIds": { + "name": "DescribeSenderIds", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "SetTextMessageSpendLimitOverrideRequest" + "shape": "DescribeSenderIdsRequest" }, "output": { - "shape": "SetTextMessageSpendLimitOverrideResult" + "shape": "DescribeSenderIdsResult" }, "errors": [ { @@ -1199,6 +1289,9 @@ { "shape": "AccessDeniedException" }, + { + "shape": "ResourceNotFoundException" + }, { "shape": "ValidationException" }, @@ -1206,19 +1299,19 @@ "shape": "InternalServerException" } ], - "documentation": "Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit
, which is set by Amazon Web Services.
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an error is returned.
" }, - "SetVoiceMessageSpendLimitOverride": { - "name": "SetVoiceMessageSpendLimitOverride", + "DescribeSpendLimits": { + "name": "DescribeSpendLimits", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "SetVoiceMessageSpendLimitOverrideRequest" + "shape": "DescribeSpendLimitsRequest" }, "output": { - "shape": "SetVoiceMessageSpendLimitOverrideResult" + "shape": "DescribeSpendLimitsResult" }, "errors": [ { @@ -1234,24 +1327,21 @@ "shape": "InternalServerException" } ], - "documentation": "Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit
, which is set by Amazon Web Services.
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
" }, - "TagResource": { - "name": "TagResource", + "DescribeVerifiedDestinationNumbers": { + "name": "DescribeVerifiedDestinationNumbers", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "TagResourceRequest" + "shape": "DescribeVerifiedDestinationNumbersRequest" }, "output": { - "shape": "TagResourceResult" + "shape": "DescribeVerifiedDestinationNumbersResult" }, "errors": [ - { - "shape": "ServiceQuotaExceededException" - }, { "shape": "ThrottlingException" }, @@ -1268,19 +1358,19 @@ "shape": "InternalServerException" } ], - "documentation": "Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
" + "documentation": "Retrieves the specified verified destiona numbers.
" }, - "UntagResource": { - "name": "UntagResource", + "DisassociateOriginationIdentity": { + "name": "DisassociateOriginationIdentity", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "UntagResourceRequest" + "shape": "DisassociateOriginationIdentityRequest" }, "output": { - "shape": "UntagResourceResult" + "shape": "DisassociateOriginationIdentityResult" }, "errors": [ { @@ -1295,23 +1385,26 @@ { "shape": "ValidationException" }, + { + "shape": "ConflictException" + }, { "shape": "InternalServerException" } ], - "documentation": "Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
" + "documentation": "Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
" }, - "UpdateEventDestination": { - "name": "UpdateEventDestination", + "DiscardRegistrationVersion": { + "name": "DiscardRegistrationVersion", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "UpdateEventDestinationRequest" + "shape": "DiscardRegistrationVersionRequest" }, "output": { - "shape": "UpdateEventDestinationResult" + "shape": "DiscardRegistrationVersionResult" }, "errors": [ { @@ -1333,19 +1426,19 @@ "shape": "InternalServerException" } ], - "documentation": "Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
" + "documentation": "Discard the current version of the registration.
" }, - "UpdatePhoneNumber": { - "name": "UpdatePhoneNumber", + "ListPoolOriginationIdentities": { + "name": "ListPoolOriginationIdentities", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "UpdatePhoneNumberRequest" + "shape": "ListPoolOriginationIdentitiesRequest" }, "output": { - "shape": "UpdatePhoneNumberResult" + "shape": "ListPoolOriginationIdentitiesResult" }, "errors": [ { @@ -1360,26 +1453,23 @@ { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an Error is returned.
" + "documentation": "Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
" }, - "UpdatePool": { - "name": "UpdatePool", + "ListRegistrationAssociations": { + "name": "ListRegistrationAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "UpdatePoolRequest" + "shape": "ListRegistrationAssociationsRequest" }, "output": { - "shape": "UpdatePoolResult" + "shape": "ListRegistrationAssociationsResult" }, "errors": [ { @@ -1394,957 +1484,3253 @@ { "shape": "ValidationException" }, - { - "shape": "ConflictException" - }, { "shape": "InternalServerException" } ], - "documentation": "Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn
, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
The name of the account attribute.
" + "documentation": "Retreive all of the origination identies that are associated with a registration.
" + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResult" + }, + "errors": [ + { + "shape": "ThrottlingException" }, - "Value": { - "shape": "String", - "documentation": "The value associated with the account attribute name.
" + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" } - }, - "documentation": "Displays the attributes associated with a single Amazon Web Services account.
" + ], + "documentation": "List all tags associated with a resource.
" + }, + "PutKeyword": { + "name": "PutKeyword", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutKeywordRequest" + }, + "output": { + "shape": "PutKeywordResult" + }, + "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
" + }, + "PutOptedOutNumber": { + "name": "PutOptedOutNumber", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutOptedOutNumberRequest" + }, + "output": { + "shape": "PutOptedOutNumberResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
" + }, + "PutRegistrationFieldValue": { + "name": "PutRegistrationFieldValue", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutRegistrationFieldValueRequest" + }, + "output": { + "shape": "PutRegistrationFieldValueResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates or updates a field value for a registration.
" + }, + "ReleasePhoneNumber": { + "name": "ReleasePhoneNumber", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReleasePhoneNumberRequest" + }, + "output": { + "shape": "ReleasePhoneNumberResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
" + }, + "ReleaseSenderId": { + "name": "ReleaseSenderId", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ReleaseSenderIdRequest" + }, + "output": { + "shape": "ReleaseSenderIdResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Releases an existing sender ID in your account.
" + }, + "RequestPhoneNumber": { + "name": "RequestPhoneNumber", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RequestPhoneNumberRequest" + }, + "output": { + "shape": "RequestPhoneNumberResult" + }, + "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
" + }, + "RequestSenderId": { + "name": "RequestSenderId", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RequestSenderIdRequest" + }, + "output": { + "shape": "RequestSenderIdResult" + }, + "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Request a new sender ID that doesn't require registration.
" + }, + "SendDestinationNumberVerificationCode": { + "name": "SendDestinationNumberVerificationCode", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SendDestinationNumberVerificationCodeRequest" + }, + "output": { + "shape": "SendDestinationNumberVerificationCodeResult" + }, + "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
" + }, + "SendTextMessage": { + "name": "SendTextMessage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SendTextMessageRequest" + }, + "output": { + "shape": "SendTextMessageResult" + }, + "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
" + }, + "SendVoiceMessage": { + "name": "SendVoiceMessage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SendVoiceMessageRequest" + }, + "output": { + "shape": "SendVoiceMessageResult" + }, + "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
" + }, + "SetDefaultMessageType": { + "name": "SetDefaultMessageType", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SetDefaultMessageTypeRequest" + }, + "output": { + "shape": "SetDefaultMessageTypeResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
" + }, + "SetDefaultSenderId": { + "name": "SetDefaultSenderId", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SetDefaultSenderIdRequest" + }, + "output": { + "shape": "SetDefaultSenderIdResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
" + }, + "SetTextMessageSpendLimitOverride": { + "name": "SetTextMessageSpendLimitOverride", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SetTextMessageSpendLimitOverrideRequest" + }, + "output": { + "shape": "SetTextMessageSpendLimitOverrideResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit
, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit
, which is set by Amazon Web Services.
Submit the specified registration for review and approval.
" + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "TagResourceRequest" + }, + "output": { + "shape": "TagResourceResult" + }, + "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
" + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UntagResourceRequest" + }, + "output": { + "shape": "UntagResourceResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
" + }, + "UpdateEventDestination": { + "name": "UpdateEventDestination", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateEventDestinationRequest" + }, + "output": { + "shape": "UpdateEventDestinationResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
" + }, + "UpdatePhoneNumber": { + "name": "UpdatePhoneNumber", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdatePhoneNumberRequest" + }, + "output": { + "shape": "UpdatePhoneNumberResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an error is returned.
" + }, + "UpdatePool": { + "name": "UpdatePool", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdatePoolRequest" + }, + "output": { + "shape": "UpdatePoolResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn
, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
Updates the configuration of an existing sender ID.
" + }, + "VerifyDestinationNumber": { + "name": "VerifyDestinationNumber", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "VerifyDestinationNumberRequest" + }, + "output": { + "shape": "VerifyDestinationNumberResult" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
" + } + }, + "shapes": { + "AccountAttribute": { + "type": "structure", + "required": [ + "Name", + "Value" + ], + "members": { + "Name": { + "shape": "AccountAttributeName", + "documentation": "The name of the account attribute.
" + }, + "Value": { + "shape": "String", + "documentation": "The value associated with the account attribute name.
" + } + }, + "documentation": "Displays the attributes associated with a single Amazon Web Services account.
" + }, + "AccountAttributeList": { + "type": "list", + "member": { + "shape": "AccountAttribute" + } + }, + "AccountAttributeName": { + "type": "string", + "enum": [ + "ACCOUNT_TIER" + ] + }, + "AccountLimit": { + "type": "structure", + "required": [ + "Name", + "Used", + "Max" + ], + "members": { + "Name": { + "shape": "AccountLimitName", + "documentation": "The name of the attribute to apply the account limit to.
" + }, + "Used": { + "shape": "PrimitiveLong", + "documentation": "The current amount that has been spent, in US dollars.
" + }, + "Max": { + "shape": "PrimitiveLong", + "documentation": "The Amazon Web Services set limit for that resource type, in US dollars.
" + } + }, + "documentation": "The current resource quotas associated with an Amazon Web Services account.
" + }, + "AccountLimitList": { + "type": "list", + "member": { + "shape": "AccountLimit" + } + }, + "AccountLimitName": { + "type": "string", + "enum": [ + "PHONE_NUMBERS", + "POOLS", + "CONFIGURATION_SETS", + "OPT_OUT_LISTS", + "SENDER_IDS", + "REGISTRATIONS", + "REGISTRATION_ATTACHMENTS", + "VERIFIED_DESTINATION_NUMBERS" + ] + }, + "AmazonResourceName": { + "type": "string", + "max": 256, + "min": 20, + "pattern": "arn:[A-Za-z0-9_:/-]+" + }, + "AssociateOriginationIdentityRequest": { + "type": "structure", + "required": [ + "PoolId", + "OriginationIdentity", + "IsoCountryCode" + ], + "members": { + "PoolId": { + "shape": "PoolIdOrArn", + "documentation": "The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
" + }, + "OriginationIdentity": { + "shape": "PhoneOrSenderIdOrArn", + "documentation": "The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true + } + } + }, + "AssociateOriginationIdentityResult": { + "type": "structure", + "members": { + "PoolArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
" + }, + "PoolId": { + "shape": "String", + "documentation": "The PoolId of the pool that is now associated with the origination identity.
" + }, + "OriginationIdentityArn": { + "shape": "String", + "documentation": "The PhoneNumberArn or SenderIdArn of the origination identity.
" + }, + "OriginationIdentity": { + "shape": "String", + "documentation": "The PhoneNumberId or SenderId of the origination identity.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + } + }, + "AttachmentBody": { + "type": "blob", + "max": 1572864, + "min": 1 + }, + "AttachmentStatus": { + "type": "string", + "enum": [ + "UPLOAD_IN_PROGRESS", + "UPLOAD_COMPLETE", + "UPLOAD_FAILED", + "DELETED" + ] + }, + "AttachmentUploadErrorReason": { + "type": "string", + "enum": [ + "INTERNAL_ERROR" + ] + }, + "AttachmentUrl": { + "type": "string", + "max": 2048, + "min": 1, + "pattern": "\\S+" + }, + "Boolean": { + "type": "boolean", + "box": true + }, + "ClientToken": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "[!-~]+" + }, + "CloudWatchLogsDestination": { + "type": "structure", + "required": [ + "IamRoleArn", + "LogGroupArn" + ], + "members": { + "IamRoleArn": { + "shape": "IamRoleArn", + "documentation": "The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
" + }, + "LogGroupArn": { + "shape": "LogGroupArn", + "documentation": "The name of the Amazon CloudWatch log group that you want to record events in.
" + } + }, + "documentation": "Contains the destination configuration to use when publishing message sending events.
" + }, + "ConfigurationSetFilter": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": { + "shape": "ConfigurationSetFilterName", + "documentation": "The name of the attribute to filter on.
" + }, + "Values": { + "shape": "FilterValueList", + "documentation": "An array values to filter for.
" + } + }, + "documentation": "The information for configuration sets that meet a specified criteria.
" + }, + "ConfigurationSetFilterList": { + "type": "list", + "member": { + "shape": "ConfigurationSetFilter" + }, + "max": 20, + "min": 0 + }, + "ConfigurationSetFilterName": { + "type": "string", + "enum": [ + "event-destination-name", + "matching-event-types", + "default-message-type", + "default-sender-id" + ] + }, + "ConfigurationSetInformation": { + "type": "structure", + "required": [ + "ConfigurationSetArn", + "ConfigurationSetName", + "EventDestinations", + "CreatedTimestamp" + ], + "members": { + "ConfigurationSetArn": { + "shape": "String", + "documentation": "The Resource Name (ARN) of the ConfigurationSet.
" + }, + "ConfigurationSetName": { + "shape": "ConfigurationSetName", + "documentation": "The name of the ConfigurationSet.
" + }, + "EventDestinations": { + "shape": "EventDestinationList", + "documentation": "An array of EventDestination objects that describe any events to log and where to log them.
" + }, + "DefaultMessageType": { + "shape": "MessageType", + "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "DefaultSenderId": { + "shape": "SenderId", + "documentation": "The default sender ID used by the ConfigurationSet.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the ConfigurationSet was created, in UNIX epoch time format.
" + } + }, + "documentation": "Information related to a given configuration set in your Amazon Web Services account.
" + }, + "ConfigurationSetInformationList": { + "type": "list", + "member": { + "shape": "ConfigurationSetInformation" + } + }, + "ConfigurationSetName": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "[A-Za-z0-9_-]+" + }, + "ConfigurationSetNameList": { + "type": "list", + "member": { + "shape": "ConfigurationSetNameOrArn" + }, + "max": 5, + "min": 0 + }, + "ConfigurationSetNameOrArn": { + "type": "string", + "max": 256, + "min": 1, + "pattern": "[A-Za-z0-9_:/-]+" + }, + "ContextKey": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "\\S+" + }, + "ContextMap": { + "type": "map", + "key": { + "shape": "ContextKey" + }, + "value": { + "shape": "ContextValue" + }, + "max": 5, + "min": 0 + }, + "ContextValue": { + "type": "string", + "max": 800, + "min": 1, + "pattern": "(?!\\s)^[\\s\\S]+(?The name to use for the new configuration set." + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of key and value pair tags that's associated with the new configuration set.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true + } + } + }, + "CreateConfigurationSetResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the newly created configuration set.
" + }, + "ConfigurationSetName": { + "shape": "ConfigurationSetName", + "documentation": "The name of the new configuration set.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of key and value pair tags that's associated with the configuration set.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the configuration set was created, in UNIX epoch time format.
" + } + } + }, + "CreateEventDestinationRequest": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "EventDestinationName", + "MatchingEventTypes" + ], + "members": { + "ConfigurationSetName": { + "shape": "ConfigurationSetNameOrArn", + "documentation": "Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + }, + "EventDestinationName": { + "shape": "EventDestinationName", + "documentation": "The name that identifies the event destination.
" + }, + "MatchingEventTypes": { + "shape": "EventTypeList", + "documentation": "An array of event types that determine which events to log. If \"ALL\" is used, then Amazon Pinpoint logs every event type.
The TEXT_SENT
event type is not supported.
An object that contains information about an event destination for logging to Amazon CloudWatch logs.
" + }, + "KinesisFirehoseDestination": { + "shape": "KinesisFirehoseDestination", + "documentation": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
" + }, + "SnsDestination": { + "shape": "SnsDestination", + "documentation": "An object that contains information about an event destination for logging to Amazon SNS.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true + } + } + }, + "CreateEventDestinationResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "shape": "String", + "documentation": "The ARN of the configuration set.
" + }, + "ConfigurationSetName": { + "shape": "ConfigurationSetName", + "documentation": "The name of the configuration set.
" + }, + "EventDestination": { + "shape": "EventDestination", + "documentation": "The details of the destination where events are logged.
" + } + } + }, + "CreateOptOutListRequest": { + "type": "structure", + "required": [ + "OptOutListName" + ], + "members": { + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The name of the new OptOutList.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) to associate with the new OptOutList.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true + } + } + }, + "CreateOptOutListResult": { + "type": "structure", + "members": { + "OptOutListArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the OptOutList.
" + }, + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The name of the new OptOutList.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) associated with the new OptOutList.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the pool was created, in UNIX epoch time format.
" + } + } + }, + "CreatePoolRequest": { + "type": "structure", + "required": [ + "OriginationIdentity", + "IsoCountryCode", + "MessageType" + ], + "members": { + "OriginationIdentity": { + "shape": "PhoneOrSenderIdOrArn", + "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
" + }, + "MessageType": { + "shape": "MessageType", + "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "DeletionProtectionEnabled": { + "shape": "Boolean", + "documentation": "By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) associated with the pool.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true + } + } + }, + "CreatePoolResult": { + "type": "structure", + "members": { + "PoolArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the pool.
" + }, + "PoolId": { + "shape": "String", + "documentation": "The unique identifier for the pool.
" + }, + "Status": { + "shape": "PoolStatus", + "documentation": "The current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
The type of message for the pool to use.
" + }, + "TwoWayEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn": { + "shape": "TwoWayChannelArn", + "documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + }, + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + }, + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The name of the OptOutList associated with the pool.
" + }, + "SharedRoutesEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "Indicates whether shared routes are enabled for the pool.
" + }, + "DeletionProtectionEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "When set to true deletion protection is enabled. By default this is set to false.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) associated with the pool.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the pool was created, in UNIX epoch time format.
" + } + } + }, + "CreateRegistrationAssociationRequest": { + "type": "structure", + "required": [ + "RegistrationId", + "ResourceId" + ], + "members": { + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" + }, + "ResourceId": { + "shape": "ResourceIdOrArn", + "documentation": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
" + } + } + }, + "CreateRegistrationAssociationResult": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "ResourceArn", + "ResourceId", + "ResourceType" + ], + "members": { + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "ResourceArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
" + }, + "ResourceId": { + "shape": "String", + "documentation": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
" + }, + "ResourceType": { + "shape": "String", + "documentation": "The registration type or origination identity type.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "PhoneNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number associated with the registration in E.164 format.
" + } + } + }, + "CreateRegistrationAttachmentRequest": { + "type": "structure", + "members": { + "AttachmentBody": { + "shape": "AttachmentBody", + "documentation": "The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.
" + }, + "AttachmentUrl": { + "shape": "AttachmentUrl", + "documentation": "A URL to the required registration file. For example, you can provide the S3 object URL.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) to associate with the registration attachment.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true + } + } + }, + "CreateRegistrationAttachmentResult": { + "type": "structure", + "required": [ + "RegistrationAttachmentArn", + "RegistrationAttachmentId", + "AttachmentStatus", + "CreatedTimestamp" + ], + "members": { + "RegistrationAttachmentArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration attachment.
" + }, + "RegistrationAttachmentId": { + "shape": "String", + "documentation": "The unique identifier for the registration attachment.
" + }, + "AttachmentStatus": { + "shape": "AttachmentStatus", + "documentation": "The status of the registration attachment.
UPLOAD_IN_PROGRESS
The attachment is being uploaded.
UPLOAD_COMPLETE
The attachment has been uploaded.
UPLOAD_FAILED
The attachment failed to uploaded.
DELETED
The attachment has been deleted..
An array of tags (key and value pairs) to associate with the registration attachment.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration attachment was created, in UNIX epoch time format.
" + } + } + }, + "CreateRegistrationRequest": { + "type": "structure", + "required": [ + "RegistrationType" + ], + "members": { + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) to associate with the registration.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true + } + } + }, + "CreateRegistrationResult": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationStatus", + "CurrentVersionNumber", + "CreatedTimestamp" + ], + "members": { + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "RegistrationStatus": { + "shape": "RegistrationStatus", + "documentation": "The status of the registration.
CREATED
: Your registration is created but not submitted.
SUBMITTED
: Your registration has been submitted and is awaiting review.
REVIEWING
: Your registration has been accepted and is being reviewed.
PROVISIONING
: Your registration has been approved and your origination identity is being created.
COMPLETE
: Your registration has been approved and and your origination identity has been created.
REQUIRES_UPDATES
: You must fix your registration and resubmit it.
CLOSED
: The phone number or sender ID has been deleted and you must also delete the registration for the number.
DELETED
: The registration has been deleted.
The current version number of the registration.
" + }, + "AdditionalAttributes": { + "shape": "StringMap", + "documentation": "Metadata about a given registration which is specific to that registration type.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) to associate with the registration.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration was created, in UNIX epoch time format.
" + } + } + }, + "CreateRegistrationVersionRequest": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" + } + } + }, + "CreateRegistrationVersionResult": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members": { + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "VersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The new version number of the registration.
" + }, + "RegistrationVersionStatus": { + "shape": "RegistrationVersionStatus", + "documentation": "The status of the registration.
DRAFT
: The initial status of a registration version after it’s created.
SUBMITTED
: Your registration has been submitted.
REVIEWING
: Your registration has been accepted and is being reviewed.
APPROVED
: Your registration has been approved.
DISCARDED
: You've abandon this version of their registration to start over with a new version.
DENIED
: You must fix your registration and resubmit it.
REVOKED
: Your previously approved registration has been revoked.
ARCHIVED
: Your previously approved registration version moves into this status when a more recently submitted version is approved.
A RegistrationVersionStatusHistory object that contains timestamps for the registration.
" + } + } + }, + "CreateVerifiedDestinationNumberRequest": { + "type": "structure", + "required": [ + "DestinationPhoneNumber" + ], + "members": { + "DestinationPhoneNumber": { + "shape": "PhoneNumber", + "documentation": "The verified destination phone number, in E.164 format.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) to associate with the destination number.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true + } + } + }, + "CreateVerifiedDestinationNumberResult": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "Status", + "CreatedTimestamp" + ], + "members": { + "VerifiedDestinationNumberArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
" + }, + "VerifiedDestinationNumberId": { + "shape": "String", + "documentation": "The unique identifier for the verified destination phone number.
" + }, + "DestinationPhoneNumber": { + "shape": "PhoneNumber", + "documentation": "The verified destination phone number, in E.164 format.
" + }, + "Status": { + "shape": "VerificationStatus", + "documentation": "The status of the verified destination phone number.
PENDING
: The phone number hasn't been verified yet.
VERIFIED
: The phone number is verified and can receive messages.
An array of tags (key and value pairs) to associate with the destination number.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the verified phone number was created, in UNIX epoch time format.
" + } + } + }, + "DeleteConfigurationSetRequest": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "shape": "ConfigurationSetNameOrArn", + "documentation": "The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + } + } + }, + "DeleteConfigurationSetResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the deleted configuration set.
" + }, + "ConfigurationSetName": { + "shape": "ConfigurationSetName", + "documentation": "The name of the deleted configuration set.
" + }, + "EventDestinations": { + "shape": "EventDestinationList", + "documentation": "An array of any EventDestination objects that were associated with the deleted configuration set.
" + }, + "DefaultMessageType": { + "shape": "MessageType", + "documentation": "The default message type of the configuration set that was deleted.
" + }, + "DefaultSenderId": { + "shape": "SenderId", + "documentation": "The default Sender ID of the configuration set that was deleted.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time that the deleted configuration set was created in UNIX epoch time format.
" + } + } + }, + "DeleteDefaultMessageTypeRequest": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "shape": "ConfigurationSetNameOrArn", + "documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + } + } + }, + "DeleteDefaultMessageTypeResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + }, + "ConfigurationSetName": { + "shape": "ConfigurationSetName", + "documentation": "The name of the configuration set.
" + }, + "MessageType": { + "shape": "MessageType", + "documentation": "The current message type for the configuration set.
" + } + } + }, + "DeleteDefaultSenderIdRequest": { + "type": "structure", + "required": [ + "ConfigurationSetName" + ], + "members": { + "ConfigurationSetName": { + "shape": "ConfigurationSetNameOrArn", + "documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + } + } + }, + "DeleteDefaultSenderIdResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + }, + "ConfigurationSetName": { + "shape": "ConfigurationSetName", + "documentation": "The name of the configuration set.
" + }, + "SenderId": { + "shape": "SenderId", + "documentation": "The current sender ID for the configuration set.
" + } + } + }, + "DeleteEventDestinationRequest": { + "type": "structure", + "required": [ + "ConfigurationSetName", + "EventDestinationName" + ], + "members": { + "ConfigurationSetName": { + "shape": "ConfigurationSetNameOrArn", + "documentation": "The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + }, + "EventDestinationName": { + "shape": "EventDestinationName", + "documentation": "The name of the event destination to delete.
" + } + } + }, + "DeleteEventDestinationResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + }, + "ConfigurationSetName": { + "shape": "ConfigurationSetName", + "documentation": "The name of the configuration set the event destination was deleted from.
" + }, + "EventDestination": { + "shape": "EventDestination", + "documentation": "The event destination object that was deleted.
" + } + } + }, + "DeleteKeywordRequest": { + "type": "structure", + "required": [ + "OriginationIdentity", + "Keyword" + ], + "members": { + "OriginationIdentity": { + "shape": "PhoneOrPoolIdOrArn", + "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
" + }, + "Keyword": { + "shape": "Keyword", + "documentation": "The keyword to delete.
" + } + } + }, + "DeleteKeywordResult": { + "type": "structure", + "members": { + "OriginationIdentityArn": { + "shape": "String", + "documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" + }, + "OriginationIdentity": { + "shape": "String", + "documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" + }, + "Keyword": { + "shape": "Keyword", + "documentation": "The keyword that was deleted.
" + }, + "KeywordMessage": { + "shape": "KeywordMessage", + "documentation": "The message that was associated with the deleted keyword.
" + }, + "KeywordAction": { + "shape": "KeywordAction", + "documentation": "The action that was associated with the deleted keyword.
" + } + } + }, + "DeleteOptOutListRequest": { + "type": "structure", + "required": [ + "OptOutListName" + ], + "members": { + "OptOutListName": { + "shape": "OptOutListNameOrArn", + "documentation": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
" + } + } + }, + "DeleteOptOutListResult": { + "type": "structure", + "members": { + "OptOutListArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the OptOutList that was removed.
" + }, + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The name of the OptOutList that was removed.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the OptOutList was created, in UNIX epoch time format.
" + } + } + }, + "DeleteOptedOutNumberRequest": { + "type": "structure", + "required": [ + "OptOutListName", + "OptedOutNumber" + ], + "members": { + "OptOutListName": { + "shape": "OptOutListNameOrArn", + "documentation": "The OptOutListName or OptOutListArn to remove the phone number from.
" + }, + "OptedOutNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number, in E.164 format, to remove from the OptOutList.
" + } + } + }, + "DeleteOptedOutNumberResult": { + "type": "structure", + "members": { + "OptOutListArn": { + "shape": "String", + "documentation": "The OptOutListArn that the phone number was removed from.
" + }, + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The OptOutListName that the phone number was removed from.
" + }, + "OptedOutNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number that was removed from the OptOutList.
" + }, + "OptedOutTimestamp": { + "shape": "Timestamp", + "documentation": "The time that the number was removed at, in UNIX epoch time format.
" + }, + "EndUserOptedOut": { + "shape": "PrimitiveBoolean", + "documentation": "This is true if it was the end user who requested their phone number be removed.
" + } + } + }, + "DeletePoolRequest": { + "type": "structure", + "required": [ + "PoolId" + ], + "members": { + "PoolId": { + "shape": "PoolIdOrArn", + "documentation": "The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
" + } + } + }, + "DeletePoolResult": { + "type": "structure", + "members": { + "PoolArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the pool that was deleted.
" + }, + "PoolId": { + "shape": "String", + "documentation": "The PoolId of the pool that was deleted.
" + }, + "Status": { + "shape": "PoolStatus", + "documentation": "The current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
The message type that was associated with the deleted pool.
" + }, + "TwoWayEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + }, + "TwoWayChannelArn": { + "shape": "TwoWayChannelArn", + "documentation": "The Amazon Resource Name (ARN) of the TwoWayChannel.
" + }, + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + }, + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The name of the OptOutList that was associated with the deleted pool.
" + }, + "SharedRoutesEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "Indicates whether shared routes are enabled for the pool.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the pool was created, in UNIX epoch time format.
" + } + } + }, + "DeleteRegistrationAttachmentRequest": { + "type": "structure", + "required": [ + "RegistrationAttachmentId" + ], + "members": { + "RegistrationAttachmentId": { + "shape": "RegistrationAttachmentIdOrArn", + "documentation": "The unique identifier for the registration attachment.
" + } + } + }, + "DeleteRegistrationAttachmentResult": { + "type": "structure", + "required": [ + "RegistrationAttachmentArn", + "RegistrationAttachmentId", + "AttachmentStatus", + "CreatedTimestamp" + ], + "members": { + "RegistrationAttachmentArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration attachment.
" + }, + "RegistrationAttachmentId": { + "shape": "String", + "documentation": "The unique identifier for the registration attachment.
" + }, + "AttachmentStatus": { + "shape": "AttachmentStatus", + "documentation": "The status of the registration attachment.
UPLOAD_IN_PROGRESS
The attachment is being uploaded.
UPLOAD_COMPLETE
The attachment has been uploaded.
UPLOAD_FAILED
The attachment failed to uploaded.
DELETED
The attachment has been deleted..
The error message if the upload failed.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration attachment was created, in UNIX epoch time format.
" + } + } + }, + "DeleteRegistrationFieldValueRequest": { + "type": "structure", + "required": [ + "RegistrationId", + "FieldPath" + ], + "members": { + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" + }, + "FieldPath": { + "shape": "FieldPath", + "documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" + } + } + }, + "DeleteRegistrationFieldValueResult": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "FieldPath" + ], + "members": { + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "VersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The version number of the registration.
" + }, + "FieldPath": { + "shape": "FieldPath", + "documentation": "The path to the registration form field.
" + }, + "SelectChoices": { + "shape": "SelectChoiceList", + "documentation": "An array of values for the form field.
" + }, + "TextValue": { + "shape": "TextValue", + "documentation": "The text data for a free form field.
" + }, + "RegistrationAttachmentId": { + "shape": "String", + "documentation": "The unique identifier for the registration attachment.
" + } + } + }, + "DeleteRegistrationRequest": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" + } + } + }, + "DeleteRegistrationResult": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationStatus", + "CurrentVersionNumber", + "CreatedTimestamp" + ], + "members": { + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "RegistrationStatus": { + "shape": "RegistrationStatus", + "documentation": "The status of the registration.
CREATED
: Your registration is created but not submitted.
SUBMITTED
: Your registration has been submitted and is awaiting review.
REVIEWING
: Your registration has been accepted and is being reviewed.
PROVISIONING
: Your registration has been approved and your origination identity is being created.
COMPLETE
: Your registration has been approved and and your origination identity has been created.
REQUIRES_UPDATES
: You must fix your registration and resubmit it.
CLOSED
: The phone number or sender ID has been deleted and you must also delete the registration for the number.
DELETED
: The registration has been deleted.
The current version number of the registration.
" + }, + "ApprovedVersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The version number of the registration that was approved.
" + }, + "LatestDeniedVersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The latest version number of the registration that was denied.
" + }, + "AdditionalAttributes": { + "shape": "StringMap", + "documentation": "Metadata about a given registration which is specific to that registration type.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration was created, in UNIX epoch time format.
" + } + } + }, + "DeleteTextMessageSpendLimitOverrideRequest": { + "type": "structure", + "members": {} + }, + "DeleteTextMessageSpendLimitOverrideResult": { + "type": "structure", + "members": { + "MonthlyLimit": { + "shape": "MonthlyLimit", + "documentation": "The current monthly limit, in US dollars.
" + } + } + }, + "DeleteVerifiedDestinationNumberRequest": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberId" + ], + "members": { + "VerifiedDestinationNumberId": { + "shape": "VerifiedDestinationNumberIdOrArn", + "documentation": "The unique identifier for the verified destination phone number.
" + } + } + }, + "DeleteVerifiedDestinationNumberResult": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "CreatedTimestamp" + ], + "members": { + "VerifiedDestinationNumberArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
" + }, + "VerifiedDestinationNumberId": { + "shape": "String", + "documentation": "The unique identifier for the verified destination phone number.
" + }, + "DestinationPhoneNumber": { + "shape": "PhoneNumber", + "documentation": "The verified destination phone number, in E.164 format.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the destination phone number was created, in UNIX epoch time format.
" + } + } + }, + "DeleteVoiceMessageSpendLimitOverrideRequest": { + "type": "structure", + "members": {} + }, + "DeleteVoiceMessageSpendLimitOverrideResult": { + "type": "structure", + "members": { + "MonthlyLimit": { + "shape": "MonthlyLimit", + "documentation": "The current monthly limit, in US dollars.
" + } + } + }, + "DeliveryStreamArn": { + "type": "string", + "max": 2048, + "min": 20, + "pattern": "arn:\\S+" + }, + "DescribeAccountAttributesRequest": { + "type": "structure", + "members": { + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" + } + } + }, + "DescribeAccountAttributesResult": { + "type": "structure", + "members": { + "AccountAttributes": { + "shape": "AccountAttributeList", + "documentation": "An array of AccountAttributes objects.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } }, - "AccountAttributeList": { - "type": "list", - "member": { - "shape": "AccountAttribute" + "DescribeAccountLimitsRequest": { + "type": "structure", + "members": { + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" + } } }, - "AccountAttributeName": { - "type": "string", - "enum": [ - "ACCOUNT_TIER" - ] + "DescribeAccountLimitsResult": { + "type": "structure", + "members": { + "AccountLimits": { + "shape": "AccountLimitList", + "documentation": "An array of AccountLimit objects that show the current spend limits.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } }, - "AccountLimit": { + "DescribeConfigurationSetsRequest": { + "type": "structure", + "members": { + "ConfigurationSetNames": { + "shape": "ConfigurationSetNameList", + "documentation": "An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
" + }, + "Filters": { + "shape": "ConfigurationSetFilterList", + "documentation": "An array of filters to apply to the results that are returned.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" + } + } + }, + "DescribeConfigurationSetsResult": { + "type": "structure", + "members": { + "ConfigurationSets": { + "shape": "ConfigurationSetInformationList", + "documentation": "An array of ConfigurationSets objects.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribeKeywordsRequest": { "type": "structure", "required": [ - "Name", - "Used", - "Max" + "OriginationIdentity" ], "members": { - "Name": { - "shape": "AccountLimitName", - "documentation": "The name of the attribute to apply the account limit to.
" + "OriginationIdentity": { + "shape": "PhoneOrPoolIdOrArn", + "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
" }, - "Used": { - "shape": "PrimitiveLong", - "documentation": "The current amount that has been spent, in US dollars.
" + "Keywords": { + "shape": "KeywordList", + "documentation": "An array of keywords to search for.
" }, - "Max": { - "shape": "PrimitiveLong", - "documentation": "The Amazon Web Services set limit for that resource type, in US dollars.
" + "Filters": { + "shape": "KeywordFilterList", + "documentation": "An array of keyword filters to filter the results.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } - }, - "documentation": "The current resource quotas associated with an Amazon Web Services account.
" + } }, - "AccountLimitList": { - "type": "list", - "member": { - "shape": "AccountLimit" + "DescribeKeywordsResult": { + "type": "structure", + "members": { + "OriginationIdentityArn": { + "shape": "String", + "documentation": "The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
" + }, + "OriginationIdentity": { + "shape": "String", + "documentation": "The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
" + }, + "Keywords": { + "shape": "KeywordInformationList", + "documentation": "An array of KeywordInformation objects that contain the results.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } } }, - "AccountLimitName": { - "type": "string", - "enum": [ - "PHONE_NUMBERS", - "POOLS", - "CONFIGURATION_SETS", - "OPT_OUT_LISTS" - ] + "DescribeOptOutListsRequest": { + "type": "structure", + "members": { + "OptOutListNames": { + "shape": "OptOutListNameList", + "documentation": "The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" + } + } }, - "AmazonResourceName": { - "type": "string", - "max": 256, - "min": 20, - "pattern": "arn:[A-Za-z0-9_:/-]+" + "DescribeOptOutListsResult": { + "type": "structure", + "members": { + "OptOutLists": { + "shape": "OptOutListInformationList", + "documentation": "An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } }, - "AssociateOriginationIdentityRequest": { + "DescribeOptedOutNumbersRequest": { "type": "structure", "required": [ - "PoolId", - "OriginationIdentity", - "IsoCountryCode" + "OptOutListName" ], "members": { - "PoolId": { - "shape": "PoolIdOrArn", - "documentation": "The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
" + "OptOutListName": { + "shape": "OptOutListNameOrArn", + "documentation": "The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
" }, - "OriginationIdentity": { - "shape": "PhoneOrSenderIdOrArn", - "documentation": "The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
" + "OptedOutNumbers": { + "shape": "OptedOutNumberList", + "documentation": "An array of phone numbers to search for in the OptOutList.
" }, - "IsoCountryCode": { - "shape": "IsoCountryCode", - "documentation": "The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
" + "Filters": { + "shape": "OptedOutFilterList", + "documentation": "An array of OptedOutFilter objects to filter the results on.
" }, - "ClientToken": { - "shape": "ClientToken", - "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", - "idempotencyToken": true + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "AssociateOriginationIdentityResult": { + "DescribeOptedOutNumbersResult": { "type": "structure", "members": { - "PoolArn": { + "OptOutListArn": { "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
" + "documentation": "The Amazon Resource Name (ARN) of the OptOutList.
" }, - "PoolId": { - "shape": "String", - "documentation": "The PoolId of the pool that is now associated with the origination identity.
" + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The name of the OptOutList.
" }, - "OriginationIdentityArn": { - "shape": "String", - "documentation": "The PhoneNumberArn or SenderIdArn of the origination identity.
" + "OptedOutNumbers": { + "shape": "OptedOutNumberInformationList", + "documentation": "An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
" }, - "OriginationIdentity": { - "shape": "String", - "documentation": "The PhoneNumberId or SenderId of the origination identity.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + } + } + }, + "DescribePhoneNumbersRequest": { + "type": "structure", + "members": { + "PhoneNumberIds": { + "shape": "PhoneNumberIdList", + "documentation": "The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
" }, - "IsoCountryCode": { - "shape": "IsoCountryCode", - "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + "Filters": { + "shape": "PhoneNumberFilterList", + "documentation": "An array of PhoneNumberFilter objects to filter the results.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" + } + } + }, + "DescribePhoneNumbersResult": { + "type": "structure", + "members": { + "PhoneNumbers": { + "shape": "PhoneNumberInformationList", + "documentation": "An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, - "Boolean": { - "type": "boolean", - "box": true - }, - "ClientToken": { - "type": "string", - "max": 64, - "min": 1, - "pattern": "[!-~]+" - }, - "CloudWatchLogsDestination": { + "DescribePoolsRequest": { "type": "structure", - "required": [ - "IamRoleArn", - "LogGroupArn" - ], "members": { - "IamRoleArn": { - "shape": "IamRoleArn", - "documentation": "The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
" + "PoolIds": { + "shape": "PoolIdList", + "documentation": "The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
" }, - "LogGroupArn": { - "shape": "LogGroupArn", - "documentation": "The name of the Amazon CloudWatch log group that you want to record events in.
" + "Filters": { + "shape": "PoolFilterList", + "documentation": "An array of PoolFilter objects to filter the results.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } - }, - "documentation": "Contains the destination configuration to use when publishing message sending events.
" + } }, - "ConfigurationSetFilter": { + "DescribePoolsResult": { "type": "structure", - "required": [ - "Name", - "Values" - ], "members": { - "Name": { - "shape": "ConfigurationSetFilterName", - "documentation": "The name of the attribute to filter on.
" + "Pools": { + "shape": "PoolInformationList", + "documentation": "An array of PoolInformation objects that contain the details for the requested pools.
" }, - "Values": { - "shape": "FilterValueList", - "documentation": "An array values to filter for.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } - }, - "documentation": "The information for configuration sets that meet a specified criteria.
" - }, - "ConfigurationSetFilterList": { - "type": "list", - "member": { - "shape": "ConfigurationSetFilter" - }, - "max": 20, - "min": 0 - }, - "ConfigurationSetFilterName": { - "type": "string", - "enum": [ - "event-destination-name", - "matching-event-types", - "default-message-type", - "default-sender-id" - ] + } }, - "ConfigurationSetInformation": { + "DescribeRegistrationAttachmentsRequest": { "type": "structure", - "required": [ - "ConfigurationSetArn", - "ConfigurationSetName", - "EventDestinations", - "CreatedTimestamp" - ], "members": { - "ConfigurationSetArn": { - "shape": "String", - "documentation": "The Resource Name (ARN) of the ConfigurationSet.
" - }, - "ConfigurationSetName": { - "shape": "ConfigurationSetName", - "documentation": "The name of the ConfigurationSet.
" - }, - "EventDestinations": { - "shape": "EventDestinationList", - "documentation": "An array of EventDestination objects that describe any events to log and where to log them.
" + "RegistrationAttachmentIds": { + "shape": "RegistrationAttachmentIdList", + "documentation": "The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.
" }, - "DefaultMessageType": { - "shape": "MessageType", - "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + "Filters": { + "shape": "RegistrationAttachmentFilterList", + "documentation": "An array of RegistrationAttachmentFilter objects to filter the results.
" }, - "DefaultSenderId": { - "shape": "SenderId", - "documentation": "The default sender ID used by the ConfigurationSet.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" }, - "CreatedTimestamp": { - "shape": "Timestamp", - "documentation": "The time when the ConfigurationSet was created, in UNIX epoch time format.
" + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } - }, - "documentation": "Information related to a given configuration set in your Amazon Web Services account.
" - }, - "ConfigurationSetInformationList": { - "type": "list", - "member": { - "shape": "ConfigurationSetInformation" } }, - "ConfigurationSetName": { - "type": "string", - "max": 64, - "min": 1, - "pattern": "[A-Za-z0-9_-]+" - }, - "ConfigurationSetNameList": { - "type": "list", - "member": { - "shape": "ConfigurationSetNameOrArn" - }, - "max": 5, - "min": 0 - }, - "ConfigurationSetNameOrArn": { - "type": "string", - "max": 256, - "min": 1, - "pattern": "[A-Za-z0-9_:/-]+" - }, - "ContextKey": { - "type": "string", - "max": 100, - "min": 1, - "pattern": "\\S+" - }, - "ContextMap": { - "type": "map", - "key": { - "shape": "ContextKey" - }, - "value": { - "shape": "ContextValue" - }, - "max": 5, - "min": 0 - }, - "ContextValue": { - "type": "string", - "max": 800, - "min": 1, - "pattern": "\\S+" - }, - "CreateConfigurationSetRequest": { + "DescribeRegistrationAttachmentsResult": { "type": "structure", "required": [ - "ConfigurationSetName" + "RegistrationAttachments" ], "members": { - "ConfigurationSetName": { - "shape": "ConfigurationSetName", - "documentation": "The name to use for the new configuration set.
" - }, - "Tags": { - "shape": "TagList", - "documentation": "An array of key and value pair tags that's associated with the new configuration set.
" + "RegistrationAttachments": { + "shape": "RegistrationAttachmentsInformationList", + "documentation": "An array of RegistrationAttachments objects that contain the details for the requested registration attachments.
" }, - "ClientToken": { - "shape": "ClientToken", - "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", - "idempotencyToken": true + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, - "CreateConfigurationSetResult": { + "DescribeRegistrationFieldDefinitionsRequest": { "type": "structure", + "required": [ + "RegistrationType" + ], "members": { - "ConfigurationSetArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the newly created configuration set.
" + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" }, - "ConfigurationSetName": { - "shape": "ConfigurationSetName", - "documentation": "The name of the new configuration set.
" + "SectionPath": { + "shape": "SectionPath", + "documentation": "The path to the section of the registration.
" }, - "Tags": { - "shape": "TagList", - "documentation": "An array of key and value pair tags that's associated with the configuration set.
" + "FieldPaths": { + "shape": "FieldPathList", + "documentation": "An array of paths to the registration form field.
" }, - "CreatedTimestamp": { - "shape": "Timestamp", - "documentation": "The time when the configuration set was created, in UNIX epoch time format.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "CreateEventDestinationRequest": { + "DescribeRegistrationFieldDefinitionsResult": { "type": "structure", "required": [ - "ConfigurationSetName", - "EventDestinationName", - "MatchingEventTypes" + "RegistrationType", + "RegistrationFieldDefinitions" ], "members": { - "ConfigurationSetName": { - "shape": "ConfigurationSetNameOrArn", - "documentation": "Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" - }, - "EventDestinationName": { - "shape": "EventDestinationName", - "documentation": "The name that identifies the event destination.
" - }, - "MatchingEventTypes": { - "shape": "EventTypeList", - "documentation": "An array of event types that determine which events to log. If \"ALL\" is used, then Amazon Pinpoint logs every event type.
" - }, - "CloudWatchLogsDestination": { - "shape": "CloudWatchLogsDestination", - "documentation": "An object that contains information about an event destination for logging to Amazon CloudWatch logs.
" - }, - "KinesisFirehoseDestination": { - "shape": "KinesisFirehoseDestination", - "documentation": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
" + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" }, - "SnsDestination": { - "shape": "SnsDestination", - "documentation": "An object that contains information about an event destination for logging to Amazon SNS.
" + "RegistrationFieldDefinitions": { + "shape": "RegistrationFieldDefinitionList", + "documentation": "An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
" }, - "ClientToken": { - "shape": "ClientToken", - "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", - "idempotencyToken": true + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, - "CreateEventDestinationResult": { + "DescribeRegistrationFieldValuesRequest": { "type": "structure", + "required": [ + "RegistrationId" + ], "members": { - "ConfigurationSetArn": { - "shape": "String", - "documentation": "The ARN of the configuration set.
" + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" }, - "ConfigurationSetName": { - "shape": "ConfigurationSetName", - "documentation": "The name of the configuration set.
" + "VersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The version number of the registration.
" }, - "EventDestination": { - "shape": "EventDestination", - "documentation": "The details of the destination where events are logged.
" + "SectionPath": { + "shape": "SectionPath", + "documentation": "The path to the section of the registration.
" + }, + "FieldPaths": { + "shape": "FieldPathList", + "documentation": "An array of paths to the registration form field.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "CreateOptOutListRequest": { + "DescribeRegistrationFieldValuesResult": { "type": "structure", "required": [ - "OptOutListName" + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationFieldValues" ], "members": { - "OptOutListName": { - "shape": "OptOutListName", - "documentation": "The name of the new OptOutList.
" + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" }, - "Tags": { - "shape": "TagList", - "documentation": "An array of tags (key and value pairs) to associate with the new OptOutList.
" + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" }, - "ClientToken": { - "shape": "ClientToken", - "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", - "idempotencyToken": true + "VersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The current version of the registration.
" + }, + "RegistrationFieldValues": { + "shape": "RegistrationFieldValueInformationList", + "documentation": "An array of RegistrationFieldValues objects that contain the values for the requested registration.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, - "CreateOptOutListResult": { + "DescribeRegistrationSectionDefinitionsRequest": { "type": "structure", + "required": [ + "RegistrationType" + ], "members": { - "OptOutListArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) for the OptOutList.
" + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" }, - "OptOutListName": { - "shape": "OptOutListName", - "documentation": "The name of the new OptOutList.
" + "SectionPaths": { + "shape": "SectionPathList", + "documentation": "An array of paths for the registration form section.
" }, - "Tags": { - "shape": "TagList", - "documentation": "An array of tags (key and value pairs) associated with the new OptOutList.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" }, - "CreatedTimestamp": { - "shape": "Timestamp", - "documentation": "The time when the pool was created, in UNIX epoch time format.
" + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "CreatePoolRequest": { + "DescribeRegistrationSectionDefinitionsResult": { "type": "structure", "required": [ - "OriginationIdentity", - "IsoCountryCode", - "MessageType" + "RegistrationType", + "RegistrationSectionDefinitions" ], "members": { - "OriginationIdentity": { - "shape": "PhoneOrSenderIdOrArn", - "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
" + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" }, - "IsoCountryCode": { - "shape": "IsoCountryCode", - "documentation": "The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
" - }, - "MessageType": { - "shape": "MessageType", - "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" - }, - "DeletionProtectionEnabled": { - "shape": "Boolean", - "documentation": "By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
" - }, - "Tags": { - "shape": "TagList", - "documentation": "An array of tags (key and value pairs) associated with the pool.
" + "RegistrationSectionDefinitions": { + "shape": "RegistrationSectionDefinitionList", + "documentation": "An array of RegistrationSectionDefinition objects.
" }, - "ClientToken": { - "shape": "ClientToken", - "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", - "idempotencyToken": true + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, - "CreatePoolResult": { + "DescribeRegistrationTypeDefinitionsRequest": { "type": "structure", "members": { - "PoolArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) for the pool.
" - }, - "PoolId": { - "shape": "String", - "documentation": "The unique identifier for the pool.
" - }, - "Status": { - "shape": "PoolStatus", - "documentation": "The current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
The type of message for the pool to use.
" - }, - "TwoWayEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" - }, - "TwoWayChannelArn": { - "shape": "TwoWayChannelArn", - "documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - }, - "SelfManagedOptOutsEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" - }, - "OptOutListName": { - "shape": "OptOutListName", - "documentation": "The name of the OptOutList associated with the pool.
" - }, - "SharedRoutesEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "Indicates whether shared routes are enabled for the pool.
" + "RegistrationTypes": { + "shape": "RegistrationTypeList", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" }, - "DeletionProtectionEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "When set to true deletion protection is enabled. By default this is set to false.
" + "Filters": { + "shape": "RegistrationTypeFilterList", + "documentation": "An array of RegistrationFilter objects to filter the results.
" }, - "Tags": { - "shape": "TagList", - "documentation": "An array of tags (key and value pairs) associated with the pool.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" }, - "CreatedTimestamp": { - "shape": "Timestamp", - "documentation": "The time when the pool was created, in UNIX epoch time format.
" + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "DeleteConfigurationSetRequest": { + "DescribeRegistrationTypeDefinitionsResult": { "type": "structure", "required": [ - "ConfigurationSetName" + "RegistrationTypeDefinitions" ], "members": { - "ConfigurationSetName": { - "shape": "ConfigurationSetNameOrArn", - "documentation": "The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + "RegistrationTypeDefinitions": { + "shape": "RegistrationTypeDefinitionList", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, - "DeleteConfigurationSetResult": { + "DescribeRegistrationVersionsRequest": { "type": "structure", + "required": [ + "RegistrationId" + ], "members": { - "ConfigurationSetArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the deleted configuration set.
" - }, - "ConfigurationSetName": { - "shape": "ConfigurationSetName", - "documentation": "The name of the deleted configuration set.
" + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" }, - "EventDestinations": { - "shape": "EventDestinationList", - "documentation": "An array of any EventDestination objects that were associated with the deleted configuration set.
" + "VersionNumbers": { + "shape": "RegistrationVersionNumberList", + "documentation": "An array of registration version numbers.
" }, - "DefaultMessageType": { - "shape": "MessageType", - "documentation": "The default message type of the configuration set that was deleted.
" + "Filters": { + "shape": "RegistrationVersionFilterList", + "documentation": "An array of RegistrationVersionFilter objects to filter the results.
" }, - "DefaultSenderId": { - "shape": "SenderId", - "documentation": "The default Sender ID of the configuration set that was deleted.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" }, - "CreatedTimestamp": { - "shape": "Timestamp", - "documentation": "The time that the deleted configuration set was created in UNIX epoch time format.
" + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "DeleteDefaultMessageTypeRequest": { + "DescribeRegistrationVersionsResult": { "type": "structure", "required": [ - "ConfigurationSetName" + "RegistrationArn", + "RegistrationId", + "RegistrationVersions" ], "members": { - "ConfigurationSetName": { - "shape": "ConfigurationSetNameOrArn", - "documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "RegistrationVersions": { + "shape": "RegistrationVersionInformationList", + "documentation": "An array of RegistrationVersions objects.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, - "DeleteDefaultMessageTypeResult": { + "DescribeRegistrationsRequest": { "type": "structure", "members": { - "ConfigurationSetArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + "RegistrationIds": { + "shape": "RegistrationIdList", + "documentation": "An array of unique identifiers for each registration.
" }, - "ConfigurationSetName": { - "shape": "ConfigurationSetName", - "documentation": "The name of the configuration set.
" + "Filters": { + "shape": "RegistrationFilterList", + "documentation": "An array of RegistrationFilter objects to filter the results.
" }, - "MessageType": { - "shape": "MessageType", - "documentation": "The current message type for the configuration set.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "DeleteDefaultSenderIdRequest": { + "DescribeRegistrationsResult": { "type": "structure", "required": [ - "ConfigurationSetName" + "Registrations" ], "members": { - "ConfigurationSetName": { - "shape": "ConfigurationSetNameOrArn", - "documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + "Registrations": { + "shape": "RegistrationInformationList", + "documentation": "An array of RegistrationInformation objects.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, - "DeleteDefaultSenderIdResult": { + "DescribeSenderIdsRequest": { "type": "structure", "members": { - "ConfigurationSetArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + "SenderIds": { + "shape": "SenderIdList", + "documentation": "An array of SenderIdAndCountry objects to search for.
" }, - "ConfigurationSetName": { - "shape": "ConfigurationSetName", - "documentation": "The name of the configuration set.
" + "Filters": { + "shape": "SenderIdFilterList", + "documentation": "An array of SenderIdFilter objects to filter the results.
" }, - "SenderId": { - "shape": "SenderId", - "documentation": "The current sender ID for the configuration set.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "DeleteEventDestinationRequest": { + "DescribeSenderIdsResult": { "type": "structure", - "required": [ - "ConfigurationSetName", - "EventDestinationName" - ], "members": { - "ConfigurationSetName": { - "shape": "ConfigurationSetNameOrArn", - "documentation": "The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
" + "SenderIds": { + "shape": "SenderIdInformationList", + "documentation": "An array of SernderIdInformation objects that contain the details for the requested SenderIds.
" }, - "EventDestinationName": { - "shape": "EventDestinationName", - "documentation": "The name of the event destination to delete.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, - "DeleteEventDestinationResult": { + "DescribeSpendLimitsRequest": { "type": "structure", "members": { - "ConfigurationSetArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the configuration set.
" - }, - "ConfigurationSetName": { - "shape": "ConfigurationSetName", - "documentation": "The name of the configuration set the event destination was deleted from.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" }, - "EventDestination": { - "shape": "EventDestination", - "documentation": "The event destination object that was deleted.
" + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "DeleteKeywordRequest": { + "DescribeSpendLimitsResult": { "type": "structure", - "required": [ - "OriginationIdentity", - "Keyword" - ], "members": { - "OriginationIdentity": { - "shape": "PhoneOrPoolIdOrArn", - "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
" + "SpendLimits": { + "shape": "SpendLimitList", + "documentation": "An array of SpendLimit objects that contain the details for the requested spend limits.
" }, - "Keyword": { - "shape": "Keyword", - "documentation": "The keyword to delete.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, - "DeleteKeywordResult": { + "DescribeVerifiedDestinationNumbersRequest": { "type": "structure", "members": { - "OriginationIdentityArn": { - "shape": "String", - "documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" + "VerifiedDestinationNumberIds": { + "shape": "VerifiedDestinationNumberIdList", + "documentation": "An array of VerifiedDestinationNumberid to retreive.
" }, - "OriginationIdentity": { - "shape": "String", - "documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" + "DestinationPhoneNumbers": { + "shape": "DestinationPhoneNumberList", + "documentation": "An array of verified destination phone number, in E.164 format.
" }, - "Keyword": { - "shape": "Keyword", - "documentation": "The keyword that was deleted.
" + "Filters": { + "shape": "VerifiedDestinationNumberFilterList", + "documentation": "An array of VerifiedDestinationNumberFilter objects to filter the results.
" }, - "KeywordMessage": { - "shape": "KeywordMessage", - "documentation": "The message that was associated with the deleted keyword.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" }, - "KeywordAction": { - "shape": "KeywordAction", - "documentation": "The action that was associated with the deleted keyword.
" + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return per each request.
" } } }, - "DeleteOptOutListRequest": { + "DescribeVerifiedDestinationNumbersResult": { "type": "structure", "required": [ - "OptOutListName" + "VerifiedDestinationNumbers" ], "members": { - "OptOutListName": { - "shape": "OptOutListNameOrArn", - "documentation": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
" - } - } - }, - "DeleteOptOutListResult": { - "type": "structure", - "members": { - "OptOutListArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the OptOutList that was removed.
" - }, - "OptOutListName": { - "shape": "OptOutListName", - "documentation": "The name of the OptOutList that was removed.
" + "VerifiedDestinationNumbers": { + "shape": "VerifiedDestinationNumberInformationList", + "documentation": "An array of VerifiedDestinationNumberInformation objects
" }, - "CreatedTimestamp": { - "shape": "Timestamp", - "documentation": "The time when the OptOutList was created, in UNIX epoch time format.
" + "NextToken": { + "shape": "NextToken", + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, - "DeleteOptedOutNumberRequest": { + "DestinationCountryParameterKey": { + "type": "string", + "enum": [ + "IN_TEMPLATE_ID", + "IN_ENTITY_ID" + ] + }, + "DestinationCountryParameterValue": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "\\S+" + }, + "DestinationCountryParameters": { + "type": "map", + "key": { + "shape": "DestinationCountryParameterKey" + }, + "value": { + "shape": "DestinationCountryParameterValue" + }, + "max": 10, + "min": 0 + }, + "DestinationPhoneNumberList": { + "type": "list", + "member": { + "shape": "PhoneNumber" + }, + "max": 5, + "min": 0 + }, + "DisassociateOriginationIdentityRequest": { "type": "structure", "required": [ - "OptOutListName", - "OptedOutNumber" + "PoolId", + "OriginationIdentity", + "IsoCountryCode" ], "members": { - "OptOutListName": { - "shape": "OptOutListNameOrArn", - "documentation": "The OptOutListName or OptOutListArn to remove the phone number from.
" + "PoolId": { + "shape": "PoolIdOrArn", + "documentation": "The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
" }, - "OptedOutNumber": { - "shape": "PhoneNumber", - "documentation": "The phone number, in E.164 format, to remove from the OptOutList.
" + "OriginationIdentity": { + "shape": "PhoneOrSenderIdOrArn", + "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true } } }, - "DeleteOptedOutNumberResult": { + "DisassociateOriginationIdentityResult": { "type": "structure", "members": { - "OptOutListArn": { + "PoolArn": { "shape": "String", - "documentation": "The OptOutListArn that the phone number was removed from.
" + "documentation": "The Amazon Resource Name (ARN) of the pool.
" }, - "OptOutListName": { - "shape": "OptOutListName", - "documentation": "The OptOutListName that the phone number was removed from.
" + "PoolId": { + "shape": "String", + "documentation": "The PoolId of the pool no longer associated with the origination identity.
" }, - "OptedOutNumber": { - "shape": "PhoneNumber", - "documentation": "The phone number that was removed from the OptOutList.
" + "OriginationIdentityArn": { + "shape": "String", + "documentation": "The PhoneNumberArn or SenderIdArn of the origination identity.
" }, - "OptedOutTimestamp": { - "shape": "Timestamp", - "documentation": "The time that the number was removed at, in UNIX epoch time format.
" + "OriginationIdentity": { + "shape": "String", + "documentation": "The PhoneNumberId or SenderId of the origination identity.
" }, - "EndUserOptedOut": { - "shape": "PrimitiveBoolean", - "documentation": "This is true if it was the end user who requested their phone number be removed.
" + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" } } }, - "DeletePoolRequest": { + "DiscardRegistrationVersionRequest": { "type": "structure", "required": [ - "PoolId" + "RegistrationId" ], "members": { - "PoolId": { - "shape": "PoolIdOrArn", - "documentation": "The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
" + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" } } }, - "DeletePoolResult": { + "DiscardRegistrationVersionResult": { "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], "members": { - "PoolArn": { + "RegistrationArn": { "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the pool that was deleted.
" + "documentation": "The Amazon Resource Name (ARN) for the registration.
" }, - "PoolId": { + "RegistrationId": { "shape": "String", - "documentation": "The PoolId of the pool that was deleted.
" + "documentation": "The unique identifier for the registration.
" }, - "Status": { - "shape": "PoolStatus", - "documentation": "The current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
The version number of the registration.
" }, - "MessageType": { - "shape": "MessageType", - "documentation": "The message type that was associated with the deleted pool.
" + "RegistrationVersionStatus": { + "shape": "RegistrationVersionStatus", + "documentation": "The status of the registration version.
DRAFT
: The initial status of a registration version after it’s created.
SUBMITTED
: Your registration has been submitted.
REVIEWING
: Your registration has been accepted and is being reviewed.
APPROVED
: Your registration has been approved.
DISCARDED
: You've abandon this version of their registration to start over with a new version.
DENIED
: You must fix your registration and resubmit it.
REVOKED
: Your previously approved registration has been revoked.
ARCHIVED
: Your previously approved registration version moves into this status when a more recently submitted version is approved.
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" + "RegistrationVersionStatusHistory": { + "shape": "RegistrationVersionStatusHistory", + "documentation": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" + } + } + }, + "EventDestination": { + "type": "structure", + "required": [ + "EventDestinationName", + "Enabled", + "MatchingEventTypes" + ], + "members": { + "EventDestinationName": { + "shape": "EventDestinationName", + "documentation": "The name of the EventDestination.
" }, - "TwoWayChannelArn": { - "shape": "TwoWayChannelArn", - "documentation": "The Amazon Resource Name (ARN) of the TwoWayChannel.
" + "Enabled": { + "shape": "Boolean", + "documentation": "When set to true events will be logged.
" }, - "SelfManagedOptOutsEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" + "MatchingEventTypes": { + "shape": "EventTypeList", + "documentation": "An array of event types that determine which events to log.
The TEXT_SENT
event type is not supported.
The name of the OptOutList that was associated with the deleted pool.
" + "CloudWatchLogsDestination": { + "shape": "CloudWatchLogsDestination", + "documentation": "An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
" }, - "SharedRoutesEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "Indicates whether shared routes are enabled for the pool.
" + "KinesisFirehoseDestination": { + "shape": "KinesisFirehoseDestination", + "documentation": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
" }, - "CreatedTimestamp": { - "shape": "Timestamp", - "documentation": "The time when the pool was created, in UNIX epoch time format.
" + "SnsDestination": { + "shape": "SnsDestination", + "documentation": "An object that contains information about an event destination that sends logging events to Amazon SNS.
" } + }, + "documentation": "Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS.
" + }, + "EventDestinationList": { + "type": "list", + "member": { + "shape": "EventDestination" } }, - "DeleteTextMessageSpendLimitOverrideRequest": { - "type": "structure", - "members": {} + "EventDestinationName": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "[A-Za-z0-9_-]+" + }, + "EventType": { + "type": "string", + "enum": [ + "ALL", + "TEXT_ALL", + "TEXT_SENT", + "TEXT_PENDING", + "TEXT_QUEUED", + "TEXT_SUCCESSFUL", + "TEXT_DELIVERED", + "TEXT_INVALID", + "TEXT_INVALID_MESSAGE", + "TEXT_UNREACHABLE", + "TEXT_CARRIER_UNREACHABLE", + "TEXT_BLOCKED", + "TEXT_CARRIER_BLOCKED", + "TEXT_SPAM", + "TEXT_UNKNOWN", + "TEXT_TTL_EXPIRED", + "VOICE_ALL", + "VOICE_INITIATED", + "VOICE_RINGING", + "VOICE_ANSWERED", + "VOICE_COMPLETED", + "VOICE_BUSY", + "VOICE_NO_ANSWER", + "VOICE_FAILED", + "VOICE_TTL_EXPIRED" + ] + }, + "EventTypeList": { + "type": "list", + "member": { + "shape": "EventType" + }, + "max": 25, + "min": 1 }, - "DeleteTextMessageSpendLimitOverrideResult": { - "type": "structure", - "members": { - "MonthlyLimit": { - "shape": "MonthlyLimit", - "documentation": "The current monthly limit, in US dollars.
" - } - } + "FieldPath": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "[A-Za-z0-9_\\.]+" }, - "DeleteVoiceMessageSpendLimitOverrideRequest": { - "type": "structure", - "members": {} + "FieldPathList": { + "type": "list", + "member": { + "shape": "FieldPath" + }, + "max": 5, + "min": 0 }, - "DeleteVoiceMessageSpendLimitOverrideResult": { - "type": "structure", - "members": { - "MonthlyLimit": { - "shape": "MonthlyLimit", - "documentation": "The current monthly limit, in US dollars.
" - } - } + "FieldRequirement": { + "type": "string", + "enum": [ + "REQUIRED", + "CONDITIONAL", + "OPTIONAL" + ] }, - "DeliveryStreamArn": { + "FieldType": { + "type": "string", + "enum": [ + "SELECT", + "TEXT", + "ATTACHMENT" + ] + }, + "FilterValue": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "[\\.:A-Za-z0-9_-]+" + }, + "FilterValueList": { + "type": "list", + "member": { + "shape": "FilterValue" + }, + "max": 20, + "min": 1 + }, + "IamRoleArn": { "type": "string", "max": 2048, "min": 20, "pattern": "arn:\\S+" }, - "DescribeAccountAttributesRequest": { - "type": "structure", - "members": { - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" - }, - "MaxResults": { - "shape": "MaxResults", - "documentation": "The maximum number of results to return per each request.
" - } - } + "Integer": { + "type": "integer", + "box": true }, - "DescribeAccountAttributesResult": { - "type": "structure", - "members": { - "AccountAttributes": { - "shape": "AccountAttributeList", - "documentation": "An array of AccountAttributes objects.
" - }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" - } - } + "IsoCountryCode": { + "type": "string", + "max": 2, + "min": 2, + "pattern": "[A-Z]{2}" }, - "DescribeAccountLimitsRequest": { - "type": "structure", - "members": { - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" - }, - "MaxResults": { - "shape": "MaxResults", - "documentation": "The maximum number of results to return per each request.
" - } - } + "Keyword": { + "type": "string", + "max": 30, + "min": 1, + "pattern": "[ \\S]+" }, - "DescribeAccountLimitsResult": { + "KeywordAction": { + "type": "string", + "enum": [ + "AUTOMATIC_RESPONSE", + "OPT_OUT", + "OPT_IN" + ] + }, + "KeywordFilter": { "type": "structure", + "required": [ + "Name", + "Values" + ], "members": { - "AccountLimits": { - "shape": "AccountLimitList", - "documentation": "An array of AccountLimit objects that show the current spend limits.
" + "Name": { + "shape": "KeywordFilterName", + "documentation": "The name of the attribute to filter on.
" }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + "Values": { + "shape": "FilterValueList", + "documentation": "An array values to filter for.
" } - } + }, + "documentation": "The information for keywords that meet a specified criteria.
" }, - "DescribeConfigurationSetsRequest": { + "KeywordFilterList": { + "type": "list", + "member": { + "shape": "KeywordFilter" + }, + "max": 20, + "min": 0 + }, + "KeywordFilterName": { + "type": "string", + "enum": [ + "keyword-action" + ] + }, + "KeywordInformation": { "type": "structure", + "required": [ + "Keyword", + "KeywordMessage", + "KeywordAction" + ], "members": { - "ConfigurationSetNames": { - "shape": "ConfigurationSetNameList", - "documentation": "An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
" - }, - "Filters": { - "shape": "ConfigurationSetFilterList", - "documentation": "An array of filters to apply to the results that are returned.
" + "Keyword": { + "shape": "Keyword", + "documentation": "The keyword as a string.
" }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + "KeywordMessage": { + "shape": "KeywordMessage", + "documentation": "A custom message that can be used with the keyword.
" }, - "MaxResults": { - "shape": "MaxResults", - "documentation": "The maximum number of results to return per each request.
" + "KeywordAction": { + "shape": "KeywordAction", + "documentation": "The action to perform for the keyword.
" } + }, + "documentation": "The information for all keywords in a pool.
" + }, + "KeywordInformationList": { + "type": "list", + "member": { + "shape": "KeywordInformation" } }, - "DescribeConfigurationSetsResult": { + "KeywordList": { + "type": "list", + "member": { + "shape": "Keyword" + }, + "max": 5, + "min": 0 + }, + "KeywordMessage": { + "type": "string", + "max": 1600, + "min": 1, + "pattern": "(?!\\s*$)[\\s\\S]+" + }, + "KinesisFirehoseDestination": { "type": "structure", + "required": [ + "IamRoleArn", + "DeliveryStreamArn" + ], "members": { - "ConfigurationSets": { - "shape": "ConfigurationSetInformationList", - "documentation": "An array of ConfigurationSets objects.
" + "IamRoleArn": { + "shape": "IamRoleArn", + "documentation": "The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.
" }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + "DeliveryStreamArn": { + "shape": "DeliveryStreamArn", + "documentation": "The Amazon Resource Name (ARN) of the delivery stream.
" } - } + }, + "documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event destination.
Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.
" }, - "DescribeKeywordsRequest": { + "LanguageCode": { + "type": "string", + "enum": [ + "DE_DE", + "EN_GB", + "EN_US", + "ES_419", + "ES_ES", + "FR_CA", + "FR_FR", + "IT_IT", + "JA_JP", + "KO_KR", + "PT_BR", + "ZH_CN", + "ZH_TW" + ] + }, + "ListPoolOriginationIdentitiesRequest": { "type": "structure", "required": [ - "OriginationIdentity" + "PoolId" ], "members": { - "OriginationIdentity": { - "shape": "PhoneOrPoolIdOrArn", - "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
" - }, - "Keywords": { - "shape": "KeywordList", - "documentation": "An array of keywords to search for.
" + "PoolId": { + "shape": "PoolIdOrArn", + "documentation": "The unique identifier for the pool. This value can be either the PoolId or PoolArn.
" }, "Filters": { - "shape": "KeywordFilterList", - "documentation": "An array of keyword filters to filter the results.
" + "shape": "PoolOriginationIdentitiesFilterList", + "documentation": "An array of PoolOriginationIdentitiesFilter objects to filter the results..
" }, "NextToken": { "shape": "NextToken", @@ -2356,20 +4742,20 @@ } } }, - "DescribeKeywordsResult": { + "ListPoolOriginationIdentitiesResult": { "type": "structure", "members": { - "OriginationIdentityArn": { + "PoolArn": { "shape": "String", - "documentation": "The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
" + "documentation": "The Amazon Resource Name (ARN) for the pool.
" }, - "OriginationIdentity": { + "PoolId": { "shape": "String", - "documentation": "The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
" + "documentation": "The unique PoolId of the pool.
" }, - "Keywords": { - "shape": "KeywordInformationList", - "documentation": "An array of KeywordInformation objects that contain the results.
" + "OriginationIdentities": { + "shape": "OriginationIdentityMetadataList", + "documentation": "An array of any OriginationIdentityMetadata objects.
" }, "NextToken": { "shape": "NextToken", @@ -2377,12 +4763,19 @@ } } }, - "DescribeOptOutListsRequest": { + "ListRegistrationAssociationsRequest": { "type": "structure", + "required": [ + "RegistrationId" + ], "members": { - "OptOutListNames": { - "shape": "OptOutListNameList", - "documentation": "The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
" + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" + }, + "Filters": { + "shape": "RegistrationAssociationFilterList", + "documentation": "An array of RegistrationAssociationFilter to apply to the results that are returned.
" }, "NextToken": { "shape": "NextToken", @@ -2394,49 +4787,157 @@ } } }, - "DescribeOptOutListsResult": { + "ListRegistrationAssociationsResult": { "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationAssociations" + ], "members": { - "OptOutLists": { - "shape": "OptOutListInformationList", - "documentation": "An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
" + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "RegistrationAssociations": { + "shape": "RegistrationAssociationMetadataList", + "documentation": "An array of RegistrationAssociationMetadata objects.
" }, "NextToken": { "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, - "DescribeOptedOutNumbersRequest": { + "ListTagsForResourceRequest": { "type": "structure", "required": [ - "OptOutListName" + "ResourceArn" ], "members": { - "OptOutListName": { - "shape": "OptOutListNameOrArn", - "documentation": "The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
" - }, - "OptedOutNumbers": { - "shape": "OptedOutNumberList", - "documentation": "An array of phone numbers to search for in the OptOutList.
" - }, - "Filters": { - "shape": "OptedOutFilterList", - "documentation": "An array of OptedOutFilter objects to filter the results on.
" - }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + "ResourceArn": { + "shape": "AmazonResourceName", + "documentation": "The Amazon Resource Name (ARN) of the resource to query for.
" + } + } + }, + "ListTagsForResourceResult": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "AmazonResourceName", + "documentation": "The ARN of the resource.
" }, - "MaxResults": { - "shape": "MaxResults", - "documentation": "The maximum number of results to return per each request.
" + "Tags": { + "shape": "TagList", + "documentation": "An array of key and value pair tags that are associated with the resource.
" } } }, - "DescribeOptedOutNumbersResult": { + "LogGroupArn": { + "type": "string", + "max": 2048, + "min": 20, + "pattern": "arn:\\S+" + }, + "MaxPrice": { + "type": "string", + "max": 8, + "min": 2, + "pattern": "[0-9]{0,2}\\.[0-9]{1,5}" + }, + "MaxResults": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, + "MessageType": { + "type": "string", + "enum": [ + "TRANSACTIONAL", + "PROMOTIONAL" + ] + }, + "MessageTypeList": { + "type": "list", + "member": { + "shape": "MessageType" + }, + "max": 2, + "min": 0 + }, + "MonthlyLimit": { + "type": "long", + "box": true, + "max": 1000000000, + "min": 0 + }, + "NextToken": { + "type": "string", + "max": 1024, + "min": 1, + "pattern": ".+" + }, + "NonEmptyTagList": { + "type": "list", + "member": { + "shape": "Tag" + }, + "max": 200, + "min": 1 + }, + "NumberCapability": { + "type": "string", + "enum": [ + "SMS", + "VOICE" + ] + }, + "NumberCapabilityList": { + "type": "list", + "member": { + "shape": "NumberCapability" + }, + "max": 2, + "min": 1 + }, + "NumberStatus": { + "type": "string", + "enum": [ + "PENDING", + "ACTIVE", + "ASSOCIATING", + "DISASSOCIATING", + "DELETED" + ] + }, + "NumberType": { + "type": "string", + "enum": [ + "SHORT_CODE", + "LONG_CODE", + "TOLL_FREE", + "TEN_DLC", + "SIMULATOR" + ] + }, + "OptOutListInformation": { "type": "structure", + "required": [ + "OptOutListArn", + "OptOutListName", + "CreatedTimestamp" + ], "members": { "OptOutListArn": { "shape": "String", @@ -2446,346 +4947,444 @@ "shape": "OptOutListName", "documentation": "The name of the OptOutList.
" }, - "OptedOutNumbers": { - "shape": "OptedOutNumberInformationList", - "documentation": "An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
" - }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the OutOutList was created, in UNIX epoch time format.
" } - } + }, + "documentation": "The information for all OptOutList in an Amazon Web Services account.
" }, - "DescribePhoneNumbersRequest": { - "type": "structure", - "members": { - "PhoneNumberIds": { - "shape": "PhoneNumberIdList", - "documentation": "The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
" - }, - "Filters": { - "shape": "PhoneNumberFilterList", - "documentation": "An array of PhoneNumberFilter objects to filter the results.
" - }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" - }, - "MaxResults": { - "shape": "MaxResults", - "documentation": "The maximum number of results to return per each request.
" - } + "OptOutListInformationList": { + "type": "list", + "member": { + "shape": "OptOutListInformation" } }, - "DescribePhoneNumbersResult": { - "type": "structure", - "members": { - "PhoneNumbers": { - "shape": "PhoneNumberInformationList", - "documentation": "An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
" - }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" - } - } + "OptOutListName": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "[A-Za-z0-9_-]+" }, - "DescribePoolsRequest": { + "OptOutListNameList": { + "type": "list", + "member": { + "shape": "OptOutListNameOrArn" + }, + "max": 5, + "min": 0 + }, + "OptOutListNameOrArn": { + "type": "string", + "max": 256, + "min": 1, + "pattern": "[A-Za-z0-9_:/-]+" + }, + "OptedOutFilter": { "type": "structure", + "required": [ + "Name", + "Values" + ], "members": { - "PoolIds": { - "shape": "PoolIdList", - "documentation": "The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
" - }, - "Filters": { - "shape": "PoolFilterList", - "documentation": "An array of PoolFilter objects to filter the results.
" - }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + "Name": { + "shape": "OptedOutFilterName", + "documentation": "The name of the attribute to filter on.
" }, - "MaxResults": { - "shape": "MaxResults", - "documentation": "The maximum number of results to return per each request.
" + "Values": { + "shape": "FilterValueList", + "documentation": "An array of values to filter for.
" } - } + }, + "documentation": "The information for opted out numbers that meet a specified criteria.
" }, - "DescribePoolsResult": { + "OptedOutFilterList": { + "type": "list", + "member": { + "shape": "OptedOutFilter" + }, + "max": 20, + "min": 0 + }, + "OptedOutFilterName": { + "type": "string", + "enum": [ + "end-user-opted-out" + ] + }, + "OptedOutNumberInformation": { "type": "structure", + "required": [ + "OptedOutNumber", + "OptedOutTimestamp", + "EndUserOptedOut" + ], "members": { - "Pools": { - "shape": "PoolInformationList", - "documentation": "An array of PoolInformation objects that contain the details for the requested pools.
" + "OptedOutNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number that is opted out.
" }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + "OptedOutTimestamp": { + "shape": "Timestamp", + "documentation": "The time that the op tout occurred, in UNIX epoch time format.
" + }, + "EndUserOptedOut": { + "shape": "PrimitiveBoolean", + "documentation": "This is set to true if it was the end recipient that opted out.
" } + }, + "documentation": "The information for an opted out number in an Amazon Web Services account.
" + }, + "OptedOutNumberInformationList": { + "type": "list", + "member": { + "shape": "OptedOutNumberInformation" } }, - "DescribeSenderIdsRequest": { + "OptedOutNumberList": { + "type": "list", + "member": { + "shape": "PhoneNumber" + }, + "max": 5, + "min": 0 + }, + "OriginationIdentityMetadata": { "type": "structure", + "required": [ + "OriginationIdentityArn", + "OriginationIdentity", + "IsoCountryCode", + "NumberCapabilities" + ], "members": { - "SenderIds": { - "shape": "SenderIdList", - "documentation": "An array of SenderIdAndCountry objects to search for.
" + "OriginationIdentityArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) associated with the origination identity.
" }, - "Filters": { - "shape": "SenderIdFilterList", - "documentation": "An array of SenderIdFilter objects to filter the results.
" + "OriginationIdentity": { + "shape": "String", + "documentation": "The unique identifier of the origination identity.
" }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" }, - "MaxResults": { - "shape": "MaxResults", - "documentation": "The maximum number of results to return per each request.
" - } - } - }, - "DescribeSenderIdsResult": { - "type": "structure", - "members": { - "SenderIds": { - "shape": "SenderIdInformationList", - "documentation": "An array of SernderIdInformation objects that contain the details for the requested SenderIds.
" + "NumberCapabilities": { + "shape": "NumberCapabilityList", + "documentation": "Describes if the origination identity can be used for text messages, voice calls or both.
" }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + "PhoneNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number in E.164 format.
" } - } + }, + "documentation": "The metadata for an origination identity associated with a pool.
" }, - "DescribeSpendLimitsRequest": { - "type": "structure", - "members": { - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" - }, - "MaxResults": { - "shape": "MaxResults", - "documentation": "The maximum number of results to return per each request.
" - } + "OriginationIdentityMetadataList": { + "type": "list", + "member": { + "shape": "OriginationIdentityMetadata" } }, - "DescribeSpendLimitsResult": { + "PhoneNumber": { + "type": "string", + "max": 20, + "min": 1, + "pattern": "\\+?[1-9][0-9]{1,18}" + }, + "PhoneNumberFilter": { "type": "structure", + "required": [ + "Name", + "Values" + ], "members": { - "SpendLimits": { - "shape": "SpendLimitList", - "documentation": "An array of SpendLimit objects that contain the details for the requested spend limits.
" + "Name": { + "shape": "PhoneNumberFilterName", + "documentation": "The name of the attribute to filter on.
" }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + "Values": { + "shape": "FilterValueList", + "documentation": "An array values to filter for.
" } - } + }, + "documentation": "The information for a phone number that meets a specified criteria.
" }, - "DestinationCountryParameterKey": { + "PhoneNumberFilterList": { + "type": "list", + "member": { + "shape": "PhoneNumberFilter" + }, + "max": 20, + "min": 0 + }, + "PhoneNumberFilterName": { "type": "string", "enum": [ - "IN_TEMPLATE_ID", - "IN_ENTITY_ID" + "status", + "iso-country-code", + "message-type", + "number-capability", + "number-type", + "two-way-enabled", + "self-managed-opt-outs-enabled", + "opt-out-list-name", + "deletion-protection-enabled", + "two-way-channel-arn" ] }, - "DestinationCountryParameterValue": { - "type": "string", - "max": 64, - "min": 1, - "pattern": "\\S+" - }, - "DestinationCountryParameters": { - "type": "map", - "key": { - "shape": "DestinationCountryParameterKey" - }, - "value": { - "shape": "DestinationCountryParameterValue" + "PhoneNumberIdList": { + "type": "list", + "member": { + "shape": "PhoneNumberIdOrArn" }, - "max": 10, + "max": 5, "min": 0 }, - "DisassociateOriginationIdentityRequest": { + "PhoneNumberIdOrArn": { + "type": "string", + "max": 256, + "min": 1, + "pattern": "[A-Za-z0-9_:/-]+" + }, + "PhoneNumberInformation": { "type": "structure", "required": [ - "PoolId", - "OriginationIdentity", - "IsoCountryCode" + "PhoneNumberArn", + "PhoneNumber", + "Status", + "IsoCountryCode", + "MessageType", + "NumberCapabilities", + "NumberType", + "MonthlyLeasingPrice", + "TwoWayEnabled", + "SelfManagedOptOutsEnabled", + "OptOutListName", + "DeletionProtectionEnabled", + "CreatedTimestamp" ], "members": { - "PoolId": { - "shape": "PoolIdOrArn", - "documentation": "The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
" + "PhoneNumberArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) associated with the phone number.
" }, - "OriginationIdentity": { - "shape": "PhoneOrSenderIdOrArn", - "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
" + "PhoneNumberId": { + "shape": "String", + "documentation": "The unique identifier for the phone number.
" + }, + "PhoneNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number in E.164 format.
" + }, + "Status": { + "shape": "NumberStatus", + "documentation": "The current status of the phone number.
" }, "IsoCountryCode": { "shape": "IsoCountryCode", "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" }, - "ClientToken": { - "shape": "ClientToken", - "documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", - "idempotencyToken": true - } - } - }, - "DisassociateOriginationIdentityResult": { - "type": "structure", - "members": { - "PoolArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the pool.
" + "MessageType": { + "shape": "MessageType", + "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "NumberCapabilities": { + "shape": "NumberCapabilityList", + "documentation": "Describes if the origination identity can be used for text messages, voice calls or both.
" }, - "PoolId": { - "shape": "String", - "documentation": "The PoolId of the pool no longer associated with the origination identity.
" + "NumberType": { + "shape": "NumberType", + "documentation": "The type of phone number.
" }, - "OriginationIdentityArn": { + "MonthlyLeasingPrice": { "shape": "String", - "documentation": "The PhoneNumberArn or SenderIdArn of the origination identity.
" + "documentation": "The price, in US dollars, to lease the phone number.
" }, - "OriginationIdentity": { - "shape": "String", - "documentation": "The PhoneNumberId or SenderId of the origination identity.
" + "TwoWayEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
" }, - "IsoCountryCode": { - "shape": "IsoCountryCode", - "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" - } - } - }, - "EventDestination": { - "type": "structure", - "required": [ - "EventDestinationName", - "Enabled", - "MatchingEventTypes" - ], - "members": { - "EventDestinationName": { - "shape": "EventDestinationName", - "documentation": "The name of the EventDestination.
" + "TwoWayChannelArn": { + "shape": "TwoWayChannelArn", + "documentation": "The Amazon Resource Name (ARN) of the two way channel.
" }, - "Enabled": { - "shape": "Boolean", - "documentation": "When set to true events will be logged.
" + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" }, - "MatchingEventTypes": { - "shape": "EventTypeList", - "documentation": "An array of event types that determine which events to log.
" + "SelfManagedOptOutsEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
" }, - "CloudWatchLogsDestination": { - "shape": "CloudWatchLogsDestination", - "documentation": "An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
" + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The name of the OptOutList associated with the phone number.
" }, - "KinesisFirehoseDestination": { - "shape": "KinesisFirehoseDestination", - "documentation": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
" + "DeletionProtectionEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "When set to true the phone number can't be deleted.
" }, - "SnsDestination": { - "shape": "SnsDestination", - "documentation": "An object that contains information about an event destination that sends logging events to Amazon SNS.
" + "PoolId": { + "shape": "String", + "documentation": "The unique identifier of the pool associated with the phone number.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the phone number was created, in UNIX epoch time format.
" } }, - "documentation": "Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS.
" + "documentation": "The information for a phone number, in E.164 format, in an Amazon Web Services account.
" }, - "EventDestinationList": { + "PhoneNumberInformationList": { "type": "list", "member": { - "shape": "EventDestination" + "shape": "PhoneNumberInformation" } }, - "EventDestinationName": { + "PhoneOrPoolIdOrArn": { "type": "string", - "max": 64, + "max": 256, "min": 1, - "pattern": "[A-Za-z0-9_-]+" + "pattern": "[A-Za-z0-9_:/-]+" }, - "EventType": { + "PhoneOrSenderIdOrArn": { "type": "string", - "enum": [ - "ALL", - "TEXT_ALL", - "TEXT_SENT", - "TEXT_PENDING", - "TEXT_QUEUED", - "TEXT_SUCCESSFUL", - "TEXT_DELIVERED", - "TEXT_INVALID", - "TEXT_INVALID_MESSAGE", - "TEXT_UNREACHABLE", - "TEXT_CARRIER_UNREACHABLE", - "TEXT_BLOCKED", - "TEXT_CARRIER_BLOCKED", - "TEXT_SPAM", - "TEXT_UNKNOWN", - "TEXT_TTL_EXPIRED", - "VOICE_ALL", - "VOICE_INITIATED", - "VOICE_RINGING", - "VOICE_ANSWERED", - "VOICE_COMPLETED", - "VOICE_BUSY", - "VOICE_NO_ANSWER", - "VOICE_FAILED", - "VOICE_TTL_EXPIRED" - ] + "max": 256, + "min": 1, + "pattern": "[A-Za-z0-9_:/-]+" }, - "EventTypeList": { - "type": "list", - "member": { - "shape": "EventType" + "PoolFilter": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": { + "shape": "PoolFilterName", + "documentation": "The name of the attribute to filter on.
" + }, + "Values": { + "shape": "FilterValueList", + "documentation": "An array values to filter for.
" + } }, - "max": 25, - "min": 1 - }, - "FilterValue": { - "type": "string", - "max": 100, - "min": 1, - "pattern": "[A-Za-z0-9_-]+" + "documentation": "The information for a pool that meets a specified criteria.
" }, - "FilterValueList": { + "PoolFilterList": { "type": "list", "member": { - "shape": "FilterValue" + "shape": "PoolFilter" }, "max": 20, - "min": 1 + "min": 0 }, - "IamRoleArn": { + "PoolFilterName": { "type": "string", - "max": 2048, - "min": 20, - "pattern": "arn:\\S+" + "enum": [ + "status", + "message-type", + "two-way-enabled", + "self-managed-opt-outs-enabled", + "opt-out-list-name", + "shared-routes-enabled", + "deletion-protection-enabled", + "two-way-channel-arn" + ] }, - "IsoCountryCode": { - "type": "string", - "max": 2, - "min": 2, - "pattern": "[A-Z]{2}" + "PoolIdList": { + "type": "list", + "member": { + "shape": "PoolIdOrArn" + }, + "max": 5, + "min": 0 }, - "Keyword": { + "PoolIdOrArn": { "type": "string", - "max": 30, + "max": 256, "min": 1, - "pattern": "[ \\S]+" + "pattern": "[A-Za-z0-9_:/-]+" }, - "KeywordAction": { - "type": "string", - "enum": [ - "AUTOMATIC_RESPONSE", - "OPT_OUT", - "OPT_IN" - ] + "PoolInformation": { + "type": "structure", + "required": [ + "PoolArn", + "PoolId", + "Status", + "MessageType", + "TwoWayEnabled", + "SelfManagedOptOutsEnabled", + "OptOutListName", + "SharedRoutesEnabled", + "DeletionProtectionEnabled", + "CreatedTimestamp" + ], + "members": { + "PoolArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the pool.
" + }, + "PoolId": { + "shape": "String", + "documentation": "The unique identifier for the pool.
" + }, + "Status": { + "shape": "PoolStatus", + "documentation": "The current status of the pool.
" + }, + "MessageType": { + "shape": "MessageType", + "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "TwoWayEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
" + }, + "TwoWayChannelArn": { + "shape": "TwoWayChannelArn", + "documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + }, + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, + "SelfManagedOptOutsEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
" + }, + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The name of the OptOutList associated with the pool.
" + }, + "SharedRoutesEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "Allows you to enable shared routes on your pool.
By default, this is set to False
. If you set this value to True
, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
When set to true the pool can't be deleted.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the pool was created, in UNIX epoch time format.
" + } + }, + "documentation": "The information for a pool in an Amazon Web Services account.
" }, - "KeywordFilter": { + "PoolInformationList": { + "type": "list", + "member": { + "shape": "PoolInformation" + } + }, + "PoolOriginationIdentitiesFilter": { "type": "structure", "required": [ "Name", @@ -2793,7 +5392,7 @@ ], "members": { "Name": { - "shape": "KeywordFilterName", + "shape": "PoolOriginationIdentitiesFilterName", "documentation": "The name of the attribute to filter on.
" }, "Values": { @@ -2801,288 +5400,207 @@ "documentation": "An array values to filter for.
" } }, - "documentation": "The information for keywords that meet a specified criteria.
" + "documentation": "Information about origination identities associated with a pool that meets a specified criteria.
" }, - "KeywordFilterList": { + "PoolOriginationIdentitiesFilterList": { "type": "list", "member": { - "shape": "KeywordFilter" + "shape": "PoolOriginationIdentitiesFilter" }, "max": 20, "min": 0 }, - "KeywordFilterName": { + "PoolOriginationIdentitiesFilterName": { "type": "string", "enum": [ - "keyword-action" + "iso-country-code", + "number-capability" ] }, - "KeywordInformation": { + "PoolStatus": { + "type": "string", + "enum": [ + "CREATING", + "ACTIVE", + "DELETING" + ] + }, + "PrimitiveBoolean": { + "type": "boolean" + }, + "PrimitiveLong": { + "type": "long" + }, + "PutKeywordRequest": { "type": "structure", "required": [ + "OriginationIdentity", "Keyword", - "KeywordMessage", - "KeywordAction" + "KeywordMessage" ], "members": { + "OriginationIdentity": { + "shape": "PhoneOrPoolIdOrArn", + "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
" + }, "Keyword": { "shape": "Keyword", - "documentation": "The keyword as a string.
" + "documentation": "The new keyword to add.
" }, "KeywordMessage": { "shape": "KeywordMessage", - "documentation": "A custom message that can be used with the keyword.
" + "documentation": "The message associated with the keyword.
" }, "KeywordAction": { "shape": "KeywordAction", - "documentation": "The action to perform for the keyword.
" - } - }, - "documentation": "The information for all keywords in a pool.
" - }, - "KeywordInformationList": { - "type": "list", - "member": { - "shape": "KeywordInformation" - } - }, - "KeywordList": { - "type": "list", - "member": { - "shape": "Keyword" - }, - "max": 5, - "min": 0 - }, - "KeywordMessage": { - "type": "string", - "max": 1600, - "min": 1, - "pattern": "(?!\\s*$)[\\s\\S]+" - }, - "KinesisFirehoseDestination": { - "type": "structure", - "required": [ - "IamRoleArn", - "DeliveryStreamArn" - ], - "members": { - "IamRoleArn": { - "shape": "IamRoleArn", - "documentation": "The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.
" - }, - "DeliveryStreamArn": { - "shape": "DeliveryStreamArn", - "documentation": "The Amazon Resource Name (ARN) of the delivery stream.
" - } - }, - "documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event destination.
Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.
" - }, - "ListPoolOriginationIdentitiesRequest": { - "type": "structure", - "required": [ - "PoolId" - ], - "members": { - "PoolId": { - "shape": "PoolIdOrArn", - "documentation": "The unique identifier for the pool. This value can be either the PoolId or PoolArn.
" - }, - "Filters": { - "shape": "PoolOriginationIdentitiesFilterList", - "documentation": "An array of PoolOriginationIdentitiesFilter objects to filter the results..
" - }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" - }, - "MaxResults": { - "shape": "MaxResults", - "documentation": "The maximum number of results to return per each request.
" + "documentation": "The action to perform for the new keyword when it is received.
AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.
The Amazon Resource Name (ARN) for the pool.
" + "documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" }, - "PoolId": { + "OriginationIdentity": { "shape": "String", - "documentation": "The unique PoolId of the pool.
" + "documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" }, - "OriginationIdentities": { - "shape": "OriginationIdentityMetadataList", - "documentation": "An array of any OriginationIdentityMetadata objects.
" + "Keyword": { + "shape": "Keyword", + "documentation": "The keyword that was added.
" }, - "NextToken": { - "shape": "NextToken", - "documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" + "KeywordMessage": { + "shape": "KeywordMessage", + "documentation": "The message associated with the keyword.
" + }, + "KeywordAction": { + "shape": "KeywordAction", + "documentation": "The action to perform when the keyword is used.
" } } }, - "ListTagsForResourceRequest": { + "PutOptedOutNumberRequest": { "type": "structure", "required": [ - "ResourceArn" + "OptOutListName", + "OptedOutNumber" ], "members": { - "ResourceArn": { - "shape": "AmazonResourceName", - "documentation": "The Amazon Resource Name (ARN) of the resource to query for.
" + "OptOutListName": { + "shape": "OptOutListNameOrArn", + "documentation": "The OptOutListName or OptOutListArn to add the phone number to.
" + }, + "OptedOutNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number to add to the OptOutList in E.164 format.
" } } }, - "ListTagsForResourceResult": { + "PutOptedOutNumberResult": { "type": "structure", "members": { - "ResourceArn": { - "shape": "AmazonResourceName", - "documentation": "The ARN of the resource.
" + "OptOutListArn": { + "shape": "String", + "documentation": "The OptOutListArn that the phone number was removed from.
" }, - "Tags": { - "shape": "TagList", - "documentation": "An array of key and value pair tags that are associated with the resource.
" + "OptOutListName": { + "shape": "OptOutListName", + "documentation": "The OptOutListName that the phone number was removed from.
" + }, + "OptedOutNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number that was added to the OptOutList.
" + }, + "OptedOutTimestamp": { + "shape": "Timestamp", + "documentation": "The time that the phone number was added to the OptOutList, in UNIX epoch time format.
" + }, + "EndUserOptedOut": { + "shape": "PrimitiveBoolean", + "documentation": "This is true if it was the end user who requested their phone number be removed.
" } - } - }, - "LogGroupArn": { - "type": "string", - "max": 2048, - "min": 20, - "pattern": "arn:\\S+" - }, - "MaxPrice": { - "type": "string", - "max": 8, - "min": 2, - "pattern": "[0-9]{0,2}\\.[0-9]{1,5}" - }, - "MaxResults": { - "type": "integer", - "box": true, - "max": 100, - "min": 1 - }, - "MessageType": { - "type": "string", - "enum": [ - "TRANSACTIONAL", - "PROMOTIONAL" - ] - }, - "MessageTypeList": { - "type": "list", - "member": { - "shape": "MessageType" - } - }, - "MonthlyLimit": { - "type": "long", - "box": true, - "max": 1000000000, - "min": 0 - }, - "NextToken": { - "type": "string", - "max": 1024, - "min": 1, - "pattern": ".+" - }, - "NonEmptyTagList": { - "type": "list", - "member": { - "shape": "Tag" - }, - "max": 200, - "min": 1 - }, - "NumberCapability": { - "type": "string", - "enum": [ - "SMS", - "VOICE" - ] - }, - "NumberCapabilityList": { - "type": "list", - "member": { - "shape": "NumberCapability" - }, - "max": 2, - "min": 1 - }, - "NumberStatus": { - "type": "string", - "enum": [ - "PENDING", - "ACTIVE", - "ASSOCIATING", - "DISASSOCIATING", - "DELETED" - ] - }, - "NumberType": { - "type": "string", - "enum": [ - "SHORT_CODE", - "LONG_CODE", - "TOLL_FREE", - "TEN_DLC" - ] + } }, - "OptOutListInformation": { + "PutRegistrationFieldValueRequest": { "type": "structure", "required": [ - "OptOutListArn", - "OptOutListName", - "CreatedTimestamp" + "RegistrationId", + "FieldPath" ], "members": { - "OptOutListArn": { - "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the OptOutList.
" + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" }, - "OptOutListName": { - "shape": "OptOutListName", - "documentation": "The name of the OptOutList.
" + "FieldPath": { + "shape": "FieldPath", + "documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" }, - "CreatedTimestamp": { - "shape": "Timestamp", - "documentation": "The time when the OutOutList was created, in UNIX epoch time format.
" + "SelectChoices": { + "shape": "SelectChoiceList", + "documentation": "An array of values for the form field.
" + }, + "TextValue": { + "shape": "TextValue", + "documentation": "The text data for a free form field.
" + }, + "RegistrationAttachmentId": { + "shape": "RegistrationAttachmentIdOrArn", + "documentation": "The unique identifier for the registration attachment.
" } - }, - "documentation": "The information for all OptOutList in an Amazon Web Services account.
" - }, - "OptOutListInformationList": { - "type": "list", - "member": { - "shape": "OptOutListInformation" } }, - "OptOutListName": { - "type": "string", - "max": 64, - "min": 1, - "pattern": "[A-Za-z0-9_-]+" - }, - "OptOutListNameList": { - "type": "list", - "member": { - "shape": "OptOutListNameOrArn" - }, - "max": 5, - "min": 0 + "PutRegistrationFieldValueResult": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "FieldPath" + ], + "members": { + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "VersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The version number of the registration.
" + }, + "FieldPath": { + "shape": "FieldPath", + "documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" + }, + "SelectChoices": { + "shape": "SelectChoiceList", + "documentation": "An array of values for the form field.
" + }, + "TextValue": { + "shape": "TextValue", + "documentation": "The text data for a free form field.
" + }, + "RegistrationAttachmentId": { + "shape": "String", + "documentation": "The unique identifier for the registration attachment.
" + } + } }, - "OptOutListNameOrArn": { + "RegistrationAssociationBehavior": { "type": "string", - "max": 256, - "min": 1, - "pattern": "[A-Za-z0-9_:/-]+" + "enum": [ + "ASSOCIATE_BEFORE_SUBMIT", + "ASSOCIATE_ON_APPROVAL", + "ASSOCIATE_AFTER_COMPLETE" + ] }, - "OptedOutFilter": { + "RegistrationAssociationFilter": { "type": "structure", "required": [ "Name", @@ -3090,7 +5608,7 @@ ], "members": { "Name": { - "shape": "OptedOutFilterName", + "shape": "RegistrationAssociationFilterName", "documentation": "The name of the attribute to filter on.
" }, "Values": { @@ -3098,100 +5616,61 @@ "documentation": "An array of values to filter for.
" } }, - "documentation": "The information for opted out numbers that meet a specified criteria.
" + "documentation": "The filter definition for filtering registrations that meets a specified criteria.
" }, - "OptedOutFilterList": { + "RegistrationAssociationFilterList": { "type": "list", "member": { - "shape": "OptedOutFilter" + "shape": "RegistrationAssociationFilter" }, "max": 20, "min": 0 }, - "OptedOutFilterName": { + "RegistrationAssociationFilterName": { "type": "string", "enum": [ - "end-user-opted-out" + "resource-type", + "iso-country-code" ] }, - "OptedOutNumberInformation": { + "RegistrationAssociationMetadata": { "type": "structure", "required": [ - "OptedOutNumber", - "OptedOutTimestamp", - "EndUserOptedOut" + "ResourceArn", + "ResourceId", + "ResourceType" ], "members": { - "OptedOutNumber": { - "shape": "PhoneNumber", - "documentation": "The phone number that is opted out.
" - }, - "OptedOutTimestamp": { - "shape": "Timestamp", - "documentation": "The time that the op tout occurred, in UNIX epoch time format.
" + "ResourceArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
" }, - "EndUserOptedOut": { - "shape": "PrimitiveBoolean", - "documentation": "This is set to true if it was the end recipient that opted out.
" - } - }, - "documentation": "The information for an opted out number in an Amazon Web Services account.
" - }, - "OptedOutNumberInformationList": { - "type": "list", - "member": { - "shape": "OptedOutNumberInformation" - } - }, - "OptedOutNumberList": { - "type": "list", - "member": { - "shape": "PhoneNumber" - }, - "max": 5, - "min": 0 - }, - "OriginationIdentityMetadata": { - "type": "structure", - "required": [ - "OriginationIdentityArn", - "OriginationIdentity", - "IsoCountryCode", - "NumberCapabilities" - ], - "members": { - "OriginationIdentityArn": { + "ResourceId": { "shape": "String", - "documentation": "The Amazon Resource Name (ARN) associated with the origination identity.
" + "documentation": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
" }, - "OriginationIdentity": { + "ResourceType": { "shape": "String", - "documentation": "The unique identifier of the origination identity.
" + "documentation": "The origination identity type.
" }, "IsoCountryCode": { "shape": "IsoCountryCode", - "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" }, - "NumberCapabilities": { - "shape": "NumberCapabilityList", - "documentation": "Describes if the origination identity can be used for text messages, voice calls or both.
" + "PhoneNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number associated with the registration in E.164 format.
" } }, - "documentation": "The metadata for an origination identity associated with a pool.
" + "documentation": "Metadata for the origination identity that is associated with the registration.
" }, - "OriginationIdentityMetadataList": { + "RegistrationAssociationMetadataList": { "type": "list", "member": { - "shape": "OriginationIdentityMetadata" + "shape": "RegistrationAssociationMetadata" } }, - "PhoneNumber": { - "type": "string", - "max": 20, - "min": 1, - "pattern": "\\+?[1-9][0-9]{1,18}" - }, - "PhoneNumberFilter": { + "RegistrationAttachmentFilter": { "type": "structure", "required": [ "Name", @@ -3199,156 +5678,251 @@ ], "members": { "Name": { - "shape": "PhoneNumberFilterName", + "shape": "RegistrationAttachmentFilterName", "documentation": "The name of the attribute to filter on.
" }, "Values": { "shape": "FilterValueList", - "documentation": "An array values to filter for.
" + "documentation": "An array of values to filter on.
" } }, - "documentation": "The information for a phone number that meets a specified criteria.
" + "documentation": "The filter definition for filtering registration attachments that meets a specified criteria.
" }, - "PhoneNumberFilterList": { + "RegistrationAttachmentFilterList": { "type": "list", "member": { - "shape": "PhoneNumberFilter" + "shape": "RegistrationAttachmentFilter" }, "max": 20, "min": 0 }, - "PhoneNumberFilterName": { + "RegistrationAttachmentFilterName": { "type": "string", "enum": [ - "status", - "iso-country-code", - "message-type", - "number-capability", - "number-type", - "two-way-enabled", - "self-managed-opt-outs-enabled", - "opt-out-list-name", - "deletion-protection-enabled" + "attachment-status" ] }, - "PhoneNumberIdList": { + "RegistrationAttachmentIdList": { "type": "list", "member": { - "shape": "PhoneNumberIdOrArn" + "shape": "RegistrationIdOrArn" }, "max": 5, "min": 0 }, - "PhoneNumberIdOrArn": { + "RegistrationAttachmentIdOrArn": { "type": "string", "max": 256, "min": 1, "pattern": "[A-Za-z0-9_:/-]+" }, - "PhoneNumberInformation": { + "RegistrationAttachmentsInformation": { "type": "structure", "required": [ - "PhoneNumberArn", - "PhoneNumber", - "Status", - "IsoCountryCode", - "MessageType", - "NumberCapabilities", - "NumberType", - "MonthlyLeasingPrice", - "TwoWayEnabled", - "SelfManagedOptOutsEnabled", - "OptOutListName", - "DeletionProtectionEnabled", + "RegistrationAttachmentArn", + "RegistrationAttachmentId", + "AttachmentStatus", "CreatedTimestamp" ], "members": { - "PhoneNumberArn": { + "RegistrationAttachmentArn": { "shape": "String", - "documentation": "The Amazon Resource Name (ARN) associated with the phone number.
" + "documentation": "The Amazon Resource Name (ARN) for the registration attachment.
" }, - "PhoneNumberId": { + "RegistrationAttachmentId": { "shape": "String", - "documentation": "The unique identifier for the phone number.
" + "documentation": "The unique identifier for the registration attachment.
" }, - "PhoneNumber": { - "shape": "PhoneNumber", - "documentation": "The phone number in E.164 format.
" + "AttachmentStatus": { + "shape": "AttachmentStatus", + "documentation": "The status of the registration attachment.
UPLOAD_IN_PROGRESS
The attachment is being uploaded.
UPLOAD_COMPLETE
The attachment has been uploaded.
UPLOAD_FAILED
The attachment failed to uploaded.
DELETED
The attachment has been deleted..
The current status of the phone number.
" + "AttachmentUploadErrorReason": { + "shape": "AttachmentUploadErrorReason", + "documentation": "A description of why the upload didn't successfully complete.
" }, - "IsoCountryCode": { - "shape": "IsoCountryCode", - "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration attachment was created, in UNIX epoch time format.
" + } + }, + "documentation": "Provides information on the specified registration attachments.
" + }, + "RegistrationAttachmentsInformationList": { + "type": "list", + "member": { + "shape": "RegistrationAttachmentsInformation" + } + }, + "RegistrationDeniedReasonInformation": { + "type": "structure", + "required": [ + "Reason", + "ShortDescription" + ], + "members": { + "Reason": { + "shape": "String", + "documentation": "The reason a registration was rejected.
" }, - "MessageType": { - "shape": "MessageType", - "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + "ShortDescription": { + "shape": "String", + "documentation": "A short description of the rejection reason.
" }, - "NumberCapabilities": { - "shape": "NumberCapabilityList", - "documentation": "Describes if the origination identity can be used for text messages, voice calls or both.
" + "LongDescription": { + "shape": "String", + "documentation": "A long description of the rejection reason.
" }, - "NumberType": { - "shape": "NumberType", - "documentation": "The type of phone number.
" + "DocumentationTitle": { + "shape": "String", + "documentation": "The title of the document.
" }, - "MonthlyLeasingPrice": { + "DocumentationLink": { "shape": "String", - "documentation": "The price, in US dollars, to lease the phone number.
" + "documentation": "The link to the document.
" + } + }, + "documentation": "Provides the reason a registration was rejected.
" + }, + "RegistrationDeniedReasonInformationList": { + "type": "list", + "member": { + "shape": "RegistrationDeniedReasonInformation" + } + }, + "RegistrationDisassociationBehavior": { + "type": "string", + "enum": [ + "DISASSOCIATE_ALL_CLOSES_REGISTRATION", + "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION", + "DELETE_REGISTRATION_DISASSOCIATES" + ] + }, + "RegistrationFieldDefinition": { + "type": "structure", + "required": [ + "SectionPath", + "FieldPath", + "FieldType", + "FieldRequirement", + "DisplayHints" + ], + "members": { + "SectionPath": { + "shape": "SectionPath", + "documentation": "The section path of the field.
" }, - "TwoWayEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
" + "FieldPath": { + "shape": "FieldPath", + "documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" }, - "TwoWayChannelArn": { - "shape": "TwoWayChannelArn", - "documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + "FieldType": { + "shape": "FieldType", + "documentation": "The type of field.
" + }, + "FieldRequirement": { + "shape": "FieldRequirement", + "documentation": "Specifies if the field for the registration form is required, conditional or optional.
" + }, + "SelectValidation": { + "shape": "SelectValidation", + "documentation": "The validation rules for a select field.
" + }, + "TextValidation": { + "shape": "TextValidation", + "documentation": "The validation rules for a text field.
" + }, + "DisplayHints": { + "shape": "RegistrationFieldDisplayHints", + "documentation": "An array of RegistrationFieldDisplayHints objects for the field.
" + } + }, + "documentation": "Provides a description of the specified field.
" + }, + "RegistrationFieldDefinitionList": { + "type": "list", + "member": { + "shape": "RegistrationFieldDefinition" + } + }, + "RegistrationFieldDisplayHints": { + "type": "structure", + "required": [ + "Title", + "ShortDescription" + ], + "members": { + "Title": { + "shape": "String", + "documentation": "The title of the display hint.
" + }, + "ShortDescription": { + "shape": "String", + "documentation": "A short description of the display hint.
" + }, + "LongDescription": { + "shape": "String", + "documentation": "A full description of the display hint.
" + }, + "DocumentationTitle": { + "shape": "String", + "documentation": "The title of the document the display hint is associated with.
" + }, + "DocumentationLink": { + "shape": "String", + "documentation": "The link to the document the display hint is associated with.
" + }, + "SelectOptionDescriptions": { + "shape": "SelectOptionDescriptionsList", + "documentation": "An array of SelectOptionDescription objects.
" + }, + "TextValidationDescription": { + "shape": "String", + "documentation": "The validation rules for the text field.
" + }, + "ExampleTextValue": { + "shape": "String", + "documentation": "Example text of what the value of a field should contain.
" + } + }, + "documentation": "Provides help information on the registration field.
" + }, + "RegistrationFieldValueInformation": { + "type": "structure", + "required": [ + "FieldPath" + ], + "members": { + "FieldPath": { + "shape": "FieldPath", + "documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" }, - "SelfManagedOptOutsEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
" + "SelectChoices": { + "shape": "SelectChoiceList", + "documentation": "An array of values for the form field.
" }, - "OptOutListName": { - "shape": "OptOutListName", - "documentation": "The name of the OptOutList associated with the phone number.
" + "TextValue": { + "shape": "TextValue", + "documentation": "The text data for a free form field.
" }, - "DeletionProtectionEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "When set to true the phone number can't be deleted.
" + "RegistrationAttachmentId": { + "shape": "RegistrationAttachmentIdOrArn", + "documentation": "The unique identifier for the registration attachment.
" }, - "PoolId": { + "DeniedReason": { "shape": "String", - "documentation": "The unique identifier of the pool associated with the phone number.
" - }, - "CreatedTimestamp": { - "shape": "Timestamp", - "documentation": "The time when the phone number was created, in UNIX epoch time format.
" + "documentation": "A description of why the registration was denied.
" } }, - "documentation": "The information for a phone number in an Amazon Web Services account.
" + "documentation": "Provides the values of the specified field.
" }, - "PhoneNumberInformationList": { + "RegistrationFieldValueInformationList": { "type": "list", "member": { - "shape": "PhoneNumberInformation" + "shape": "RegistrationFieldValueInformation" } }, - "PhoneOrPoolIdOrArn": { - "type": "string", - "max": 256, - "min": 1, - "pattern": "[A-Za-z0-9_:/-]+" - }, - "PhoneOrSenderIdOrArn": { - "type": "string", - "max": 256, - "min": 1, - "pattern": "[A-Za-z0-9_:/-]+" - }, - "PoolFilter": { + "RegistrationFilter": { "type": "structure", "required": [ "Name", @@ -3356,119 +5930,232 @@ ], "members": { "Name": { - "shape": "PoolFilterName", + "shape": "RegistrationFilterName", "documentation": "The name of the attribute to filter on.
" }, "Values": { "shape": "FilterValueList", - "documentation": "An array values to filter for.
" + "documentation": "An array of values to filter on.
" } }, - "documentation": "The information for a pool that meets a specified criteria.
" + "documentation": "The filter definition for filtering registrations that meets a specified criteria.
" }, - "PoolFilterList": { + "RegistrationFilterList": { "type": "list", "member": { - "shape": "PoolFilter" + "shape": "RegistrationFilter" }, "max": 20, "min": 0 }, - "PoolFilterName": { + "RegistrationFilterName": { "type": "string", "enum": [ - "status", - "message-type", - "two-way-enabled", - "self-managed-opt-outs-enabled", - "opt-out-list-name", - "shared-routes-enabled", - "deletion-protection-enabled" + "registration-type", + "registration-status" ] }, - "PoolIdList": { + "RegistrationIdList": { "type": "list", "member": { - "shape": "PoolIdOrArn" + "shape": "RegistrationIdOrArn" }, "max": 5, "min": 0 }, - "PoolIdOrArn": { + "RegistrationIdOrArn": { "type": "string", "max": 256, "min": 1, "pattern": "[A-Za-z0-9_:/-]+" }, - "PoolInformation": { + "RegistrationInformation": { "type": "structure", "required": [ - "PoolArn", - "PoolId", - "Status", - "MessageType", - "TwoWayEnabled", - "SelfManagedOptOutsEnabled", - "OptOutListName", - "SharedRoutesEnabled", - "DeletionProtectionEnabled", + "RegistrationArn", + "RegistrationId", + "RegistrationType", + "RegistrationStatus", + "CurrentVersionNumber", "CreatedTimestamp" ], "members": { - "PoolArn": { + "RegistrationArn": { "shape": "String", - "documentation": "The Amazon Resource Name (ARN) for the pool.
" + "documentation": "The Amazon Resource Name (ARN) for the registration.
" }, - "PoolId": { + "RegistrationId": { "shape": "String", - "documentation": "The unique identifier for the pool.
" - }, - "Status": { - "shape": "PoolStatus", - "documentation": "The current status of the pool.
" - }, - "MessageType": { - "shape": "MessageType", - "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + "documentation": "The unique identifier for the registration.
" }, - "TwoWayEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
" + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" }, - "TwoWayChannelArn": { - "shape": "TwoWayChannelArn", - "documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + "RegistrationStatus": { + "shape": "RegistrationStatus", + "documentation": "The status of the registration.
CREATED
: Your registration is created but not submitted.
SUBMITTED
: Your registration has been submitted and is awaiting review.
REVIEWING
: Your registration has been accepted and is being reviewed.
PROVISIONING
: Your registration has been approved and your origination identity is being created.
COMPLETE
: Your registration has been approved and and your origination identity has been created.
REQUIRES_UPDATES
: You must fix your registration and resubmit it.
CLOSED
: The phone number or sender ID has been deleted and you must also delete the registration for the number.
DELETED
: The registration has been deleted.
When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
" + "CurrentVersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The current version number of the registration.
" }, - "OptOutListName": { - "shape": "OptOutListName", - "documentation": "The name of the OptOutList associated with the pool.
" + "ApprovedVersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The version number of the registration that was approved.
" }, - "SharedRoutesEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "Allows you to enable shared routes on your pool.
By default, this is set to False
. If you set this value to True
, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
The latest version number of the registration that was denied.
" }, - "DeletionProtectionEnabled": { - "shape": "PrimitiveBoolean", - "documentation": "When set to true the pool can't be deleted.
" + "AdditionalAttributes": { + "shape": "StringMap", + "documentation": "Metadata about a given registration which is specific to that registration type.
" }, "CreatedTimestamp": { "shape": "Timestamp", - "documentation": "The time when the pool was created, in UNIX epoch time format.
" + "documentation": "The time when the registration was created, in UNIX epoch time format.
" } }, - "documentation": "The information for a pool in an Amazon Web Services account.
" + "documentation": "Provides information about the requested registration.
" }, - "PoolInformationList": { + "RegistrationInformationList": { "type": "list", "member": { - "shape": "PoolInformation" + "shape": "RegistrationInformation" } }, - "PoolOriginationIdentitiesFilter": { + "RegistrationSectionDefinition": { + "type": "structure", + "required": [ + "SectionPath", + "DisplayHints" + ], + "members": { + "SectionPath": { + "shape": "SectionPath", + "documentation": "The path to the section of the registration.
" + }, + "DisplayHints": { + "shape": "RegistrationSectionDisplayHints", + "documentation": "The path to the section of the registration.
" + } + }, + "documentation": "Provides information on the specified section definition.
" + }, + "RegistrationSectionDefinitionList": { + "type": "list", + "member": { + "shape": "RegistrationSectionDefinition" + } + }, + "RegistrationSectionDisplayHints": { + "type": "structure", + "required": [ + "Title", + "ShortDescription" + ], + "members": { + "Title": { + "shape": "String", + "documentation": "The title of the display hint.
" + }, + "ShortDescription": { + "shape": "String", + "documentation": "A short description of the display hint.
" + }, + "LongDescription": { + "shape": "String", + "documentation": "A full description of the display hint.
" + }, + "DocumentationTitle": { + "shape": "String", + "documentation": "The title of the document the display hint is associated with.
" + }, + "DocumentationLink": { + "shape": "String", + "documentation": "The link to the document the display hint is associated with.
" + } + }, + "documentation": "Provides help information on the registration section.
" + }, + "RegistrationStatus": { + "type": "string", + "enum": [ + "CREATED", + "SUBMITTED", + "REVIEWING", + "PROVISIONING", + "COMPLETE", + "REQUIRES_UPDATES", + "CLOSED", + "DELETED" + ] + }, + "RegistrationType": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "[A-Za-z0-9_]+" + }, + "RegistrationTypeDefinition": { + "type": "structure", + "required": [ + "RegistrationType", + "DisplayHints" + ], + "members": { + "RegistrationType": { + "shape": "RegistrationType", + "documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" + }, + "SupportedAssociations": { + "shape": "SupportedAssociationList", + "documentation": "The supported association behavior for the registration type.
" + }, + "DisplayHints": { + "shape": "RegistrationTypeDisplayHints", + "documentation": "Provides help information on the registration.
" + } + }, + "documentation": "Provides information on the supported registration type.
" + }, + "RegistrationTypeDefinitionList": { + "type": "list", + "member": { + "shape": "RegistrationTypeDefinition" + } + }, + "RegistrationTypeDisplayHints": { + "type": "structure", + "required": [ + "Title" + ], + "members": { + "Title": { + "shape": "String", + "documentation": "The title of the display hint.
" + }, + "ShortDescription": { + "shape": "String", + "documentation": "A short description of the display hint.
" + }, + "LongDescription": { + "shape": "String", + "documentation": "A full description of the display hint.
" + }, + "DocumentationTitle": { + "shape": "String", + "documentation": "The title of the document the display hint is associated with.
" + }, + "DocumentationLink": { + "shape": "String", + "documentation": "The link to the document the display hint is associated with.
" + } + }, + "documentation": "Provides help information on the registration type.
" + }, + "RegistrationTypeFilter": { "type": "structure", "required": [ "Name", @@ -3476,143 +6163,171 @@ ], "members": { "Name": { - "shape": "PoolOriginationIdentitiesFilterName", + "shape": "RegistrationTypeFilterName", "documentation": "The name of the attribute to filter on.
" }, "Values": { "shape": "FilterValueList", - "documentation": "An array values to filter for.
" + "documentation": "An array of values to filter on.
" } }, - "documentation": "Information about origination identities associated with a pool that meets a specified criteria.
" + "documentation": "The filter definition for filtering registration types that meets a specified criteria.
" }, - "PoolOriginationIdentitiesFilterList": { + "RegistrationTypeFilterList": { "type": "list", "member": { - "shape": "PoolOriginationIdentitiesFilter" + "shape": "RegistrationTypeFilter" }, "max": 20, "min": 0 }, - "PoolOriginationIdentitiesFilterName": { - "type": "string", - "enum": [ - "iso-country-code", - "number-capability" - ] - }, - "PoolStatus": { + "RegistrationTypeFilterName": { "type": "string", "enum": [ - "CREATING", - "ACTIVE", - "DELETING" + "supported-association-resource-type", + "supported-association-iso-country-code" ] }, - "PrimitiveBoolean": { - "type": "boolean" - }, - "PrimitiveLong": { - "type": "long" + "RegistrationTypeList": { + "type": "list", + "member": { + "shape": "RegistrationType" + }, + "max": 5, + "min": 0 }, - "PutKeywordRequest": { + "RegistrationVersionFilter": { "type": "structure", "required": [ - "OriginationIdentity", - "Keyword", - "KeywordMessage" + "Name", + "Values" ], "members": { - "OriginationIdentity": { - "shape": "PhoneOrPoolIdOrArn", - "documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
" - }, - "Keyword": { - "shape": "Keyword", - "documentation": "The new keyword to add.
" - }, - "KeywordMessage": { - "shape": "KeywordMessage", - "documentation": "The message associated with the keyword.
AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.
The name of the attribute to filter on.
" }, - "KeywordAction": { - "shape": "KeywordAction", - "documentation": "The action to perform for the new keyword when it is received.
" + "Values": { + "shape": "FilterValueList", + "documentation": "An array of values to filter on.
" } - } + }, + "documentation": "The filter definition for filtering registration versions that meets a specified criteria.
" }, - "PutKeywordResult": { + "RegistrationVersionFilterList": { + "type": "list", + "member": { + "shape": "RegistrationVersionFilter" + }, + "max": 20, + "min": 0 + }, + "RegistrationVersionFilterName": { + "type": "string", + "enum": [ + "registration-version-status" + ] + }, + "RegistrationVersionInformation": { "type": "structure", + "required": [ + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], "members": { - "OriginationIdentityArn": { - "shape": "String", - "documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" - }, - "OriginationIdentity": { - "shape": "String", - "documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" + "VersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The version number of the registration.
" }, - "Keyword": { - "shape": "Keyword", - "documentation": "The keyword that was added.
" + "RegistrationVersionStatus": { + "shape": "RegistrationVersionStatus", + "documentation": "The status of the registration.
DRAFT
: The initial status of a registration version after it’s created.
SUBMITTED
: Your registration has been submitted.
REVIEWING
: Your registration has been accepted and is being reviewed.
APPROVED
: Your registration has been approved.
DISCARDED
: You've abandon this version of their registration to start over with a new version.
DENIED
: You must fix your registration and resubmit it.
REVOKED
: Your previously approved registration has been revoked.
ARCHIVED
: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The message associated with the keyword.
" + "RegistrationVersionStatusHistory": { + "shape": "RegistrationVersionStatusHistory", + "documentation": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" }, - "KeywordAction": { - "shape": "KeywordAction", - "documentation": "The action to perform when the keyword is used.
" + "DeniedReasons": { + "shape": "RegistrationDeniedReasonInformationList", + "documentation": "An array of RegistrationDeniedReasonInformation objects.
" } + }, + "documentation": "Provides information about the specified version of the registration.
" + }, + "RegistrationVersionInformationList": { + "type": "list", + "member": { + "shape": "RegistrationVersionInformation" } }, - "PutOptedOutNumberRequest": { + "RegistrationVersionNumber": { + "type": "long", + "box": true, + "max": 100000, + "min": 1 + }, + "RegistrationVersionNumberList": { + "type": "list", + "member": { + "shape": "RegistrationVersionNumber" + }, + "max": 5, + "min": 0 + }, + "RegistrationVersionStatus": { + "type": "string", + "enum": [ + "DRAFT", + "SUBMITTED", + "REVIEWING", + "APPROVED", + "DISCARDED", + "DENIED", + "REVOKED", + "ARCHIVED" + ] + }, + "RegistrationVersionStatusHistory": { "type": "structure", "required": [ - "OptOutListName", - "OptedOutNumber" + "DraftTimestamp" ], "members": { - "OptOutListName": { - "shape": "OptOutListNameOrArn", - "documentation": "The OptOutListName or OptOutListArn to add the phone number to.
" + "DraftTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration was in the draft state, in UNIX epoch time format.
" }, - "OptedOutNumber": { - "shape": "PhoneNumber", - "documentation": "The phone number to add to the OptOutList in E.164 format.
" - } - } - }, - "PutOptedOutNumberResult": { - "type": "structure", - "members": { - "OptOutListArn": { - "shape": "String", - "documentation": "The OptOutListArn that the phone number was removed from.
" + "SubmittedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration was in the submitted state, in UNIX epoch time format.
" }, - "OptOutListName": { - "shape": "OptOutListName", - "documentation": "The OptOutListName that the phone number was removed from.
" + "ReviewingTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration was in the reviewing state, in UNIX epoch time format.
" }, - "OptedOutNumber": { - "shape": "PhoneNumber", - "documentation": "The phone number that was added to the OptOutList.
" + "ApprovedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration was in the approved state, in UNIX epoch time format.
" }, - "OptedOutTimestamp": { + "DiscardedTimestamp": { "shape": "Timestamp", - "documentation": "The time that the phone number was added to the OptOutList, in UNIX epoch time format.
" + "documentation": "The time when the registration was in the discarded state, in UNIX epoch time format.
" }, - "EndUserOptedOut": { - "shape": "PrimitiveBoolean", - "documentation": "This is true if it was the end user who requested their phone number be removed.
" + "DeniedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration was in the denied state, in UNIX epoch time format.
" + }, + "RevokedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration was in the revoked state, in UNIX epoch time format.
" + }, + "ArchivedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the registration was in the archived state, in UNIX epoch time format.
" } - } - }, - "RegistrationId": { - "type": "string", - "max": 64, - "min": 1, - "pattern": "\\S+" + }, + "documentation": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" }, "ReleasePhoneNumberRequest": { "type": "structure", @@ -3673,6 +6388,10 @@ "shape": "TwoWayChannelArn", "documentation": "The Amazon Resource Name (ARN) of the TwoWayChannel.
" }, + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, "SelfManagedOptOutsEnabled": { "shape": "PrimitiveBoolean", "documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" @@ -3681,12 +6400,74 @@ "shape": "OptOutListName", "documentation": "The name of the OptOutList that was associated with the phone number.
" }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, "CreatedTimestamp": { "shape": "Timestamp", "documentation": "The time when the phone number was created, in UNIX epoch time format.
" } } }, + "ReleaseSenderIdRequest": { + "type": "structure", + "required": [ + "SenderId", + "IsoCountryCode" + ], + "members": { + "SenderId": { + "shape": "SenderIdOrArn", + "documentation": "The sender ID to release.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + } + }, + "ReleaseSenderIdResult": { + "type": "structure", + "required": [ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "Registered" + ], + "members": { + "SenderIdArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
" + }, + "SenderId": { + "shape": "SenderId", + "documentation": "The sender ID that was released.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageTypes": { + "shape": "MessageTypeList", + "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "MonthlyLeasingPrice": { + "shape": "String", + "documentation": "The monthly price, in US dollars, to lease the sender ID.
" + }, + "Registered": { + "shape": "PrimitiveBoolean", + "documentation": "True if the sender ID is registered.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + } + } + }, "RequestPhoneNumberRequest": { "type": "structure", "required": [ @@ -3714,14 +6495,14 @@ }, "OptOutListName": { "shape": "OptOutListNameOrArn", - "documentation": "The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.
" + "documentation": "The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
" }, "PoolId": { "shape": "PoolIdOrArn", "documentation": "The pool to associated with the phone number. You can use the PoolId or PoolArn.
" }, "RegistrationId": { - "shape": "RegistrationId", + "shape": "RegistrationIdOrArn", "documentation": "Use this field to attach your phone number for an external registration process.
" }, "DeletionProtectionEnabled": { @@ -3786,6 +6567,10 @@ "shape": "TwoWayChannelArn", "documentation": "The ARN used to identify the two way channel.
" }, + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, "SelfManagedOptOutsEnabled": { "shape": "PrimitiveBoolean", "documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" @@ -3802,6 +6587,10 @@ "shape": "String", "documentation": "The unique identifier of the pool associated with the phone number
" }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, "Tags": { "shape": "TagList", "documentation": "An array of key and value pair tags that are associated with the phone number.
" @@ -3812,14 +6601,227 @@ } } }, + "RequestSenderIdRequest": { + "type": "structure", + "required": [ + "SenderId", + "IsoCountryCode" + ], + "members": { + "SenderId": { + "shape": "SenderId", + "documentation": "The sender ID string to request.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageTypes": { + "shape": "MessageTypeList", + "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "DeletionProtectionEnabled": { + "shape": "Boolean", + "documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) to associate with the sender ID.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", + "idempotencyToken": true + } + } + }, + "RequestSenderIdResult": { + "type": "structure", + "required": [ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "DeletionProtectionEnabled", + "Registered" + ], + "members": { + "SenderIdArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
" + }, + "SenderId": { + "shape": "SenderId", + "documentation": "The sender ID that was requested.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageTypes": { + "shape": "MessageTypeList", + "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "MonthlyLeasingPrice": { + "shape": "String", + "documentation": "The monthly price, in US dollars, to lease the sender ID.
" + }, + "DeletionProtectionEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
" + }, + "Registered": { + "shape": "PrimitiveBoolean", + "documentation": "True if the sender ID is registered.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "An array of tags (key and value pairs) to associate with the sender ID.
" + } + } + }, "RequestableNumberType": { "type": "string", "enum": [ "LONG_CODE", "TOLL_FREE", - "TEN_DLC" + "TEN_DLC", + "SIMULATOR" ] }, + "ResourceIdOrArn": { + "type": "string", + "max": 256, + "min": 1, + "pattern": "[A-Za-z0-9_:/-]+" + }, + "SectionPath": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "[A-Za-z0-9_]+" + }, + "SectionPathList": { + "type": "list", + "member": { + "shape": "SectionPath" + }, + "max": 5, + "min": 0 + }, + "SelectChoice": { + "type": "string", + "max": 256, + "min": 1 + }, + "SelectChoiceList": { + "type": "list", + "member": { + "shape": "SelectChoice" + }, + "max": 100, + "min": 0 + }, + "SelectOptionDescription": { + "type": "structure", + "required": [ + "Option" + ], + "members": { + "Option": { + "shape": "String", + "documentation": "The value of the option.
" + }, + "Title": { + "shape": "String", + "documentation": "The title of the select option.
" + }, + "Description": { + "shape": "String", + "documentation": "A description of the option meaning.
" + } + }, + "documentation": "A description of each select option.
" + }, + "SelectOptionDescriptionsList": { + "type": "list", + "member": { + "shape": "SelectOptionDescription" + } + }, + "SelectValidation": { + "type": "structure", + "required": [ + "MinChoices", + "MaxChoices", + "Options" + ], + "members": { + "MinChoices": { + "shape": "Integer", + "documentation": "The minimum number of choices for the select.
" + }, + "MaxChoices": { + "shape": "Integer", + "documentation": "The maximum number of choices for the select.
" + }, + "Options": { + "shape": "StringList", + "documentation": "An array of strings for the possible selection options.
" + } + }, + "documentation": "Validation rules for a select field.
" + }, + "SendDestinationNumberVerificationCodeRequest": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberId", + "VerificationChannel" + ], + "members": { + "VerifiedDestinationNumberId": { + "shape": "VerifiedDestinationNumberIdOrArn", + "documentation": "The unique identifier for the verified destination phone number.
" + }, + "VerificationChannel": { + "shape": "VerificationChannel", + "documentation": "Choose to send the verification code as an SMS or voice message.
" + }, + "LanguageCode": { + "shape": "LanguageCode", + "documentation": "Choose the language to use for the message.
" + }, + "OriginationIdentity": { + "shape": "VerificationMessageOriginationIdentity", + "documentation": "The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" + }, + "ConfigurationSetName": { + "shape": "ConfigurationSetNameOrArn", + "documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
" + }, + "Context": { + "shape": "ContextMap", + "documentation": "You can specify custom data in this field. If you do, that data is logged to the event destination.
" + }, + "DestinationCountryParameters": { + "shape": "DestinationCountryParameters", + "documentation": "This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
" + } + } + }, + "SendDestinationNumberVerificationCodeResult": { + "type": "structure", + "required": [ + "MessageId" + ], + "members": { + "MessageId": { + "shape": "String", + "documentation": "The unique identifier for the message.
" + } + } + }, "SendTextMessageRequest": { "type": "structure", "required": [ @@ -3840,7 +6842,7 @@ }, "MessageType": { "shape": "MessageType", - "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + "documentation": "The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" }, "Keyword": { "shape": "Keyword", @@ -3994,7 +6996,9 @@ "enum": [ "sender-id", "iso-country-code", - "message-type" + "message-type", + "deletion-protection-enabled", + "registered" ] }, "SenderIdInformation": { @@ -4004,7 +7008,9 @@ "SenderId", "IsoCountryCode", "MessageTypes", - "MonthlyLeasingPrice" + "MonthlyLeasingPrice", + "DeletionProtectionEnabled", + "Registered" ], "members": { "SenderIdArn": { @@ -4026,6 +7032,18 @@ "MonthlyLeasingPrice": { "shape": "String", "documentation": "The monthly leasing price, in US dollars.
" + }, + "DeletionProtectionEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
" + }, + "Registered": { + "shape": "PrimitiveBoolean", + "documentation": "True if the sender ID is registered.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" } }, "documentation": "The information for all SenderIds in an Amazon Web Services account.
" @@ -4223,6 +7241,98 @@ "String": { "type": "string" }, + "StringList": { + "type": "list", + "member": { + "shape": "String" + } + }, + "StringMap": { + "type": "map", + "key": { + "shape": "String" + }, + "value": { + "shape": "String" + } + }, + "SubmitRegistrationVersionRequest": { + "type": "structure", + "required": [ + "RegistrationId" + ], + "members": { + "RegistrationId": { + "shape": "RegistrationIdOrArn", + "documentation": "The unique identifier for the registration.
" + } + } + }, + "SubmitRegistrationVersionResult": { + "type": "structure", + "required": [ + "RegistrationArn", + "RegistrationId", + "VersionNumber", + "RegistrationVersionStatus", + "RegistrationVersionStatusHistory" + ], + "members": { + "RegistrationArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the registration.
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, + "VersionNumber": { + "shape": "RegistrationVersionNumber", + "documentation": "The version number of the registration.
" + }, + "RegistrationVersionStatus": { + "shape": "RegistrationVersionStatus", + "documentation": "The status of the registration version.
DRAFT
: The initial status of a registration version after it’s created.
SUBMITTED
: Your registration has been submitted.
REVIEWING
: Your registration has been accepted and is being reviewed.
APPROVED
: Your registration has been approved.
DISCARDED
: You've abandon this version of their registration to start over with a new version.
DENIED
: You must fix your registration and resubmit it.
REVOKED
: Your previously approved registration has been revoked.
ARCHIVED
: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" + } + } + }, + "SupportedAssociation": { + "type": "structure", + "required": [ + "ResourceType", + "AssociationBehavior", + "DisassociationBehavior" + ], + "members": { + "ResourceType": { + "shape": "String", + "documentation": "Defines the behavior of when an origination identity and registration can be associated with each other.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "AssociationBehavior": { + "shape": "RegistrationAssociationBehavior", + "documentation": "The association behavior.
ASSOCIATE_BEFORE_SUBMIT
The origination identity has to be supplied when creating a registration.
ASSOCIATE_ON_APPROVAL
This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.
ASSOCIATE_AFTER_COMPLETE
This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
The disassociation behavior.
DISASSOCIATE_ALL_CLOSES_REGISTRATION
All origination identities must be disassociated from the registration before the registration can be closed.
DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION
All origination identities must be disassociated from the registration before the registration can be deleted.
DELETE_REGISTRATION_DISASSOCIATES
The registration can be deleted and all origination identities will be disasscoiated.
The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.
" + }, + "SupportedAssociationList": { + "type": "list", + "member": { + "shape": "SupportedAssociation" + } + }, "Tag": { "type": "structure", "required": [ @@ -4302,6 +7412,34 @@ "min": 1, "pattern": "[A-Za-z0-9_:/\\+-]+" }, + "TextValidation": { + "type": "structure", + "required": [ + "MinLength", + "MaxLength", + "Pattern" + ], + "members": { + "MinLength": { + "shape": "Integer", + "documentation": "The minimum number of characters for the text field.
" + }, + "MaxLength": { + "shape": "Integer", + "documentation": "The maximum number of characters for the text field.
" + }, + "Pattern": { + "shape": "String", + "documentation": "The regular expression used to validate the text field.
" + } + }, + "documentation": "Validation rules for a text field.
" + }, + "TextValue": { + "type": "string", + "max": 2048, + "min": 1 + }, "TimeToLive": { "type": "integer", "box": true, @@ -4315,7 +7453,7 @@ "type": "string", "max": 2048, "min": 20, - "pattern": "arn:\\S+" + "pattern": "\\S+" }, "UntagResourceRequest": { "type": "structure", @@ -4359,7 +7497,7 @@ }, "MatchingEventTypes": { "shape": "EventTypeList", - "documentation": "An array of event types that determine which events to log.
" + "documentation": "An array of event types that determine which events to log.
The TEXT_SENT
event type is not supported.
The Amazon Resource Name (ARN) of the two way channel.
" }, + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, "SelfManagedOptOutsEnabled": { "shape": "Boolean", "documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" @@ -4471,6 +7613,10 @@ "shape": "TwoWayChannelArn", "documentation": "The Amazon Resource Name (ARN) of the two way channel.
" }, + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, "SelfManagedOptOutsEnabled": { "shape": "PrimitiveBoolean", "documentation": "This is true if self managed opt-out are enabled.
" @@ -4483,6 +7629,10 @@ "shape": "PrimitiveBoolean", "documentation": "When set to true the phone number can't be deleted.
" }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + }, "CreatedTimestamp": { "shape": "Timestamp", "documentation": "The time when the phone number was created, in UNIX epoch time format.
" @@ -4507,6 +7657,10 @@ "shape": "TwoWayChannelArn", "documentation": "The Amazon Resource Name (ARN) of the two way channel.
" }, + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, "SelfManagedOptOutsEnabled": { "shape": "Boolean", "documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" @@ -4552,6 +7706,10 @@ "shape": "TwoWayChannelArn", "documentation": "The Amazon Resource Name (ARN) of the two way channel.
" }, + "TwoWayChannelRole": { + "shape": "IamRoleArn", + "documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + }, "SelfManagedOptOutsEnabled": { "shape": "PrimitiveBoolean", "documentation": "When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" @@ -4574,6 +7732,233 @@ } } }, + "UpdateSenderIdRequest": { + "type": "structure", + "required": [ + "SenderId", + "IsoCountryCode" + ], + "members": { + "SenderId": { + "shape": "SenderIdOrArn", + "documentation": "The sender ID to update.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "DeletionProtectionEnabled": { + "shape": "Boolean", + "documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
" + } + } + }, + "UpdateSenderIdResult": { + "type": "structure", + "required": [ + "SenderIdArn", + "SenderId", + "IsoCountryCode", + "MessageTypes", + "MonthlyLeasingPrice", + "DeletionProtectionEnabled", + "Registered" + ], + "members": { + "SenderIdArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
" + }, + "SenderId": { + "shape": "SenderId", + "documentation": "The sender ID that was updated.
" + }, + "IsoCountryCode": { + "shape": "IsoCountryCode", + "documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + }, + "MessageTypes": { + "shape": "MessageTypeList", + "documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + }, + "MonthlyLeasingPrice": { + "shape": "String", + "documentation": "The monthly price, in US dollars, to lease the sender ID.
" + }, + "DeletionProtectionEnabled": { + "shape": "PrimitiveBoolean", + "documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
" + }, + "Registered": { + "shape": "PrimitiveBoolean", + "documentation": "True if the sender ID is registered..
" + }, + "RegistrationId": { + "shape": "String", + "documentation": "The unique identifier for the registration.
" + } + } + }, + "VerificationChannel": { + "type": "string", + "enum": [ + "TEXT", + "VOICE" + ] + }, + "VerificationCode": { + "type": "string", + "max": 20, + "min": 1, + "pattern": "[A-Za-z0-9]+" + }, + "VerificationMessageOriginationIdentity": { + "type": "string", + "max": 256, + "min": 1, + "pattern": "[A-Za-z0-9_:/\\+-]+" + }, + "VerificationStatus": { + "type": "string", + "enum": [ + "PENDING", + "VERIFIED" + ] + }, + "VerifiedDestinationNumberFilter": { + "type": "structure", + "required": [ + "Name", + "Values" + ], + "members": { + "Name": { + "shape": "VerifiedDestinationNumberFilterName", + "documentation": "The name of the attribute to filter on.
" + }, + "Values": { + "shape": "FilterValueList", + "documentation": "An array of values to filter on.
" + } + }, + "documentation": "The filter definition for filtering verified destination phone numbers that meets a specified criteria.
" + }, + "VerifiedDestinationNumberFilterList": { + "type": "list", + "member": { + "shape": "VerifiedDestinationNumberFilter" + }, + "max": 20, + "min": 0 + }, + "VerifiedDestinationNumberFilterName": { + "type": "string", + "enum": [ + "status" + ] + }, + "VerifiedDestinationNumberIdList": { + "type": "list", + "member": { + "shape": "VerifiedDestinationNumberIdOrArn" + }, + "max": 5, + "min": 0 + }, + "VerifiedDestinationNumberIdOrArn": { + "type": "string", + "max": 256, + "min": 1, + "pattern": "[A-Za-z0-9_:/-]+" + }, + "VerifiedDestinationNumberInformation": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "Status", + "CreatedTimestamp" + ], + "members": { + "VerifiedDestinationNumberArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
" + }, + "VerifiedDestinationNumberId": { + "shape": "String", + "documentation": "The unique identifier for the verified destination phone number.
" + }, + "DestinationPhoneNumber": { + "shape": "PhoneNumber", + "documentation": "The verified destination phone number, in E.164 format.
" + }, + "Status": { + "shape": "VerificationStatus", + "documentation": "The status of the verified destination phone number.
PENDING
: The phone number hasn't been verified yet.
VERIFIED
: The phone number is verified and can receive messages.
The time when the destination phone number was created, in UNIX epoch time format.
" + } + }, + "documentation": "Provides information about the requested verified destintion phone number.
" + }, + "VerifiedDestinationNumberInformationList": { + "type": "list", + "member": { + "shape": "VerifiedDestinationNumberInformation" + } + }, + "VerifyDestinationNumberRequest": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberId", + "VerificationCode" + ], + "members": { + "VerifiedDestinationNumberId": { + "shape": "VerifiedDestinationNumberIdOrArn", + "documentation": "The unique identifier for the verififed destination phone number.
" + }, + "VerificationCode": { + "shape": "VerificationCode", + "documentation": "The verification code that was received by the verified destination phone number.
" + } + } + }, + "VerifyDestinationNumberResult": { + "type": "structure", + "required": [ + "VerifiedDestinationNumberArn", + "VerifiedDestinationNumberId", + "DestinationPhoneNumber", + "Status", + "CreatedTimestamp" + ], + "members": { + "VerifiedDestinationNumberArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
" + }, + "VerifiedDestinationNumberId": { + "shape": "String", + "documentation": "The unique identifier for the verified destination phone number.
" + }, + "DestinationPhoneNumber": { + "shape": "PhoneNumber", + "documentation": "The phone number in E.164 format.
" + }, + "Status": { + "shape": "VerificationStatus", + "documentation": "The status for being able to send messages to the phone number.
" + }, + "CreatedTimestamp": { + "shape": "Timestamp", + "documentation": "The time when the destination phone number was created, in UNIX epoch time format.
" + } + } + }, "VoiceId": { "type": "string", "enum": [ @@ -4658,5 +8043,5 @@ "pattern": "[A-Za-z0-9_:/\\+-]+" } }, - "documentation": "Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, it's also helpful to review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.
" + "documentation": "Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, it's also helpful to review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.
" } \ No newline at end of file diff --git a/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json b/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json index ecdcd93a20..6a4fd39a6e 100644 --- a/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json +++ b/apis/pinpoint-sms-voice-v2-2022-03-31.paginators.json @@ -48,6 +48,48 @@ "limit_key": "MaxResults", "result_key": "Pools" }, + "DescribeRegistrationAttachments": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationAttachments" + }, + "DescribeRegistrationFieldDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationFieldDefinitions" + }, + "DescribeRegistrationFieldValues": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationFieldValues" + }, + "DescribeRegistrationSectionDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationSectionDefinitions" + }, + "DescribeRegistrationTypeDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationTypeDefinitions" + }, + "DescribeRegistrationVersions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationVersions" + }, + "DescribeRegistrations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Registrations" + }, "DescribeSenderIds": { "input_token": "NextToken", "output_token": "NextToken", @@ -60,11 +102,23 @@ "limit_key": "MaxResults", "result_key": "SpendLimits" }, + "DescribeVerifiedDestinationNumbers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VerifiedDestinationNumbers" + }, "ListPoolOriginationIdentities": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "OriginationIdentities" + }, + "ListRegistrationAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RegistrationAssociations" } } } diff --git a/apis/polly-2016-06-10.normal.json b/apis/polly-2016-06-10.normal.json index bc3a384e3a..cc622c4ce8 100644 --- a/apis/polly-2016-06-10.normal.json +++ b/apis/polly-2016-06-10.normal.json @@ -324,7 +324,7 @@ "members": { "Engine": { "shape": "Engine", - "documentation": "Specifies the engine (standard
or neural
) used by Amazon Polly when processing input text for speech synthesis.
Specifies the engine (standard
, neural
or long-form
) used by Amazon Polly when processing input text for speech synthesis.
Specifies the engine (standard
or neural
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
Specifies the engine (standard
, neural
or long-form
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" + "documentation": "The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" }, "SnsTopicArn": { "shape": "SnsTopicArn", @@ -790,7 +791,7 @@ "members": { "Engine": { "shape": "Engine", - "documentation": "Specifies the engine (standard
or neural
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
Specifies the engine (standard
, neural
or long-form
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" + "documentation": "The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" }, "SpeechMarkTypes": { "shape": "SpeechMarkTypeList", @@ -867,7 +868,7 @@ "members": { "Engine": { "shape": "Engine", - "documentation": "Specifies the engine (standard
or neural
) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.
NTTS-only voices
When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural
. If the engine is not specified, or is set to standard
, this will result in an error.
Type: String
Valid Values: standard
| neural
Required: Yes
Standard voices
For standard voices, this is not required; the engine parameter defaults to standard
. If the engine is not specified, or is set to standard
and an NTTS-only voice is selected, this will result in an error.
Specifies the engine (standard
, neural
or long-form
) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.
NTTS-only voices
When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural
. If the engine is not specified, or is set to standard
, this will result in an error.
long-form-only voices
When using long-form-only voices such as Danielle (en-US), this parameter is required and must be set to long-form
. If the engine is not specified, or is set to standard
or neural
, this will result in an error.
Type: String
Valid Values: standard
| neural
| long-form
Required: Yes
Standard voices
For standard voices, this is not required; the engine parameter defaults to standard
. If the engine is not specified, or is set to standard
and an NTTS-only voice is selected, this will result in an error.
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" + "documentation": "The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\". The default value for long-form voices is \"24000\".
Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
" }, "SpeechMarkTypes": { "shape": "SpeechMarkTypeList", @@ -980,7 +981,7 @@ }, "SupportedEngines": { "shape": "EngineList", - "documentation": "Specifies which engines (standard
or neural
) that are supported by a given voice.
Specifies which engines (standard
, neural
or long-form
) are supported by a given voice.
Description of the voice.
" diff --git a/apis/quicksight-2018-04-01.min.json b/apis/quicksight-2018-04-01.min.json index 9ef5971415..08e971963f 100644 --- a/apis/quicksight-2018-04-01.min.json +++ b/apis/quicksight-2018-04-01.min.json @@ -262,6 +262,9 @@ }, "FolderArns": { "shape": "Sm3" + }, + "LinkSharingConfiguration": { + "shape": "Smr" } } }, @@ -301,38 +304,38 @@ "DataSetId": {}, "Name": {}, "PhysicalTableMap": { - "shape": "Smv" + "shape": "Smw" }, "LogicalTableMap": { - "shape": "Snf" + "shape": "Sng" }, "ImportMode": {}, "ColumnGroups": { - "shape": "Som" + "shape": "Son" }, "FieldFolders": { - "shape": "Sos" + "shape": "Sot" }, "Permissions": { "shape": "S19" }, "RowLevelPermissionDataSet": { - "shape": "Sox" + "shape": "Soy" }, "RowLevelPermissionTagConfiguration": { - "shape": "Sp1" + "shape": "Sp2" }, "ColumnLevelPermissionRules": { - "shape": "Sp9" + "shape": "Spa" }, "Tags": { "shape": "Sb" }, "DataSetUsageConfiguration": { - "shape": "Spd" + "shape": "Spe" }, "DatasetParameters": { - "shape": "Spe" + "shape": "Spf" }, "FolderArns": { "shape": "Sm3" @@ -375,19 +378,19 @@ "Name": {}, "Type": {}, "DataSourceParameters": { - "shape": "Spt" + "shape": "Spu" }, "Credentials": { - "shape": "Sr6" + "shape": "Sra" }, "Permissions": { "shape": "S19" }, "VpcConnectionProperties": { - "shape": "Srd" + "shape": "Srh" }, "SslProperties": { - "shape": "Sre" + "shape": "Sri" }, "Tags": { "shape": "Sb" @@ -532,7 +535,7 @@ "type": "structure", "members": { "Group": { - "shape": "Sru" + "shape": "Sry" }, "RequestId": {}, "Status": { @@ -578,7 +581,7 @@ "type": "structure", "members": { "GroupMember": { - "shape": "Sry" + "shape": "Ss2" }, "RequestId": {}, "Status": { @@ -609,7 +612,7 @@ "AssignmentStatus": {}, "PolicyArn": {}, "Identities": { - "shape": "Ss2" + "shape": "Ss6" }, "Namespace": { "location": "uri", @@ -625,7 +628,7 @@ "AssignmentStatus": {}, "PolicyArn": {}, "Identities": { - "shape": "Ss2" + "shape": "Ss6" }, "RequestId": {}, "Status": { @@ -737,7 +740,7 @@ "locationName": "AwsAccountId" }, "Schedule": { - "shape": "Ssf" + "shape": "Ssj" } } }, @@ -754,6 +757,48 @@ } } }, + "CreateRoleMembership": { + "http": { + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}" + }, + "input": { + "type": "structure", + "required": [ + "MemberName", + "AwsAccountId", + "Namespace", + "Role" + ], + "members": { + "MemberName": { + "location": "uri", + "locationName": "MemberName" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + }, + "Role": { + "location": "uri", + "locationName": "Role" + } + } + }, + "output": { + "type": "structure", + "members": { + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, "CreateTemplate": { "http": { "requestUri": "/accounts/{AwsAccountId}/templates/{TemplateId}" @@ -778,14 +823,14 @@ "shape": "S19" }, "SourceEntity": { - "shape": "Sso" + "shape": "Ssv" }, "Tags": { "shape": "Sb" }, "VersionDescription": {}, "Definition": { - "shape": "Ssr" + "shape": "Ssy" }, "ValidationStrategy": { "shape": "Sm1" @@ -841,7 +886,7 @@ "type": "structure", "members": { "TemplateAlias": { - "shape": "St6" + "shape": "Std" }, "Status": { "location": "statusCode", @@ -877,7 +922,7 @@ "BaseThemeId": {}, "VersionDescription": {}, "Configuration": { - "shape": "St9" + "shape": "Stg" }, "Permissions": { "shape": "S19" @@ -936,7 +981,7 @@ "type": "structure", "members": { "ThemeAlias": { - "shape": "Stp" + "shape": "Stw" }, "Status": { "location": "statusCode", @@ -964,7 +1009,7 @@ }, "TopicId": {}, "Topic": { - "shape": "Sts" + "shape": "Stz" }, "Tags": { "shape": "Sb" @@ -1009,7 +1054,7 @@ "DatasetArn": {}, "DatasetName": {}, "RefreshSchedule": { - "shape": "Svg" + "shape": "Svn" } } }, @@ -1049,13 +1094,13 @@ "VPCConnectionId": {}, "Name": {}, "SubnetIds": { - "shape": "Svl" + "shape": "Svs" }, "SecurityGroupIds": { - "shape": "Svn" + "shape": "Svu" }, "DnsResolvers": { - "shape": "Svp" + "shape": "Svw" }, "RoleArn": {}, "Tags": { @@ -1599,6 +1644,86 @@ } } }, + "DeleteRoleCustomPermission": { + "http": { + "method": "DELETE", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission" + }, + "input": { + "type": "structure", + "required": [ + "Role", + "AwsAccountId", + "Namespace" + ], + "members": { + "Role": { + "location": "uri", + "locationName": "Role" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "RequestId": {}, + "Status": { + "type": "integer" + } + } + } + }, + "DeleteRoleMembership": { + "http": { + "method": "DELETE", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}" + }, + "input": { + "type": "structure", + "required": [ + "MemberName", + "Role", + "AwsAccountId", + "Namespace" + ], + "members": { + "MemberName": { + "location": "uri", + "locationName": "MemberName" + }, + "Role": { + "location": "uri", + "locationName": "Role" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, "DeleteTemplate": { "http": { "method": "DELETE", @@ -2108,10 +2233,10 @@ "Name": {}, "Status": {}, "Errors": { - "shape": "Sxj" + "shape": "Sxu" }, "DataSetArns": { - "shape": "Sxo" + "shape": "Sxz" }, "ThemeArn": {}, "CreatedTime": { @@ -2121,10 +2246,7 @@ "type": "timestamp" }, "Sheets": { - "shape": "Sxp" - }, - "Options": { - "shape": "Slz" + "shape": "Sy0" } } }, @@ -2164,7 +2286,7 @@ "AnalysisId": {}, "Name": {}, "Errors": { - "shape": "Sxj" + "shape": "Sxu" }, "ResourceStatus": {}, "ThemeArn": {}, @@ -2243,7 +2365,9 @@ "type": "structure", "members": { "JobStatus": {}, - "DownloadUrl": {}, + "DownloadUrl": { + "shape": "Sy9" + }, "Errors": { "type": "list", "member": { @@ -2262,19 +2386,38 @@ "AssetBundleExportJobId": {}, "AwsAccountId": {}, "ResourceArns": { - "shape": "Sy0" + "shape": "Syc" }, "IncludeAllDependencies": { "type": "boolean" }, "ExportFormat": {}, "CloudFormationOverridePropertyConfiguration": { - "shape": "Sy2" + "shape": "Sye" }, "RequestId": {}, "Status": { "location": "statusCode", "type": "integer" + }, + "IncludePermissions": { + "type": "boolean" + }, + "IncludeTags": { + "type": "boolean" + }, + "ValidationStrategy": { + "shape": "Sz8" + }, + "Warnings": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Arn": {}, + "Message": {} + } + } } } } @@ -2306,10 +2449,10 @@ "members": { "JobStatus": {}, "Errors": { - "shape": "Syz" + "shape": "Sze" }, "RollbackErrors": { - "shape": "Syz" + "shape": "Sze" }, "Arn": {}, "CreatedTime": { @@ -2320,18 +2463,29 @@ "AssetBundleImportSource": { "type": "structure", "members": { - "Body": {}, + "Body": { + "shape": "Sy9" + }, "S3Uri": {} } }, "OverrideParameters": { - "shape": "Sz3" + "shape": "Szi" }, "FailureAction": {}, "RequestId": {}, "Status": { "location": "statusCode", "type": "integer" + }, + "OverridePermissions": { + "shape": "S101" + }, + "OverrideTags": { + "shape": "S10h" + }, + "OverrideValidationStrategy": { + "shape": "S10u" } } } @@ -2383,7 +2537,7 @@ "type": "timestamp" }, "Errors": { - "shape": "Szq" + "shape": "S10z" }, "VersionNumber": { "type": "long" @@ -2392,15 +2546,12 @@ "Arn": {}, "SourceEntityArn": {}, "DataSetArns": { - "shape": "Sxo" + "shape": "Sxz" }, "Description": {}, "ThemeArn": {}, "Sheets": { - "shape": "Sxp" - }, - "Options": { - "shape": "Slz" + "shape": "Sy0" } } }, @@ -2459,7 +2610,7 @@ "members": { "DashboardId": {}, "Errors": { - "shape": "Szq" + "shape": "S10z" }, "Name": {}, "ResourceStatus": {}, @@ -2514,7 +2665,7 @@ }, "RequestId": {}, "LinkSharingConfiguration": { - "shape": "Szx" + "shape": "Smr" } } } @@ -2570,7 +2721,7 @@ } }, "SnapshotConfiguration": { - "shape": "S104" + "shape": "S11c" }, "Arn": {}, "JobStatus": {}, @@ -2639,7 +2790,7 @@ "type": "structure", "members": { "Files": { - "shape": "S107" + "shape": "S11f" }, "S3Results": { "type": "list", @@ -2647,11 +2798,10 @@ "type": "structure", "members": { "S3DestinationConfiguration": { - "shape": "S10g" + "shape": "S11o" }, "S3Uri": { - "type": "string", - "sensitive": true + "shape": "Sy9" }, "ErrorInfo": { "type": "list", @@ -2727,10 +2877,10 @@ "type": "timestamp" }, "PhysicalTableMap": { - "shape": "Smv" + "shape": "Smw" }, "LogicalTableMap": { - "shape": "Snf" + "shape": "Sng" }, "OutputColumns": { "type": "list", @@ -2749,25 +2899,25 @@ "type": "long" }, "ColumnGroups": { - "shape": "Som" + "shape": "Son" }, "FieldFolders": { - "shape": "Sos" + "shape": "Sot" }, "RowLevelPermissionDataSet": { - "shape": "Sox" + "shape": "Soy" }, "RowLevelPermissionTagConfiguration": { - "shape": "Sp1" + "shape": "Sp2" }, "ColumnLevelPermissionRules": { - "shape": "Sp9" + "shape": "Spa" }, "DataSetUsageConfiguration": { - "shape": "Spd" + "shape": "Spe" }, "DatasetParameters": { - "shape": "Spe" + "shape": "Spf" } } }, @@ -2848,7 +2998,7 @@ "type": "integer" }, "DataSetRefreshProperties": { - "shape": "S115" + "shape": "S12c" } } } @@ -2879,7 +3029,7 @@ "type": "structure", "members": { "DataSource": { - "shape": "S11d" + "shape": "S12k" }, "RequestId": {}, "Status": { @@ -3115,7 +3265,7 @@ "type": "structure", "members": { "Group": { - "shape": "Sru" + "shape": "Sry" }, "RequestId": {}, "Status": { @@ -3161,7 +3311,7 @@ "type": "structure", "members": { "GroupMember": { - "shape": "Sry" + "shape": "Ss2" }, "RequestId": {}, "Status": { @@ -3209,7 +3359,7 @@ "AssignmentName": {}, "PolicyArn": {}, "Identities": { - "shape": "Ss2" + "shape": "Ss6" }, "AssignmentStatus": {} } @@ -3253,7 +3403,7 @@ "type": "structure", "members": { "Ingestion": { - "shape": "S120" + "shape": "S137" }, "RequestId": {}, "Status": { @@ -3285,7 +3435,7 @@ "members": { "AwsAccountId": {}, "IpRestrictionRuleMap": { - "shape": "S129" + "shape": "S13g" }, "Enabled": { "type": "boolean" @@ -3324,7 +3474,7 @@ "type": "structure", "members": { "Namespace": { - "shape": "S12e" + "shape": "S13l" }, "RequestId": {}, "Status": { @@ -3365,7 +3515,7 @@ "type": "structure", "members": { "RefreshSchedule": { - "shape": "Ssf" + "shape": "Ssj" }, "Status": { "location": "statusCode", @@ -3376,6 +3526,44 @@ } } }, + "DescribeRoleCustomPermission": { + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission" + }, + "input": { + "type": "structure", + "required": [ + "Role", + "AwsAccountId", + "Namespace" + ], + "members": { + "Role": { + "location": "uri", + "locationName": "Role" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "CustomPermissionsName": {}, + "RequestId": {}, + "Status": { + "type": "integer" + } + } + } + }, "DescribeTemplate": { "http": { "method": "GET", @@ -3422,23 +3610,20 @@ "type": "timestamp" }, "Errors": { - "shape": "S12n" + "shape": "S13x" }, "VersionNumber": { "type": "long" }, "Status": {}, "DataSetConfigurations": { - "shape": "Sss" + "shape": "Ssz" }, "Description": {}, "SourceEntityArn": {}, "ThemeArn": {}, "Sheets": { - "shape": "Sxp" - }, - "Options": { - "shape": "Slz" + "shape": "Sy0" } } }, @@ -3490,7 +3675,7 @@ "type": "structure", "members": { "TemplateAlias": { - "shape": "St6" + "shape": "Std" }, "Status": { "location": "statusCode", @@ -3537,12 +3722,12 @@ "Name": {}, "TemplateId": {}, "Errors": { - "shape": "S12n" + "shape": "S13x" }, "ResourceStatus": {}, "ThemeArn": {}, "Definition": { - "shape": "Ssr" + "shape": "Ssy" }, "Status": { "location": "statusCode", @@ -3643,7 +3828,7 @@ "type": "timestamp" }, "Configuration": { - "shape": "St9" + "shape": "Stg" }, "Errors": { "type": "list", @@ -3706,7 +3891,7 @@ "type": "structure", "members": { "ThemeAlias": { - "shape": "Stp" + "shape": "Stw" }, "Status": { "location": "statusCode", @@ -3782,7 +3967,7 @@ "Arn": {}, "TopicId": {}, "Topic": { - "shape": "Sts" + "shape": "Stz" }, "RequestId": {}, "Status": { @@ -3910,7 +4095,7 @@ "TopicArn": {}, "DatasetArn": {}, "RefreshSchedule": { - "shape": "Svg" + "shape": "Svn" }, "Status": { "location": "statusCode", @@ -3951,7 +4136,7 @@ "type": "structure", "members": { "User": { - "shape": "S13l" + "shape": "S14v" }, "RequestId": {}, "Status": { @@ -3994,15 +4179,15 @@ "Name": {}, "VPCId": {}, "SecurityGroupIds": { - "shape": "Svn" + "shape": "Svu" }, "DnsResolvers": { - "shape": "Su9" + "shape": "Sug" }, "Status": {}, "AvailabilityStatus": {}, "NetworkInterfaces": { - "shape": "S13s" + "shape": "S151" }, "RoleArn": {}, "CreatedTime": { @@ -4042,7 +4227,7 @@ }, "Namespace": {}, "SessionTags": { - "shape": "S13y" + "shape": "S157" }, "AuthorizedResourceArns": { "type": "list", @@ -4067,7 +4252,7 @@ ], "members": { "InitialDashboardVisualId": { - "shape": "S144" + "shape": "S15d" } } }, @@ -4083,7 +4268,7 @@ } }, "AllowedDomains": { - "shape": "Su9" + "shape": "Sug" } } }, @@ -4097,7 +4282,7 @@ ], "members": { "EmbedUrl": { - "shape": "S147" + "shape": "S15g" }, "Status": { "location": "statusCode", @@ -4142,7 +4327,7 @@ "type": "structure", "members": { "StatePersistence": { - "shape": "S14c" + "shape": "S15l" }, "Bookmarks": { "type": "structure", @@ -4167,7 +4352,7 @@ "type": "structure", "members": { "StatePersistence": { - "shape": "S14c" + "shape": "S15l" } } } @@ -4186,14 +4371,14 @@ ], "members": { "InitialDashboardVisualId": { - "shape": "S144" + "shape": "S15d" } } } } }, "AllowedDomains": { - "shape": "Su9" + "shape": "Sug" } } }, @@ -4206,7 +4391,7 @@ ], "members": { "EmbedUrl": { - "shape": "S147" + "shape": "S15g" }, "Status": { "location": "statusCode", @@ -4281,7 +4466,7 @@ "type": "structure", "members": { "EmbedUrl": { - "shape": "S147" + "shape": "S15g" }, "Status": { "location": "statusCode", @@ -4325,7 +4510,7 @@ "type": "structure", "members": { "EmbedUrl": { - "shape": "S147" + "shape": "S15g" }, "Status": { "location": "statusCode", @@ -4365,7 +4550,7 @@ "type": "structure", "members": { "AnalysisSummaryList": { - "shape": "S14t" + "shape": "S162" }, "NextToken": {}, "Status": { @@ -4419,7 +4604,13 @@ "IncludeAllDependencies": { "type": "boolean" }, - "ExportFormat": {} + "ExportFormat": {}, + "IncludePermissions": { + "type": "boolean" + }, + "IncludeTags": { + "type": "boolean" + } } } }, @@ -4576,7 +4767,7 @@ "type": "structure", "members": { "DashboardSummaryList": { - "shape": "S159" + "shape": "S16i" }, "NextToken": {}, "Status": { @@ -4617,7 +4808,7 @@ "type": "structure", "members": { "DataSetSummaries": { - "shape": "S15d" + "shape": "S16m" }, "NextToken": {}, "RequestId": {}, @@ -4660,7 +4851,7 @@ "DataSources": { "type": "list", "member": { - "shape": "S11d" + "shape": "S12k" } }, "NextToken": {}, @@ -4759,7 +4950,7 @@ "type": "integer" }, "FolderSummaryList": { - "shape": "S15o" + "shape": "S16x" }, "NextToken": {}, "RequestId": {} @@ -4808,7 +4999,7 @@ "GroupMemberList": { "type": "list", "member": { - "shape": "Sry" + "shape": "Ss2" } }, "NextToken": {}, @@ -4855,7 +5046,7 @@ "type": "structure", "members": { "GroupList": { - "shape": "S15v" + "shape": "S174" }, "NextToken": {}, "RequestId": {}, @@ -5018,7 +5209,7 @@ "Ingestions": { "type": "list", "member": { - "shape": "S120" + "shape": "S137" } }, "NextToken": {}, @@ -5062,7 +5253,7 @@ "Namespaces": { "type": "list", "member": { - "shape": "S12e" + "shape": "S13l" } }, "NextToken": {}, @@ -5102,7 +5293,7 @@ "RefreshSchedules": { "type": "list", "member": { - "shape": "Ssf" + "shape": "Ssj" } }, "Status": { @@ -5113,6 +5304,57 @@ } } }, + "ListRoleMemberships": { + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members" + }, + "input": { + "type": "structure", + "required": [ + "Role", + "AwsAccountId", + "Namespace" + ], + "members": { + "Role": { + "location": "uri", + "locationName": "Role" + }, + "NextToken": { + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "location": "querystring", + "locationName": "max-results", + "type": "integer" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "location": "uri", + "locationName": "Namespace" + } + } + }, + "output": { + "type": "structure", + "members": { + "MembersList": { + "shape": "Sk" + }, + "NextToken": {}, + "RequestId": {}, + "Status": { + "location": "statusCode", + "type": "integer" + } + } + } + }, "ListTagsForResource": { "http": { "method": "GET", @@ -5181,7 +5423,7 @@ "TemplateAliasList": { "type": "list", "member": { - "shape": "St6" + "shape": "Std" } }, "Status": { @@ -5348,7 +5590,7 @@ "ThemeAliasList": { "type": "list", "member": { - "shape": "Stp" + "shape": "Stw" } }, "Status": { @@ -5518,7 +5760,7 @@ "DatasetArn": {}, "DatasetName": {}, "RefreshSchedule": { - "shape": "Svg" + "shape": "Svn" } } } @@ -5620,7 +5862,7 @@ "type": "structure", "members": { "GroupList": { - "shape": "S15v" + "shape": "S174" }, "NextToken": {}, "RequestId": {}, @@ -5668,7 +5910,7 @@ "UserList": { "type": "list", "member": { - "shape": "S13l" + "shape": "S14v" } }, "NextToken": {}, @@ -5719,15 +5961,15 @@ "Name": {}, "VPCId": {}, "SecurityGroupIds": { - "shape": "Svn" + "shape": "Svu" }, "DnsResolvers": { - "shape": "Su9" + "shape": "Sug" }, "Status": {}, "AvailabilityStatus": {}, "NetworkInterfaces": { - "shape": "S13s" + "shape": "S151" }, "RoleArn": {}, "CreatedTime": { @@ -5770,7 +6012,7 @@ "locationName": "DataSetId" }, "DataSetRefreshProperties": { - "shape": "S115" + "shape": "S12c" } } }, @@ -5826,7 +6068,7 @@ "type": "structure", "members": { "User": { - "shape": "S13l" + "shape": "S14v" }, "UserInvitationUrl": {}, "RequestId": {}, @@ -5907,7 +6149,7 @@ "type": "structure", "members": { "AnalysisSummaryList": { - "shape": "S14t" + "shape": "S162" }, "NextToken": {}, "Status": { @@ -5957,7 +6199,7 @@ "type": "structure", "members": { "DashboardSummaryList": { - "shape": "S159" + "shape": "S16i" }, "NextToken": {}, "Status": { @@ -6009,7 +6251,7 @@ "type": "structure", "members": { "DataSetSummaries": { - "shape": "S15d" + "shape": "S16m" }, "NextToken": {}, "Status": { @@ -6127,7 +6369,7 @@ "type": "integer" }, "FolderSummaryList": { - "shape": "S15o" + "shape": "S16x" }, "NextToken": {}, "RequestId": {} @@ -6185,7 +6427,7 @@ "type": "structure", "members": { "GroupList": { - "shape": "S15v" + "shape": "S174" }, "NextToken": {}, "RequestId": {}, @@ -6215,14 +6457,23 @@ }, "AssetBundleExportJobId": {}, "ResourceArns": { - "shape": "Sy0" + "shape": "Syc" }, "IncludeAllDependencies": { "type": "boolean" }, "ExportFormat": {}, "CloudFormationOverridePropertyConfiguration": { - "shape": "Sy2" + "shape": "Sye" + }, + "IncludePermissions": { + "type": "boolean" + }, + "IncludeTags": { + "type": "boolean" + }, + "ValidationStrategy": { + "shape": "Sz8" } } }, @@ -6267,9 +6518,18 @@ } }, "OverrideParameters": { - "shape": "Sz3" + "shape": "Szi" }, - "FailureAction": {} + "FailureAction": {}, + "OverridePermissions": { + "shape": "S101" + }, + "OverrideTags": { + "shape": "S10h" + }, + "OverrideValidationStrategy": { + "shape": "S10u" + } } }, "output": { @@ -6317,7 +6577,7 @@ "type": "structure", "members": { "RowLevelPermissionTags": { - "shape": "S13y" + "shape": "S157" } } } @@ -6325,7 +6585,7 @@ } }, "SnapshotConfiguration": { - "shape": "S104" + "shape": "S11c" } } }, @@ -6556,10 +6816,10 @@ "locationName": "AnalysisId" }, "GrantPermissions": { - "shape": "S19b" + "shape": "S1am" }, "RevokePermissions": { - "shape": "S19b" + "shape": "S1am" } } }, @@ -6655,16 +6915,16 @@ "locationName": "DashboardId" }, "GrantPermissions": { - "shape": "S19b" + "shape": "S1am" }, "RevokePermissions": { - "shape": "S19b" + "shape": "S1am" }, "GrantLinkPermissions": { - "shape": "S19g" + "shape": "S1ar" }, "RevokeLinkPermissions": { - "shape": "S19g" + "shape": "S1ar" } } }, @@ -6682,7 +6942,7 @@ "type": "integer" }, "LinkSharingConfiguration": { - "shape": "Szx" + "shape": "Smr" } } } @@ -6753,32 +7013,32 @@ }, "Name": {}, "PhysicalTableMap": { - "shape": "Smv" + "shape": "Smw" }, "LogicalTableMap": { - "shape": "Snf" + "shape": "Sng" }, "ImportMode": {}, "ColumnGroups": { - "shape": "Som" + "shape": "Son" }, "FieldFolders": { - "shape": "Sos" + "shape": "Sot" }, "RowLevelPermissionDataSet": { - "shape": "Sox" + "shape": "Soy" }, "RowLevelPermissionTagConfiguration": { - "shape": "Sp1" + "shape": "Sp2" }, "ColumnLevelPermissionRules": { - "shape": "Sp9" + "shape": "Spa" }, "DataSetUsageConfiguration": { - "shape": "Spd" + "shape": "Spe" }, "DatasetParameters": { - "shape": "Spe" + "shape": "Spf" } } }, @@ -6860,16 +7120,16 @@ }, "Name": {}, "DataSourceParameters": { - "shape": "Spt" + "shape": "Spu" }, "Credentials": { - "shape": "Sr6" + "shape": "Sra" }, "VpcConnectionProperties": { - "shape": "Srd" + "shape": "Srh" }, "SslProperties": { - "shape": "Sre" + "shape": "Sri" } } }, @@ -7039,7 +7299,7 @@ "type": "structure", "members": { "Group": { - "shape": "Sru" + "shape": "Sry" }, "RequestId": {}, "Status": { @@ -7077,7 +7337,7 @@ "AssignmentStatus": {}, "PolicyArn": {}, "Identities": { - "shape": "Ss2" + "shape": "Ss6" } } }, @@ -7088,7 +7348,7 @@ "AssignmentId": {}, "PolicyArn": {}, "Identities": { - "shape": "Ss2" + "shape": "Ss6" }, "AssignmentStatus": {}, "RequestId": {}, @@ -7114,7 +7374,7 @@ "locationName": "AwsAccountId" }, "IpRestrictionRuleMap": { - "shape": "S129" + "shape": "S13g" }, "Enabled": { "type": "boolean" @@ -7172,34 +7432,73 @@ "input": { "type": "structure", "required": [ - "DataSetId", + "DataSetId", + "AwsAccountId", + "Schedule" + ], + "members": { + "DataSetId": { + "location": "uri", + "locationName": "DataSetId" + }, + "AwsAccountId": { + "location": "uri", + "locationName": "AwsAccountId" + }, + "Schedule": { + "shape": "Ssj" + } + } + }, + "output": { + "type": "structure", + "members": { + "Status": { + "location": "statusCode", + "type": "integer" + }, + "RequestId": {}, + "ScheduleId": {}, + "Arn": {} + } + } + }, + "UpdateRoleCustomPermission": { + "http": { + "method": "PUT", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission" + }, + "input": { + "type": "structure", + "required": [ + "CustomPermissionsName", + "Role", "AwsAccountId", - "Schedule" + "Namespace" ], "members": { - "DataSetId": { + "CustomPermissionsName": {}, + "Role": { "location": "uri", - "locationName": "DataSetId" + "locationName": "Role" }, "AwsAccountId": { "location": "uri", "locationName": "AwsAccountId" }, - "Schedule": { - "shape": "Ssf" + "Namespace": { + "location": "uri", + "locationName": "Namespace" } } }, "output": { "type": "structure", "members": { + "RequestId": {}, "Status": { - "location": "statusCode", "type": "integer" - }, - "RequestId": {}, - "ScheduleId": {}, - "Arn": {} + } } } }, @@ -7224,12 +7523,12 @@ "locationName": "TemplateId" }, "SourceEntity": { - "shape": "Sso" + "shape": "Ssv" }, "VersionDescription": {}, "Name": {}, "Definition": { - "shape": "Ssr" + "shape": "Ssy" }, "ValidationStrategy": { "shape": "Sm1" @@ -7286,7 +7585,7 @@ "type": "structure", "members": { "TemplateAlias": { - "shape": "St6" + "shape": "Std" }, "Status": { "location": "statusCode", @@ -7317,10 +7616,10 @@ "locationName": "TemplateId" }, "GrantPermissions": { - "shape": "S19b" + "shape": "S1am" }, "RevokePermissions": { - "shape": "S19b" + "shape": "S1am" } } }, @@ -7365,7 +7664,7 @@ "BaseThemeId": {}, "VersionDescription": {}, "Configuration": { - "shape": "St9" + "shape": "Stg" } } }, @@ -7419,7 +7718,7 @@ "type": "structure", "members": { "ThemeAlias": { - "shape": "Stp" + "shape": "Stw" }, "Status": { "location": "statusCode", @@ -7450,10 +7749,10 @@ "locationName": "ThemeId" }, "GrantPermissions": { - "shape": "S19b" + "shape": "S1am" }, "RevokePermissions": { - "shape": "S19b" + "shape": "S1am" } } }, @@ -7495,7 +7794,7 @@ "locationName": "TopicId" }, "Topic": { - "shape": "Sts" + "shape": "Stz" } } }, @@ -7534,10 +7833,10 @@ "locationName": "TopicId" }, "GrantPermissions": { - "shape": "S19b" + "shape": "S1am" }, "RevokePermissions": { - "shape": "S19b" + "shape": "S1am" } } }, @@ -7584,7 +7883,7 @@ "locationName": "DatasetId" }, "RefreshSchedule": { - "shape": "Svg" + "shape": "Svn" } } }, @@ -7644,7 +7943,7 @@ "type": "structure", "members": { "User": { - "shape": "S13l" + "shape": "S14v" }, "RequestId": {}, "Status": { @@ -7680,13 +7979,13 @@ }, "Name": {}, "SubnetIds": { - "shape": "Svl" + "shape": "Svs" }, "SecurityGroupIds": { - "shape": "Svn" + "shape": "Svu" }, "DnsResolvers": { - "shape": "Svp" + "shape": "Svw" }, "RoleArn": {} } @@ -7848,11 +8147,14 @@ "members": { "Principal": {}, "Actions": { - "type": "list", - "member": {} + "shape": "S1c" } } }, + "S1c": { + "type": "list", + "member": {} + }, "S1d": { "type": "structure", "members": { @@ -13803,7 +14105,15 @@ } } }, - "Smv": { + "Smr": { + "type": "structure", + "members": { + "Permissions": { + "shape": "S19" + } + } + }, + "Smw": { "type": "map", "key": {}, "value": { @@ -13822,7 +14132,7 @@ "Schema": {}, "Name": {}, "InputColumns": { - "shape": "Sn2" + "shape": "Sn3" } } }, @@ -13838,7 +14148,7 @@ "Name": {}, "SqlQuery": {}, "Columns": { - "shape": "Sn2" + "shape": "Sn3" } } }, @@ -13865,14 +14175,14 @@ } }, "InputColumns": { - "shape": "Sn2" + "shape": "Sn3" } } } } } }, - "Sn2": { + "Sn3": { "type": "list", "member": { "type": "structure", @@ -13887,7 +14197,7 @@ } } }, - "Snf": { + "Sng": { "type": "map", "key": {}, "value": { @@ -14027,16 +14337,16 @@ "type": "structure", "members": { "StringStaticValues": { - "shape": "So8" + "shape": "So9" }, "DecimalStaticValues": { - "shape": "Soa" + "shape": "Sob" }, "DateTimeStaticValues": { - "shape": "Soc" + "shape": "Sod" }, "IntegerStaticValues": { - "shape": "Soe" + "shape": "Sof" } } } @@ -14060,10 +14370,10 @@ "LeftOperand": {}, "RightOperand": {}, "LeftJoinKeyProperties": { - "shape": "Soi" + "shape": "Soj" }, "RightJoinKeyProperties": { - "shape": "Soi" + "shape": "Soj" }, "Type": {}, "OnClause": {} @@ -14076,29 +14386,29 @@ } } }, - "So8": { + "So9": { "type": "list", "member": {} }, - "Soa": { + "Sob": { "type": "list", "member": { "type": "double" } }, - "Soc": { + "Sod": { "type": "list", "member": { "type": "timestamp" } }, - "Soe": { + "Sof": { "type": "list", "member": { "type": "long" } }, - "Soi": { + "Soj": { "type": "structure", "members": { "UniqueKey": { @@ -14106,7 +14416,7 @@ } } }, - "Som": { + "Son": { "type": "list", "member": { "type": "structure", @@ -14129,7 +14439,7 @@ } } }, - "Sos": { + "Sot": { "type": "map", "key": {}, "value": { @@ -14143,7 +14453,7 @@ } } }, - "Sox": { + "Soy": { "type": "structure", "required": [ "Arn", @@ -14157,7 +14467,7 @@ "Status": {} } }, - "Sp1": { + "Sp2": { "type": "structure", "required": [ "TagRules" @@ -14177,7 +14487,7 @@ "ColumnName": {}, "TagMultiValueDelimiter": {}, "MatchAllValue": { - "shape": "Sp6" + "shape": "Sp7" } } } @@ -14191,11 +14501,11 @@ } } }, - "Sp6": { + "Sp7": { "type": "string", "sensitive": true }, - "Sp9": { + "Spa": { "type": "list", "member": { "type": "structure", @@ -14211,7 +14521,7 @@ } } }, - "Spd": { + "Spe": { "type": "structure", "members": { "DisableUseAsDirectQuerySource": { @@ -14222,7 +14532,7 @@ } } }, - "Spe": { + "Spf": { "type": "list", "member": { "type": "structure", @@ -14242,7 +14552,7 @@ "type": "structure", "members": { "StaticValues": { - "shape": "So8" + "shape": "So9" } } } @@ -14263,7 +14573,7 @@ "type": "structure", "members": { "StaticValues": { - "shape": "Soa" + "shape": "Sob" } } } @@ -14284,7 +14594,7 @@ "type": "structure", "members": { "StaticValues": { - "shape": "Soe" + "shape": "Sof" } } } @@ -14306,7 +14616,7 @@ "type": "structure", "members": { "StaticValues": { - "shape": "Soc" + "shape": "Sod" } } } @@ -14315,7 +14625,7 @@ } } }, - "Spt": { + "Spu": { "type": "structure", "members": { "AmazonElasticsearchParameters": { @@ -14665,10 +14975,20 @@ }, "Catalog": {} } + }, + "BigQueryParameters": { + "type": "structure", + "required": [ + "ProjectId" + ], + "members": { + "ProjectId": {}, + "DataSetRegion": {} + } } } }, - "Sr6": { + "Sra": { "type": "structure", "members": { "CredentialPair": { @@ -14681,7 +15001,7 @@ "Username": {}, "Password": {}, "AlternateDataSourceParameters": { - "shape": "Sra" + "shape": "Sre" } } }, @@ -14690,13 +15010,13 @@ }, "sensitive": true }, - "Sra": { + "Sre": { "type": "list", "member": { - "shape": "Spt" + "shape": "Spu" } }, - "Srd": { + "Srh": { "type": "structure", "required": [ "VpcConnectionArn" @@ -14705,7 +15025,7 @@ "VpcConnectionArn": {} } }, - "Sre": { + "Sri": { "type": "structure", "members": { "DisableSsl": { @@ -14713,7 +15033,7 @@ } } }, - "Sru": { + "Sry": { "type": "structure", "members": { "Arn": {}, @@ -14722,14 +15042,14 @@ "PrincipalId": {} } }, - "Sry": { + "Ss2": { "type": "structure", "members": { "Arn": {}, "MemberName": {} } }, - "Ss2": { + "Ss6": { "type": "map", "key": {}, "value": { @@ -14737,7 +15057,7 @@ "member": {} } }, - "Ssf": { + "Ssj": { "type": "structure", "required": [ "ScheduleId", @@ -14771,7 +15091,7 @@ "Arn": {} } }, - "Sso": { + "Ssv": { "type": "structure", "members": { "SourceAnalysis": { @@ -14798,14 +15118,14 @@ } } }, - "Ssr": { + "Ssy": { "type": "structure", "required": [ "DataSetConfigurations" ], "members": { "DataSetConfigurations": { - "shape": "Sss" + "shape": "Ssz" }, "Sheets": { "shape": "S1l" @@ -14830,7 +15150,7 @@ } } }, - "Sss": { + "Ssz": { "type": "list", "member": { "type": "structure", @@ -14873,7 +15193,7 @@ } } }, - "St6": { + "Std": { "type": "structure", "members": { "AliasName": {}, @@ -14883,17 +15203,17 @@ } } }, - "St9": { + "Stg": { "type": "structure", "members": { "DataColorPalette": { "type": "structure", "members": { "Colors": { - "shape": "Stb" + "shape": "Sti" }, "MinMaxGradient": { - "shape": "Stb" + "shape": "Sti" }, "EmptyFillColor": {} } @@ -14974,11 +15294,11 @@ } } }, - "Stb": { + "Sti": { "type": "list", "member": {} }, - "Stp": { + "Stw": { "type": "structure", "members": { "Arn": {}, @@ -14988,7 +15308,7 @@ } } }, - "Sts": { + "Stz": { "type": "structure", "members": { "Name": {}, @@ -15024,7 +15344,7 @@ "FilterClass": {}, "FilterName": {}, "FilterSynonyms": { - "shape": "Su1" + "shape": "Su8" }, "OperandFieldName": {}, "FilterType": {}, @@ -15042,7 +15362,7 @@ "type": "structure", "members": { "ValueList": { - "shape": "Su9" + "shape": "Sug" } } } @@ -15058,7 +15378,7 @@ "type": "structure", "members": { "Constant": { - "shape": "Sub" + "shape": "Sui" }, "Aggregation": {} } @@ -15070,7 +15390,7 @@ "type": "boolean" }, "Constant": { - "shape": "Sue" + "shape": "Sul" }, "Aggregation": {} } @@ -15082,7 +15402,7 @@ "type": "boolean" }, "Constant": { - "shape": "Sue" + "shape": "Sul" } } }, @@ -15092,7 +15412,7 @@ "TimeGranularity": {}, "RelativeDateFilterFunction": {}, "Constant": { - "shape": "Sub" + "shape": "Sui" } } } @@ -15111,7 +15431,7 @@ "ColumnFriendlyName": {}, "ColumnDescription": {}, "ColumnSynonyms": { - "shape": "Su1" + "shape": "Su8" }, "ColumnDataRole": {}, "Aggregation": {}, @@ -15122,26 +15442,26 @@ "type": "boolean" }, "ComparativeOrder": { - "shape": "Suo" + "shape": "Suv" }, "SemanticType": { - "shape": "Sur" + "shape": "Suy" }, "TimeGranularity": {}, "AllowedAggregations": { - "shape": "Sut" + "shape": "Sv0" }, "NotAllowedAggregations": { - "shape": "Sut" + "shape": "Sv0" }, "DefaultFormatting": { - "shape": "Suv" + "shape": "Sv2" }, "NeverAggregateInFilter": { "type": "boolean" }, "CellValueSynonyms": { - "shape": "Sv0" + "shape": "Sv7" }, "NonAdditive": { "type": "boolean" @@ -15164,7 +15484,7 @@ "shape": "S4r" }, "CalculatedFieldSynonyms": { - "shape": "Su1" + "shape": "Su8" }, "IsIncludedInTopic": { "type": "boolean" @@ -15175,26 +15495,26 @@ "ColumnDataRole": {}, "TimeGranularity": {}, "DefaultFormatting": { - "shape": "Suv" + "shape": "Sv2" }, "Aggregation": {}, "ComparativeOrder": { - "shape": "Suo" + "shape": "Suv" }, "SemanticType": { - "shape": "Sur" + "shape": "Suy" }, "AllowedAggregations": { - "shape": "Sut" + "shape": "Sv0" }, "NotAllowedAggregations": { - "shape": "Sut" + "shape": "Sv0" }, "NeverAggregateInFilter": { "type": "boolean" }, "CellValueSynonyms": { - "shape": "Sv0" + "shape": "Sv7" }, "NonAdditive": { "type": "boolean" @@ -15213,7 +15533,7 @@ "EntityName": {}, "EntityDescription": {}, "EntitySynonyms": { - "shape": "Su1" + "shape": "Su8" }, "SemanticEntityType": { "type": "structure", @@ -15221,7 +15541,7 @@ "TypeName": {}, "SubTypeName": {}, "TypeParameters": { - "shape": "Sus" + "shape": "Suz" } } }, @@ -15256,15 +15576,15 @@ } } }, - "Su1": { + "Su8": { "type": "list", "member": {} }, - "Su9": { + "Sug": { "type": "list", "member": {} }, - "Sub": { + "Sui": { "type": "structure", "members": { "ConstantType": {}, @@ -15272,7 +15592,7 @@ }, "sensitive": true }, - "Sue": { + "Sul": { "type": "structure", "members": { "ConstantType": {}, @@ -15286,23 +15606,23 @@ }, "sensitive": true }, - "Suo": { + "Suv": { "type": "structure", "members": { "UseOrdering": {}, "SpecifedOrder": { - "shape": "Su9" + "shape": "Sug" }, "TreatUndefinedSpecifiedValues": {} } }, - "Sur": { + "Suy": { "type": "structure", "members": { "TypeName": {}, "SubTypeName": {}, "TypeParameters": { - "shape": "Sus" + "shape": "Suz" }, "TruthyCellValue": { "shape": "Sw" @@ -15318,16 +15638,16 @@ } } }, - "Sus": { + "Suz": { "type": "map", "key": {}, "value": {} }, - "Sut": { + "Sv0": { "type": "list", "member": {} }, - "Suv": { + "Sv2": { "type": "structure", "members": { "DisplayFormat": {}, @@ -15362,19 +15682,19 @@ } } }, - "Sv0": { + "Sv7": { "type": "list", "member": { "type": "structure", "members": { "CellValue": {}, "Synonyms": { - "shape": "Su9" + "shape": "Sug" } } } }, - "Svg": { + "Svn": { "type": "structure", "required": [ "IsEnabled", @@ -15395,19 +15715,19 @@ "TopicScheduleType": {} } }, - "Svl": { + "Svs": { "type": "list", "member": {} }, - "Svn": { + "Svu": { "type": "list", "member": {} }, - "Svp": { + "Svw": { "type": "list", "member": {} }, - "Sxj": { + "Sxu": { "type": "list", "member": { "type": "structure", @@ -15415,12 +15735,12 @@ "Type": {}, "Message": {}, "ViolatedEntities": { - "shape": "Sxm" + "shape": "Sxx" } } } }, - "Sxm": { + "Sxx": { "type": "list", "member": { "type": "structure", @@ -15429,11 +15749,11 @@ } } }, - "Sxo": { + "Sxz": { "type": "list", "member": {} }, - "Sxp": { + "Sy0": { "type": "list", "member": { "type": "structure", @@ -15443,11 +15763,15 @@ } } }, - "Sy0": { + "Sy9": { + "type": "string", + "sensitive": true + }, + "Syc": { "type": "list", "member": {} }, - "Sy2": { + "Sye": { "type": "structure", "members": { "ResourceIdOverrideConfiguration": { @@ -15463,6 +15787,7 @@ "member": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -15479,6 +15804,7 @@ "member": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -15495,6 +15821,7 @@ "member": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -15511,6 +15838,7 @@ "member": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -15527,6 +15855,7 @@ "member": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -15543,6 +15872,7 @@ "member": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -15559,6 +15889,7 @@ "member": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -15572,7 +15903,15 @@ } } }, - "Syz": { + "Sz8": { + "type": "structure", + "members": { + "StrictModeForAllResources": { + "type": "boolean" + } + } + }, + "Sze": { "type": "list", "member": { "type": "structure", @@ -15583,7 +15922,7 @@ } } }, - "Sz3": { + "Szi": { "type": "structure", "members": { "ResourceIdOverrideConfiguration": { @@ -15603,13 +15942,13 @@ "VPCConnectionId": {}, "Name": {}, "SubnetIds": { - "shape": "Svl" + "shape": "Svs" }, "SecurityGroupIds": { - "shape": "Svn" + "shape": "Svu" }, "DnsResolvers": { - "shape": "Svp" + "shape": "Svw" }, "RoleArn": {} } @@ -15643,13 +15982,13 @@ "DataSourceId": {}, "Name": {}, "DataSourceParameters": { - "shape": "Spt" + "shape": "Spu" }, "VpcConnectionProperties": { - "shape": "Srd" + "shape": "Srh" }, "SslProperties": { - "shape": "Sre" + "shape": "Sri" }, "Credentials": { "type": "structure", @@ -15726,7 +16065,250 @@ } } }, - "Szq": { + "S101": { + "type": "structure", + "members": { + "DataSources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DataSourceIds", + "Permissions" + ], + "members": { + "DataSourceIds": { + "shape": "S104" + }, + "Permissions": { + "shape": "S106" + } + } + } + }, + "DataSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DataSetIds", + "Permissions" + ], + "members": { + "DataSetIds": { + "shape": "S104" + }, + "Permissions": { + "shape": "S106" + } + } + } + }, + "Themes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ThemeIds", + "Permissions" + ], + "members": { + "ThemeIds": { + "shape": "S104" + }, + "Permissions": { + "shape": "S106" + } + } + } + }, + "Analyses": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AnalysisIds", + "Permissions" + ], + "members": { + "AnalysisIds": { + "shape": "S104" + }, + "Permissions": { + "shape": "S106" + } + } + } + }, + "Dashboards": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DashboardIds" + ], + "members": { + "DashboardIds": { + "shape": "S104" + }, + "Permissions": { + "shape": "S106" + }, + "LinkSharingConfiguration": { + "type": "structure", + "members": { + "Permissions": { + "shape": "S106" + } + } + } + } + } + } + } + }, + "S104": { + "type": "list", + "member": {} + }, + "S106": { + "type": "structure", + "required": [ + "Principals", + "Actions" + ], + "members": { + "Principals": { + "type": "list", + "member": {} + }, + "Actions": { + "shape": "S1c" + } + } + }, + "S10h": { + "type": "structure", + "members": { + "VPCConnections": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "VPCConnectionIds", + "Tags" + ], + "members": { + "VPCConnectionIds": { + "shape": "S104" + }, + "Tags": { + "shape": "Sb" + } + } + } + }, + "DataSources": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DataSourceIds", + "Tags" + ], + "members": { + "DataSourceIds": { + "shape": "S104" + }, + "Tags": { + "shape": "Sb" + } + } + } + }, + "DataSets": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DataSetIds", + "Tags" + ], + "members": { + "DataSetIds": { + "shape": "S104" + }, + "Tags": { + "shape": "Sb" + } + } + } + }, + "Themes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ThemeIds", + "Tags" + ], + "members": { + "ThemeIds": { + "shape": "S104" + }, + "Tags": { + "shape": "Sb" + } + } + } + }, + "Analyses": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "AnalysisIds", + "Tags" + ], + "members": { + "AnalysisIds": { + "shape": "S104" + }, + "Tags": { + "shape": "Sb" + } + } + } + }, + "Dashboards": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DashboardIds", + "Tags" + ], + "members": { + "DashboardIds": { + "shape": "S104" + }, + "Tags": { + "shape": "Sb" + } + } + } + } + } + }, + "S10u": { + "type": "structure", + "members": { + "StrictModeForAllResources": { + "type": "boolean" + } + } + }, + "S10z": { "type": "list", "member": { "type": "structure", @@ -15734,20 +16316,12 @@ "Type": {}, "Message": {}, "ViolatedEntities": { - "shape": "Sxm" + "shape": "Sxx" } } } }, - "Szx": { - "type": "structure", - "members": { - "Permissions": { - "shape": "S19" - } - } - }, - "S104": { + "S11c": { "type": "structure", "required": [ "FileGroups" @@ -15759,7 +16333,7 @@ "type": "structure", "members": { "Files": { - "shape": "S107" + "shape": "S11f" } } } @@ -15770,7 +16344,7 @@ "S3Destinations": { "type": "list", "member": { - "shape": "S10g" + "shape": "S11o" } } } @@ -15780,7 +16354,7 @@ } } }, - "S107": { + "S11f": { "type": "list", "member": { "type": "structure", @@ -15811,7 +16385,7 @@ } } }, - "S10g": { + "S11o": { "type": "structure", "members": { "BucketConfiguration": { @@ -15829,7 +16403,7 @@ } } }, - "S115": { + "S12c": { "type": "structure", "required": [ "RefreshConfiguration" @@ -15868,7 +16442,7 @@ } } }, - "S11d": { + "S12k": { "type": "structure", "members": { "Arn": {}, @@ -15883,16 +16457,16 @@ "type": "timestamp" }, "DataSourceParameters": { - "shape": "Spt" + "shape": "Spu" }, "AlternateDataSourceParameters": { - "shape": "Sra" + "shape": "Sre" }, "VpcConnectionProperties": { - "shape": "Srd" + "shape": "Srh" }, "SslProperties": { - "shape": "Sre" + "shape": "Sri" }, "ErrorInfo": { "type": "structure", @@ -15904,7 +16478,7 @@ "SecretArn": {} } }, - "S120": { + "S137": { "type": "structure", "required": [ "Arn", @@ -15960,12 +16534,12 @@ "RequestType": {} } }, - "S129": { + "S13g": { "type": "map", "key": {}, "value": {} }, - "S12e": { + "S13l": { "type": "structure", "members": { "Name": {}, @@ -15982,7 +16556,7 @@ } } }, - "S12n": { + "S13x": { "type": "list", "member": { "type": "structure", @@ -15990,12 +16564,12 @@ "Type": {}, "Message": {}, "ViolatedEntities": { - "shape": "Sxm" + "shape": "Sxx" } } } }, - "S13l": { + "S14v": { "type": "structure", "members": { "Arn": {}, @@ -16013,7 +16587,7 @@ "ExternalLoginId": {} } }, - "S13s": { + "S151": { "type": "list", "member": { "type": "structure", @@ -16026,7 +16600,7 @@ } } }, - "S13y": { + "S157": { "type": "list", "member": { "type": "structure", @@ -16037,12 +16611,12 @@ "members": { "Key": {}, "Value": { - "shape": "Sp6" + "shape": "Sp7" } } } }, - "S144": { + "S15d": { "type": "structure", "required": [ "DashboardId", @@ -16055,11 +16629,11 @@ "VisualId": {} } }, - "S147": { + "S15g": { "type": "string", "sensitive": true }, - "S14c": { + "S15l": { "type": "structure", "required": [ "Enabled" @@ -16070,7 +16644,7 @@ } } }, - "S14t": { + "S162": { "type": "list", "member": { "type": "structure", @@ -16088,7 +16662,7 @@ } } }, - "S159": { + "S16i": { "type": "list", "member": { "type": "structure", @@ -16111,7 +16685,7 @@ } } }, - "S15d": { + "S16m": { "type": "list", "member": { "type": "structure", @@ -16127,7 +16701,7 @@ }, "ImportMode": {}, "RowLevelPermissionDataSet": { - "shape": "Sox" + "shape": "Soy" }, "RowLevelPermissionTagConfigurationApplied": { "type": "boolean" @@ -16138,7 +16712,7 @@ } } }, - "S15o": { + "S16x": { "type": "list", "member": { "type": "structure", @@ -16157,19 +16731,19 @@ } } }, - "S15v": { + "S174": { "type": "list", "member": { - "shape": "Sru" + "shape": "Sry" } }, - "S19b": { + "S1am": { "type": "list", "member": { "shape": "S1a" } }, - "S19g": { + "S1ar": { "type": "list", "member": { "shape": "S1a" diff --git a/apis/quicksight-2018-04-01.normal.json b/apis/quicksight-2018-04-01.normal.json index 5c41888f4d..fc3db3aef9 100644 --- a/apis/quicksight-2018-04-01.normal.json +++ b/apis/quicksight-2018-04-01.normal.json @@ -614,6 +614,43 @@ ], "documentation": "Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
" }, + "CreateRoleMembership": { + "name": "CreateRoleMembership", + "http": { + "method": "POST", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}" + }, + "input": { + "shape": "CreateRoleMembershipRequest" + }, + "output": { + "shape": "CreateRoleMembershipResponse" + }, + "errors": [ + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "PreconditionNotMetException" + }, + { + "shape": "InternalFailureException" + }, + { + "shape": "ResourceUnavailableException" + } + ], + "documentation": "Use CreateRoleMembership
to add an existing Amazon QuickSight group to an existing role.
Deletes a refresh schedule from a dataset.
" }, + "DeleteRoleCustomPermission": { + "name": "DeleteRoleCustomPermission", + "http": { + "method": "DELETE", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission" + }, + "input": { + "shape": "DeleteRoleCustomPermissionRequest" + }, + "output": { + "shape": "DeleteRoleCustomPermissionResponse" + }, + "errors": [ + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "PreconditionNotMetException" + }, + { + "shape": "InternalFailureException" + }, + { + "shape": "ResourceUnavailableException" + } + ], + "documentation": "Removes custom permissions from the role.
" + }, + "DeleteRoleMembership": { + "name": "DeleteRoleMembership", + "http": { + "method": "DELETE", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}" + }, + "input": { + "shape": "DeleteRoleMembershipRequest" + }, + "output": { + "shape": "DeleteRoleMembershipResponse" + }, + "errors": [ + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "PreconditionNotMetException" + }, + { + "shape": "InternalFailureException" + }, + { + "shape": "ResourceUnavailableException" + } + ], + "documentation": "Removes a group from a role.
" + }, "DeleteTemplate": { "name": "DeleteTemplate", "http": { @@ -2664,6 +2775,43 @@ ], "documentation": "Provides a summary of a refresh schedule.
" }, + "DescribeRoleCustomPermission": { + "name": "DescribeRoleCustomPermission", + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission" + }, + "input": { + "shape": "DescribeRoleCustomPermissionRequest" + }, + "output": { + "shape": "DescribeRoleCustomPermissionResponse" + }, + "errors": [ + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "PreconditionNotMetException" + }, + { + "shape": "InternalFailureException" + }, + { + "shape": "ResourceUnavailableException" + } + ], + "documentation": "Describes all custom permissions that are mapped to a role.
" + }, "DescribeTemplate": { "name": "DescribeTemplate", "http": { @@ -3843,6 +3991,49 @@ ], "documentation": "Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
" }, + "ListRoleMemberships": { + "name": "ListRoleMemberships", + "http": { + "method": "GET", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members" + }, + "input": { + "shape": "ListRoleMembershipsRequest" + }, + "output": { + "shape": "ListRoleMembershipsResponse" + }, + "errors": [ + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InvalidNextTokenException" + }, + { + "shape": "PreconditionNotMetException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "InternalFailureException" + }, + { + "shape": "ResourceUnavailableException" + } + ], + "documentation": "Lists all groups that are associated with a role.
" + }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { @@ -5432,6 +5623,43 @@ ], "documentation": "Updates a refresh schedule for a dataset.
" }, + "UpdateRoleCustomPermission": { + "name": "UpdateRoleCustomPermission", + "http": { + "method": "PUT", + "requestUri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission" + }, + "input": { + "shape": "UpdateRoleCustomPermissionRequest" + }, + "output": { + "shape": "UpdateRoleCustomPermissionResponse" + }, + "errors": [ + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "PreconditionNotMetException" + }, + { + "shape": "InternalFailureException" + }, + { + "shape": "ResourceUnavailableException" + } + ], + "documentation": "Updates the custom permissions that are associated with a role.
" + }, "UpdateTemplate": { "name": "UpdateTemplate", "http": { @@ -6121,9 +6349,6 @@ "Sheets": { "shape": "SheetList", "documentation": "A list of the associated sheets with the unique identifier and name of each sheet.
" - }, - "Options": { - "shape": "AssetOptions" } }, "documentation": "Metadata structure for an analysis in Amazon QuickSight
" @@ -6551,6 +6776,7 @@ "AssetBundleExportJobAnalysisOverrideProperties": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -6590,6 +6816,7 @@ "AssetBundleExportJobDashboardOverrideProperties": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -6629,6 +6856,7 @@ "AssetBundleExportJobDataSetOverrideProperties": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -6668,6 +6896,7 @@ "AssetBundleExportJobDataSourceOverrideProperties": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -6747,6 +6976,7 @@ "AssetBundleExportJobRefreshScheduleOverrideProperties": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -6828,6 +7058,14 @@ "ExportFormat": { "shape": "AssetBundleExportFormat", "documentation": "The format for the export job.
" + }, + "IncludePermissions": { + "shape": "Boolean", + "documentation": "The flag that determines the inclusion of permissions associated with each resource ARN.
" + }, + "IncludeTags": { + "shape": "Boolean", + "documentation": "The flag that determines the inclusion of tags associated with each resource ARN.
" } }, "documentation": "A summary of the export job that includes details of the job's configuration and its current status.
" @@ -6841,6 +7079,7 @@ "AssetBundleExportJobThemeOverrideProperties": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -6880,6 +7119,7 @@ "AssetBundleExportJobVPCConnectionOverrideProperties": { "type": "structure", "required": [ + "Arn", "Properties" ], "members": { @@ -6918,6 +7158,36 @@ "max": 10, "min": 1 }, + "AssetBundleExportJobValidationStrategy": { + "type": "structure", + "members": { + "StrictModeForAllResources": { + "shape": "Boolean", + "documentation": "A Boolean value that indicates whether to export resources under strict or lenient mode.
" + } + }, + "documentation": "The option to relax the validation that is required to export each asset. When StrictModeForAllResource
is set to true, validation is skipped for specific UI errors.
The ARN of the resource whose processing caused a warning.
" + }, + "Message": { + "shape": "NonEmptyString", + "documentation": "A description of the warning.
" + } + }, + "documentation": "Describes a warning that occurred during an Asset Bundle export job.
" + }, + "AssetBundleExportJobWarningList": { + "type": "list", + "member": { + "shape": "AssetBundleExportJobWarning" + } + }, "AssetBundleImportBodyBlob": { "type": "blob", "max": 20971520, @@ -6956,6 +7226,58 @@ "max": 50, "min": 1 }, + "AssetBundleImportJobAnalysisOverridePermissions": { + "type": "structure", + "required": [ + "AnalysisIds", + "Permissions" + ], + "members": { + "AnalysisIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of analysis IDs that you want to apply overrides to. You can use *
to override all analyses in this asset bundle.
A list of permissions for the analyses that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of permissions to be applied to a list of analysis IDs.
" + }, + "AssetBundleImportJobAnalysisOverridePermissionsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobAnalysisOverridePermissions" + }, + "max": 1, + "min": 1 + }, + "AssetBundleImportJobAnalysisOverrideTags": { + "type": "structure", + "required": [ + "AnalysisIds", + "Tags" + ], + "members": { + "AnalysisIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of analysis IDs that you want to apply overrides to. You can use *
to override all analyses in this asset bundle.
A list of tags for the analyses that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of tags to be assigned to a list of analysis IDs.
" + }, + "AssetBundleImportJobAnalysisOverrideTagsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobAnalysisOverrideTags" + }, + "max": 5, + "min": 1 + }, "AssetBundleImportJobDashboardOverrideParameters": { "type": "structure", "required": [ @@ -6981,6 +7303,61 @@ "max": 50, "min": 1 }, + "AssetBundleImportJobDashboardOverridePermissions": { + "type": "structure", + "required": [ + "DashboardIds" + ], + "members": { + "DashboardIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of dashboard IDs that you want to apply overrides to. You can use *
to override all dashboards in this asset bundle.
A list of permissions for the dashboards that you want to apply overrides to.
" + }, + "LinkSharingConfiguration": { + "shape": "AssetBundleResourceLinkSharingConfiguration", + "documentation": "A structure that contains the link sharing configurations that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of permissions to be applied to a list of dashboard IDs.
" + }, + "AssetBundleImportJobDashboardOverridePermissionsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobDashboardOverridePermissions" + }, + "max": 2, + "min": 1 + }, + "AssetBundleImportJobDashboardOverrideTags": { + "type": "structure", + "required": [ + "DashboardIds", + "Tags" + ], + "members": { + "DashboardIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of dashboard IDs that you want to apply overrides to. You can use *
to override all dashboards in this asset bundle.
A list of tags for the dashboards that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of tags to be assigned to a list of dashboard IDs.
" + }, + "AssetBundleImportJobDashboardOverrideTagsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobDashboardOverrideTags" + }, + "max": 5, + "min": 1 + }, "AssetBundleImportJobDataSetOverrideParameters": { "type": "structure", "required": [ @@ -7006,6 +7383,58 @@ "max": 50, "min": 1 }, + "AssetBundleImportJobDataSetOverridePermissions": { + "type": "structure", + "required": [ + "DataSetIds", + "Permissions" + ], + "members": { + "DataSetIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of dataset IDs that you want to apply overrides to. You can use *
to override all datasets in this asset bundle.
A list of permissions for the datasets that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of permissions to be applied to a list of dataset IDs.
" + }, + "AssetBundleImportJobDataSetOverridePermissionsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobDataSetOverridePermissions" + }, + "max": 2, + "min": 1 + }, + "AssetBundleImportJobDataSetOverrideTags": { + "type": "structure", + "required": [ + "DataSetIds", + "Tags" + ], + "members": { + "DataSetIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of dataset IDs that you want to apply overrides to. You can use *
to override all datasets in this asset bundle.
A list of tags for the datasets that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of tags to be assigned to a list of dataset IDs.
" + }, + "AssetBundleImportJobDataSetOverrideTagsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobDataSetOverrideTags" + }, + "max": 5, + "min": 1 + }, "AssetBundleImportJobDataSourceCredentialPair": { "type": "structure", "required": [ @@ -7077,6 +7506,58 @@ "max": 50, "min": 1 }, + "AssetBundleImportJobDataSourceOverridePermissions": { + "type": "structure", + "required": [ + "DataSourceIds", + "Permissions" + ], + "members": { + "DataSourceIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of data source IDs that you want to apply overrides to. You can use *
to override all data sources in this asset bundle.
A list of permissions for the data source that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of permissions to be applied to a list of data source IDs.
" + }, + "AssetBundleImportJobDataSourceOverridePermissionsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobDataSourceOverridePermissions" + }, + "max": 2, + "min": 1 + }, + "AssetBundleImportJobDataSourceOverrideTags": { + "type": "structure", + "required": [ + "DataSourceIds", + "Tags" + ], + "members": { + "DataSourceIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of data source IDs that you want to apply overrides to. You can use *
to override all data sources in this asset bundle.
A list of tags for the data source that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of tags to be assigned to a list of data source IDs.
" + }, + "AssetBundleImportJobDataSourceOverrideTagsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobDataSourceOverrideTags" + }, + "max": 5, + "min": 1 + }, "AssetBundleImportJobError": { "type": "structure", "members": { @@ -7139,6 +7620,72 @@ }, "documentation": "A list of overrides that modify the asset bundle resource configuration before the resource is imported.
" }, + "AssetBundleImportJobOverridePermissions": { + "type": "structure", + "members": { + "DataSources": { + "shape": "AssetBundleImportJobDataSourceOverridePermissionsList", + "documentation": "A list of permissions overrides for any DataSource
resources that are present in the asset bundle that is imported.
A list of permissions overrides for any DataSet
resources that are present in the asset bundle that is imported.
A list of permissions overrides for any Theme
resources that are present in the asset bundle that is imported.
A list of permissions overrides for any Analysis
resources that are present in the asset bundle that is imported.
A list of permissions overrides for any Dashboard
resources that are present in the asset bundle that is imported.
A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.
" + }, + "AssetBundleImportJobOverrideTags": { + "type": "structure", + "members": { + "VPCConnections": { + "shape": "AssetBundleImportJobVPCConnectionOverrideTagsList", + "documentation": "A list of tag overrides for any VPCConnection
resources that are present in the asset bundle that is imported.
A list of tag overrides for any DataSource
resources that are present in the asset bundle that is imported.
A list of tag overrides for any DataSet
resources that are present in the asset bundle that is imported.
A list of tag overrides for any Theme
resources that are present in the asset bundle that is imported.
A list of tag overrides for any Analysis
resources that are present in the asset bundle that is imported.
A list of tag overrides for any Dashboard
resources that are present in the asset bundle that is imported.
A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.
" + }, + "AssetBundleImportJobOverrideValidationStrategy": { + "type": "structure", + "members": { + "StrictModeForAllResources": { + "shape": "Boolean", + "documentation": "A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
" + } + }, + "documentation": "An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.
" + }, "AssetBundleImportJobRefreshScheduleOverrideParameters": { "type": "structure", "required": [ @@ -7248,6 +7795,58 @@ "max": 50, "min": 1 }, + "AssetBundleImportJobThemeOverridePermissions": { + "type": "structure", + "required": [ + "ThemeIds", + "Permissions" + ], + "members": { + "ThemeIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of theme IDs that you want to apply overrides to. You can use *
to override all themes in this asset bundle.
A list of permissions for the themes that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of permissions to be applied to a list of theme IDs.
" + }, + "AssetBundleImportJobThemeOverridePermissionsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobThemeOverridePermissions" + }, + "max": 2, + "min": 1 + }, + "AssetBundleImportJobThemeOverrideTags": { + "type": "structure", + "required": [ + "ThemeIds", + "Tags" + ], + "members": { + "ThemeIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of theme IDs that you want to apply overrides to. You can use *
to override all themes in this asset bundle.
A list of tags for the themes that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of tags to be assigned to a list of theme IDs.
" + }, + "AssetBundleImportJobThemeOverrideTagsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobThemeOverrideTags" + }, + "max": 5, + "min": 1 + }, "AssetBundleImportJobVPCConnectionOverrideParameters": { "type": "structure", "required": [ @@ -7289,6 +7888,32 @@ "max": 50, "min": 1 }, + "AssetBundleImportJobVPCConnectionOverrideTags": { + "type": "structure", + "required": [ + "VPCConnectionIds", + "Tags" + ], + "members": { + "VPCConnectionIds": { + "shape": "AssetBundleRestrictiveResourceIdList", + "documentation": "A list of VPC connection IDs that you want to apply overrides to. You can use *
to override all VPC connections in this asset bundle.
A list of tags for the VPC connections that you want to apply overrides to.
" + } + }, + "documentation": "An object that contains a list of tags to be assigned to a list of VPC connection IDs.
" + }, + "AssetBundleImportJobVPCConnectionOverrideTagsList": { + "type": "list", + "member": { + "shape": "AssetBundleImportJobVPCConnectionOverrideTags" + }, + "max": 5, + "min": 1 + }, "AssetBundleImportSource": { "type": "structure", "members": { @@ -7307,7 +7932,7 @@ "type": "structure", "members": { "Body": { - "shape": "String", + "shape": "SensitiveS3Uri", "documentation": "An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob
again for a fresh URL if needed. The downloaded asset bundle is a .qs
zip file.
A description of the import source that you provide at the start of an import job. This value is set to either Body
or S3Uri
, depending on how the StartAssetBundleImportJobRequest
is configured.
A list of link sharing permissions for the dashboards that you want to apply overrides to.
" + } + }, + "documentation": "A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.
" + }, + "AssetBundleResourcePermissions": { + "type": "structure", + "required": [ + "Principals", + "Actions" + ], + "members": { + "Principals": { + "shape": "AssetBundlePrincipalList", + "documentation": "A list of principals to grant permissions on.
" + }, + "Actions": { + "shape": "ActionList", + "documentation": "A list of IAM actions to grant permissions on.
" + } + }, + "documentation": "A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
" + }, + "AssetBundleRestrictiveResourceId": { + "type": "string", + "pattern": "\\*|[\\w\\-]{1,2048}" + }, + "AssetBundleRestrictiveResourceIdList": { + "type": "list", + "member": { + "shape": "AssetBundleRestrictiveResourceId" + }, + "max": 50, + "min": 1 + }, "AssetOptions": { "type": "structure", "members": { @@ -7850,6 +8523,23 @@ "IMAGERY" ] }, + "BigQueryParameters": { + "type": "structure", + "required": [ + "ProjectId" + ], + "members": { + "ProjectId": { + "shape": "ProjectId", + "documentation": "The Google Cloud Platform project ID where your datasource was created.
" + }, + "DataSetRegion": { + "shape": "DataSetRegion", + "documentation": "The storage location where you create a Google BigQuery data source.
" + } + }, + "documentation": "The parameters that are required to connect to a Google BigQuery data source.
" + }, "BinCountLimit": { "type": "long", "max": 1000, @@ -9495,7 +10185,7 @@ }, "AuthenticationMethod": { "shape": "AuthenticationMethodOption", - "documentation": "The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT
, IAM_ONLY
, and ACTIVE_DIRECTORY
.
If you choose ACTIVE_DIRECTORY
, provide an ActiveDirectoryName
and an AdminGroup
associated with your Active Directory.
The method that you want to use to authenticate your Amazon QuickSight account.
If you choose ACTIVE_DIRECTORY
, provide an ActiveDirectoryName
and an AdminGroup
associated with your Active Directory.
If you choose IAM_IDENTITY_CENTER
, provide an AdminGroup
associated with your IAM Identity Center account.
The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
The admin group associated with your Active Directory or IAM Identity Center account. This field is required if ACTIVE_DIRECTORY
or IAM_IDENTITY_CENTER
is the selected authentication method of the new Amazon QuickSight account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" }, "AuthorGroup": { "shape": "GroupsList", - "documentation": "The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + "documentation": "The author group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" }, "ReaderGroup": { "shape": "GroupsList", - "documentation": "The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" + "documentation": "The reader group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
" }, "FirstName": { "shape": "String", @@ -9731,6 +10421,10 @@ "FolderArns": { "shape": "FolderArnList", "documentation": "When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
" + }, + "LinkSharingConfiguration": { + "shape": "LinkSharingConfiguration", + "documentation": "A structure that contains the permissions of a shareable link to the dashboard.
" } } }, @@ -10417,6 +11111,55 @@ } } }, + "CreateRoleMembershipRequest": { + "type": "structure", + "required": [ + "MemberName", + "AwsAccountId", + "Namespace", + "Role" + ], + "members": { + "MemberName": { + "shape": "GroupName", + "documentation": "The name of the group that you want to add to the role.
", + "location": "uri", + "locationName": "MemberName" + }, + "AwsAccountId": { + "shape": "AwsAccountId", + "documentation": "The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
", + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "shape": "Namespace", + "documentation": "The namespace that the role belongs to.
", + "location": "uri", + "locationName": "Namespace" + }, + "Role": { + "shape": "Role", + "documentation": "The role that you want to add a group to.
", + "location": "uri", + "locationName": "Role" + } + } + }, + "CreateRoleMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "shape": "String", + "documentation": "The Amazon Web Services request ID for this operation.
" + }, + "Status": { + "shape": "StatusCode", + "documentation": "The HTTP status of the request.
", + "location": "statusCode" + } + } + }, "CreateTemplateAliasRequest": { "type": "structure", "required": [ @@ -11542,9 +12285,6 @@ "Sheets": { "shape": "SheetList", "documentation": "A list of the associated sheets with the unique identifier and name of each sheet.
" - }, - "Options": { - "shape": "AssetOptions" } }, "documentation": "Dashboard version.
" @@ -12186,6 +12926,11 @@ }, "documentation": "The refresh properties of a dataset.
" }, + "DataSetRegion": { + "type": "string", + "max": 256, + "min": 1 + }, "DataSetSchema": { "type": "structure", "members": { @@ -12510,6 +13255,10 @@ "TrinoParameters": { "shape": "TrinoParameters", "documentation": "The parameters that are required to connect to a Trino data source.
" + }, + "BigQueryParameters": { + "shape": "BigQueryParameters", + "documentation": "The parameters that are required to connect to a Google BigQuery data source.
" } }, "documentation": "The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
" @@ -12617,7 +13366,10 @@ "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", - "DATABRICKS" + "DATABRICKS", + "STARBURST", + "TRINO", + "BIGQUERY" ] }, "Database": { @@ -13947,6 +14699,96 @@ } } }, + "DeleteRoleCustomPermissionRequest": { + "type": "structure", + "required": [ + "Role", + "AwsAccountId", + "Namespace" + ], + "members": { + "Role": { + "shape": "Role", + "documentation": "The role that you want to remove permissions from.
", + "location": "uri", + "locationName": "Role" + }, + "AwsAccountId": { + "shape": "AwsAccountId", + "documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
", + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "shape": "Namespace", + "documentation": "The namespace that includes the role.
", + "location": "uri", + "locationName": "Namespace" + } + } + }, + "DeleteRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "shape": "String", + "documentation": "The Amazon Web Services request ID for this operation.
" + }, + "Status": { + "shape": "StatusCode", + "documentation": "The HTTP status of the request.
" + } + } + }, + "DeleteRoleMembershipRequest": { + "type": "structure", + "required": [ + "MemberName", + "Role", + "AwsAccountId", + "Namespace" + ], + "members": { + "MemberName": { + "shape": "GroupName", + "documentation": "The name of the group.
", + "location": "uri", + "locationName": "MemberName" + }, + "Role": { + "shape": "Role", + "documentation": "The role that you want to remove permissions from.
", + "location": "uri", + "locationName": "Role" + }, + "AwsAccountId": { + "shape": "AwsAccountId", + "documentation": "The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
", + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "shape": "Namespace", + "documentation": "The namespace that contains the role.
", + "location": "uri", + "locationName": "Namespace" + } + } + }, + "DeleteRoleMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "shape": "String", + "documentation": "The Amazon Web Services request ID for this operation.
" + }, + "Status": { + "shape": "StatusCode", + "documentation": "The HTTP status of the request.
", + "location": "statusCode" + } + } + }, "DeleteTemplateAliasRequest": { "type": "structure", "required": [ @@ -14685,7 +15527,7 @@ "documentation": "Indicates the status of a job through its queuing and execution.
Poll this DescribeAssetBundleExportApi
until JobStatus
is either SUCCESSFUL
or FAILED
.
The URL to download the exported asset bundle data from.
This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob
again for a fresh URL if needed.
The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs
. The file has a .qs
extension.
This URL can't be used in a StartAssetBundleImportJob
API call and should only be used for download purposes.
The HTTP status of the response.
", "location": "statusCode" + }, + "IncludePermissions": { + "shape": "Boolean", + "documentation": "The include permissions flag.
" + }, + "IncludeTags": { + "shape": "Boolean", + "documentation": "The include tags flag.
" + }, + "ValidationStrategy": { + "shape": "AssetBundleExportJobValidationStrategy", + "documentation": "The validation strategy that is used to export the analysis or dashboard.
" + }, + "Warnings": { + "shape": "AssetBundleExportJobWarningList", + "documentation": "An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.
This property only appears if StrictModeForAllResources
in ValidationStrategy
is set to FALSE
.
Optional overrides to be applied to the resource configuration before import.
" + "documentation": "Optional overrides that are applied to the resource configuration before import.
" }, "FailureAction": { "shape": "AssetBundleImportFailureAction", @@ -14807,6 +15665,18 @@ "shape": "StatusCode", "documentation": "The HTTP status of the response.
", "location": "statusCode" + }, + "OverridePermissions": { + "shape": "AssetBundleImportJobOverridePermissions", + "documentation": "Optional permission overrides that are applied to the resource configuration before import.
" + }, + "OverrideTags": { + "shape": "AssetBundleImportJobOverrideTags", + "documentation": "Optional tag overrides that are applied to the resource configuration before import.
" + }, + "OverrideValidationStrategy": { + "shape": "AssetBundleImportJobOverrideValidationStrategy", + "documentation": "An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
" } } }, @@ -15839,6 +16709,51 @@ } } }, + "DescribeRoleCustomPermissionRequest": { + "type": "structure", + "required": [ + "Role", + "AwsAccountId", + "Namespace" + ], + "members": { + "Role": { + "shape": "Role", + "documentation": "The name of the role whose permissions you want described.
", + "location": "uri", + "locationName": "Role" + }, + "AwsAccountId": { + "shape": "AwsAccountId", + "documentation": "The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
", + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "shape": "Namespace", + "documentation": "The namespace that contains the role.
", + "location": "uri", + "locationName": "Namespace" + } + } + }, + "DescribeRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "CustomPermissionsName": { + "shape": "RoleName", + "documentation": "The name of the custom permission that is described.
" + }, + "RequestId": { + "shape": "String", + "documentation": "The Amazon Web Services request ID for this operation.
" + }, + "Status": { + "shape": "StatusCode", + "documentation": "The HTTP status of the request.
" + } + } + }, "DescribeTemplateAliasRequest": { "type": "structure", "required": [ @@ -21914,6 +22829,69 @@ } } }, + "ListRoleMembershipsRequest": { + "type": "structure", + "required": [ + "Role", + "AwsAccountId", + "Namespace" + ], + "members": { + "Role": { + "shape": "Role", + "documentation": "The name of the role.
", + "location": "uri", + "locationName": "Role" + }, + "NextToken": { + "shape": "String", + "documentation": "A pagination token that can be used in a subsequent request.
", + "location": "querystring", + "locationName": "next-token" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return.
", + "box": true, + "location": "querystring", + "locationName": "max-results" + }, + "AwsAccountId": { + "shape": "AwsAccountId", + "documentation": "The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
", + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "shape": "Namespace", + "documentation": "The namespace that includes the role.
", + "location": "uri", + "locationName": "Namespace" + } + } + }, + "ListRoleMembershipsResponse": { + "type": "structure", + "members": { + "MembersList": { + "shape": "GroupsList", + "documentation": "The list of groups associated with a role
" + }, + "NextToken": { + "shape": "String", + "documentation": "A pagination token that can be used in a subsequent request.
" + }, + "RequestId": { + "shape": "String", + "documentation": "The Amazon Web Services request ID for this operation.
" + }, + "Status": { + "shape": "StatusCode", + "documentation": "The HTTP status of the request.
", + "location": "statusCode" + } + } + }, "ListTagsForResourceRequest": { "type": "structure", "required": [ @@ -25106,6 +26084,11 @@ }, "documentation": "The options that determine the presentation of the progress bar of a KPI visual.
" }, + "ProjectId": { + "type": "string", + "max": 256, + "min": 1 + }, "ProjectOperation": { "type": "structure", "required": [ @@ -26248,6 +27231,14 @@ "min": 1, "pattern": "[\\w\\-]+" }, + "Role": { + "type": "string", + "enum": [ + "ADMIN", + "AUTHOR", + "READER" + ] + }, "RoleArn": { "type": "string", "max": 2048, @@ -28505,6 +29496,18 @@ "CloudFormationOverridePropertyConfiguration": { "shape": "AssetBundleCloudFormationOverridePropertyConfiguration", "documentation": "An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.
Use this field if the ExportFormat
field of a StartAssetBundleExportJobRequest
API call is set to CLOUDFORMATION_JSON
.
A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions
to TRUE
, any permissions associated with each resource are exported.
A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags
to TRUE
, any tags associated with each resource are exported.
An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources
is set to TRUE
, strict validation for every error is enforced. If it is set to FALSE
, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources
is FALSE
.
Optional overrides to be applied to the resource configuration before import.
" + "documentation": "Optional overrides that are applied to the resource configuration before import.
" }, "FailureAction": { "shape": "AssetBundleImportFailureAction", "documentation": "The failure action for the import job.
If you choose ROLLBACK
, failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING
, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
Optional permission overrides that are applied to the resource configuration before import.
" + }, + "OverrideTags": { + "shape": "AssetBundleImportJobOverrideTags", + "documentation": "Optional tag overrides that are applied to the resource configuration before import.
" + }, + "OverrideValidationStrategy": { + "shape": "AssetBundleImportJobOverrideValidationStrategy", + "documentation": "An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
" } } }, @@ -29781,9 +30796,6 @@ "Sheets": { "shape": "SheetList", "documentation": "A list of the associated sheets with the unique identifier and name of each sheet.
" - }, - "Options": { - "shape": "AssetOptions" } }, "documentation": "A version of a template.
" @@ -32666,7 +33678,7 @@ "member": { "shape": "ResourcePermission" }, - "max": 2 + "max": 100 }, "UpdatePublicSharingSettingsRequest": { "type": "structure", @@ -32755,6 +33767,52 @@ }, "max": 100 }, + "UpdateRoleCustomPermissionRequest": { + "type": "structure", + "required": [ + "CustomPermissionsName", + "Role", + "AwsAccountId", + "Namespace" + ], + "members": { + "CustomPermissionsName": { + "shape": "RoleName", + "documentation": "The name of the custom permission that you want to update the role with.
" + }, + "Role": { + "shape": "Role", + "documentation": "The name of role tht you want to update.
", + "location": "uri", + "locationName": "Role" + }, + "AwsAccountId": { + "shape": "AwsAccountId", + "documentation": "The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
", + "location": "uri", + "locationName": "AwsAccountId" + }, + "Namespace": { + "shape": "Namespace", + "documentation": "The namespace that contains the role that you want to update.
", + "location": "uri", + "locationName": "Namespace" + } + } + }, + "UpdateRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "shape": "String", + "documentation": "The Amazon Web Services request ID for this operation.
" + }, + "Status": { + "shape": "StatusCode", + "documentation": "The HTTP status of the request.
" + } + } + }, "UpdateTemplateAliasRequest": { "type": "structure", "required": [ @@ -33677,7 +34735,7 @@ "members": { "Mode": { "shape": "ValidationStrategyMode", - "documentation": "The mode of validation for the asset to be creaed or updated. When you set this value to STRICT
, strict validation for every error is enforced. When you set this value to LENIENT
, validation is skipped for specific UI errors.
The mode of validation for the asset to be created or updated. When you set this value to STRICT
, strict validation for every error is enforced. When you set this value to LENIENT
, validation is skipped for specific UI errors.
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT
, validation is skipped for specific errors.
The IAM Identity Center managed application instance ID.
" }, + "SingleSignOnApplicationArn": { + "shape": "SingleSignOnApplicationArn", + "documentation": "The ARN of the associated Amazon Web Services Single Sign-On application for this Domain.
" + }, "Status": { "shape": "DomainStatus", "documentation": "The status.
" @@ -17414,7 +17421,7 @@ "type": "string", "max": 40, "min": 1, - "pattern": "[\\S\\s]+" + "pattern": "^[-a-zA-Z0-9_.,;:! ]*$" }, "DeviceFleetArn": { "type": "string", @@ -17424,7 +17431,7 @@ "type": "string", "max": 800, "min": 1, - "pattern": "[\\S\\s]+" + "pattern": "^[-a-zA-Z0-9_.,;:! ]*$" }, "DeviceFleetSummaries": { "type": "list", @@ -26689,6 +26696,12 @@ "type": "integer", "min": 0 }, + "MaxPendingTimeInSeconds": { + "type": "integer", + "documentation": "Maximum job scheduler pending time in seconds.", + "max": 2419200, + "min": 7200 + }, "MaxPercentageOfInputDatasetLabeled": { "type": "integer", "max": 100, @@ -28237,7 +28250,6 @@ "ModelPackageSummary": { "type": "structure", "required": [ - "ModelPackageName", "ModelPackageArn", "CreationTime", "ModelPackageStatus" @@ -28999,7 +29011,7 @@ "type": "string", "max": 63, "min": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" }, "MonitoringJobDefinitionSortKey": { "type": "string", @@ -30682,7 +30694,7 @@ "type": "string", "max": 256, "min": 1, - "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$" + "pattern": "^[A-Za-z0-9\\-_]*$" }, "PipelineStatus": { "type": "string", @@ -34064,6 +34076,10 @@ }, "documentation": "A configuration for a shuffle option for input data in a channel. If you use S3Prefix
for S3DataType
, the results of the S3 key prefix matches are shuffled. If you use ManifestFile
, the order of the S3 object references in the ManifestFile
is shuffled. If you use AugmentedManifestFile
, the order of the JSON lines in the AugmentedManifestFile
is shuffled. The shuffling order is determined using the Seed
value.
For Pipe input mode, when ShuffleConfig
is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig
is combined with S3DataDistributionType
of ShardedByS3Key
, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds
. If the job does not complete during this time, SageMaker ends the job.
When RetryStrategy
is specified in the job request, MaxWaitTimeInSeconds
specifies the maximum time for all of the attempts in total, not each individual attempt.
The maximum pending time in seconds.
" } }, "documentation": "Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap model training costs.
To stop a training job, SageMaker sends the algorithm the SIGTERM
signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel
.
The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
The name of the Change Manager change request.
" + }, + "Variables": { + "shape": "AutomationParameterMap", + "documentation": "Variables defined for the automation.
" } }, "documentation": "Detailed information about the current state of an individual Automation execution.
" @@ -5155,7 +5159,8 @@ "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", - "CompletedWithFailure" + "CompletedWithFailure", + "Exited" ] }, "AutomationParameterKey": { @@ -6444,7 +6449,7 @@ }, "OpsItemType": { "shape": "OpsItemType", - "documentation": "The type of OpsItem to create. Systems Manager supports the following types of OpsItems:
/aws/issue
This type of OpsItem is used for default OpsItems created by OpsCenter.
/aws/changerequest
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
/aws/insights
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
The type of OpsItem to create. Systems Manager supports the following types of OpsItems:
/aws/issue
This type of OpsItem is used for default OpsItems created by OpsCenter.
/aws/changerequest
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
/aws/insight
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribeInstancePatches
include the following:
Classification
Sample values: Security
| SecurityUpdates
KBId
Sample values: KB4480056
| java-1.7.0-openjdk.x86_64
Severity
Sample values: Important
| Medium
| Low
State
Sample values: Installed
| InstalledOther
| InstalledPendingReboot
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribeInstancePatches
include the following:
Classification
Sample values: Security
| SecurityUpdates
KBId
Sample values: KB4480056
| java-1.7.0-openjdk.x86_64
Severity
Sample values: Important
| Medium
| Low
State
Sample values: Installed
| InstalledOther
| InstalledPendingReboot
For lists of all State
values, see Understanding patch compliance state values in the Amazon Web Services Systems Manager User Guide.
The type of OpsItem. Systems Manager supports the following types of OpsItems:
/aws/issue
This type of OpsItem is used for default OpsItems created by OpsCenter.
/aws/changerequest
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
/aws/insights
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
The type of OpsItem. Systems Manager supports the following types of OpsItems:
/aws/issue
This type of OpsItem is used for default OpsItems created by OpsCenter.
/aws/changerequest
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
/aws/insight
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
The type of OpsItem. Systems Manager supports the following types of OpsItems:
/aws/issue
This type of OpsItem is used for default OpsItems created by OpsCenter.
/aws/changerequest
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
/aws/insights
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
The type of OpsItem. Systems Manager supports the following types of OpsItems:
/aws/issue
This type of OpsItem is used for default OpsItems created by OpsCenter.
/aws/changerequest
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
/aws/insight
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
The unique ID of a step execution.
" + }, + "StepName": { + "shape": "String", + "documentation": "The name of the step.
" + }, + "Action": { + "shape": "AutomationActionName", + "documentation": "The name of the automation action.
" + }, + "Iteration": { + "shape": "Integer", + "documentation": "The current repetition of the loop represented by an integer.
", + "box": true + }, + "IteratorValue": { + "shape": "String", + "documentation": "The current value of the specified iterator in the loop.
" + } + }, + "documentation": "A detailed status of the parent step.
" + }, "Patch": { "type": "structure", "members": { @@ -16768,6 +16800,10 @@ "TriggeredAlarms": { "shape": "AlarmStateInformationList", "documentation": "The CloudWatch alarms that were invoked by the automation.
" + }, + "ParentStepDetails": { + "shape": "ParentStepDetails", + "documentation": "Information about the parent step.
" } }, "documentation": "Detailed information about an the execution state of an Automation step.
" @@ -16781,7 +16817,7 @@ "members": { "Key": { "shape": "StepExecutionFilterKey", - "documentation": "One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.
" + "documentation": "One or more keys to limit the results.
" }, "Values": { "shape": "StepExecutionFilterValueList", @@ -16798,7 +16834,10 @@ "StepExecutionStatus", "StepExecutionId", "StepName", - "Action" + "Action", + "ParentStepExecutionId", + "ParentStepIteration", + "ParentStepIteratorValue" ] }, "StepExecutionFilterList": { @@ -17957,7 +17996,7 @@ }, "SettingValue": { "shape": "ServiceSettingValue", - "documentation": "The new value to specify for the service setting. The following list specifies the available values for each setting.
/ssm/managed-instance/default-ec2-instance-management-role: The name of an IAM role
/ssm/automation/customer-script-log-destination
: CloudWatch
/ssm/automation/customer-script-log-group-name
: The name of an Amazon CloudWatch Logs log group
/ssm/documents/console/public-sharing-permission
: Enable
or Disable
/ssm/managed-instance/activation-tier
: standard
or advanced
/ssm/opsinsights/opscenter
: Enabled
or Disabled
/ssm/parameter-store/default-parameter-tier
: Standard
, Advanced
, Intelligent-Tiering
/ssm/parameter-store/high-throughput-enabled
: true
or false
The new value to specify for the service setting. The following list specifies the available values for each setting.
For /ssm/managed-instance/default-ec2-instance-management-role
, enter the name of an IAM role.
For /ssm/automation/customer-script-log-destination
, enter CloudWatch
.
For /ssm/automation/customer-script-log-group-name
, enter the name of an Amazon CloudWatch Logs log group.
For /ssm/documents/console/public-sharing-permission
, enter Enable
or Disable
.
For /ssm/managed-instance/activation-tier
, enter standard
or advanced
.
For /ssm/opsinsights/opscenter
, enter Enabled
or Disabled
.
For /ssm/parameter-store/default-parameter-tier
, enter Standard
, Advanced
, or Intelligent-Tiering
For /ssm/parameter-store/high-throughput-enabled
, enter true
or false
.
The request body of the UpdateServiceSetting API operation.
" @@ -17986,5 +18025,5 @@ "pattern": "^[0-9]{1,6}(\\.[0-9]{1,6}){2,3}$" } }, - "documentation": "Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
Related resources
For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference .
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .
For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .
Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
Related resources
For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference .
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .
For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .
Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.
" + }, "CreateReplicationSet": { "name": "CreateReplicationSet", "http": { @@ -434,6 +466,38 @@ ], "documentation": "Retrieves a timeline event based on its ID and incident record.
" }, + "ListIncidentFindings": { + "name": "ListIncidentFindings", + "http": { + "method": "POST", + "requestUri": "/listIncidentFindings", + "responseCode": 200 + }, + "input": { + "shape": "ListIncidentFindingsInput" + }, + "output": { + "shape": "ListIncidentFindingsOutput" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment that can be investigated as a potential cause of the incident.
" + }, "ListIncidentRecords": { "name": "ListIncidentRecords", "http": { @@ -580,7 +644,7 @@ "shape": "InternalServerException" } ], - "documentation": "Lists the tags that are attached to the specified response plan.
" + "documentation": "Lists the tags that are attached to the specified response plan or incident.
" }, "ListTimelineEvents": { "name": "ListTimelineEvents", @@ -1042,6 +1106,69 @@ "max": 100, "min": 0 }, + "BatchGetIncidentFindingsError": { + "type": "structure", + "required": [ + "code", + "findingId", + "message" + ], + "members": { + "code": { + "shape": "String", + "documentation": "The code associated with an error that was returned for a BatchGetIncidentFindings
operation.
The ID of a specified finding for which an error was returned for a BatchGetIncidentFindings
operation.
The description for an error that was returned for a BatchGetIncidentFindings
operation.
Details about an error returned for a BatchGetIncidentFindings operation.
" + }, + "BatchGetIncidentFindingsErrorList": { + "type": "list", + "member": { + "shape": "BatchGetIncidentFindingsError" + } + }, + "BatchGetIncidentFindingsInput": { + "type": "structure", + "required": [ + "findingIds", + "incidentRecordArn" + ], + "members": { + "findingIds": { + "shape": "FindingIdList", + "documentation": "A list of IDs of findings for which you want to view details.
" + }, + "incidentRecordArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) of the incident for which you want to view finding details.
" + } + } + }, + "BatchGetIncidentFindingsOutput": { + "type": "structure", + "required": [ + "errors", + "findings" + ], + "members": { + "errors": { + "shape": "BatchGetIncidentFindingsErrorList", + "documentation": "A list of errors encountered during the operation.
" + }, + "findings": { + "shape": "FindingList", + "documentation": "Information about the requested findings.
" + } + } + }, "Boolean": { "type": "boolean", "box": true @@ -1074,6 +1201,60 @@ "max": 128, "min": 0 }, + "CloudFormationStackUpdate": { + "type": "structure", + "required": [ + "stackArn", + "startTime" + ], + "members": { + "endTime": { + "shape": "Timestamp", + "documentation": "The timestamp for when the CloudFormation stack creation or update ended. Not reported for deployments that are still in progress.
" + }, + "stackArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) of the CloudFormation stack involved in the update.
" + }, + "startTime": { + "shape": "Timestamp", + "documentation": "The timestamp for when the CloudFormation stack creation or update began.
" + } + }, + "documentation": "Information about an CloudFormation stack creation or update that occurred around the time of an incident and could be a potential cause of the incident.
" + }, + "CodeDeployDeployment": { + "type": "structure", + "required": [ + "deploymentGroupArn", + "deploymentId", + "startTime" + ], + "members": { + "deploymentGroupArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) of the CodeDeploy deployment group associated with the deployment.
" + }, + "deploymentId": { + "shape": "CodeDeployDeploymentDeploymentIdString", + "documentation": "The ID of the CodeDeploy deployment.
" + }, + "endTime": { + "shape": "Timestamp", + "documentation": "The timestamp for when the CodeDeploy deployment ended. Not reported for deployments that are still in progress.
" + }, + "startTime": { + "shape": "Timestamp", + "documentation": "The timestamp for when the CodeDeploy deployment began.
" + } + }, + "documentation": "Information about a CodeDeploy deployment that occurred around the time of an incident and could be a possible cause of the incident.
" + }, + "CodeDeployDeploymentDeploymentIdString": { + "type": "string", + "max": 128, + "min": 0 + }, "Condition": { "type": "structure", "members": { @@ -1208,11 +1389,11 @@ }, "eventTime": { "shape": "Timestamp", - "documentation": "The time that the event occurred.
" + "documentation": "The timestamp for when the event occurred.
" }, "eventType": { "shape": "TimelineEventType", - "documentation": "The type of event. You can create timeline events of type Custom Event
.
The type of event. You can create timeline events of type Custom Event
and Note
.
To make a Note-type event appear on the Incident notes panel in the console, specify eventType
as Note
and enter the Amazon Resource Name (ARN) of the incident as the value for eventReference
.
The time that the event occurred.
" + "documentation": "The timestamp for when the event occurred.
" }, "eventType": { "shape": "TimelineEventType", - "documentation": "The type of event. The timeline event must be Custom Event
.
The type of event. The timeline event must be Custom Event
or Note
.
The time that the timeline event was last updated.
" + "documentation": "The timestamp for when the timeline event was last updated.
" }, "incidentRecordArn": { "shape": "Arn", @@ -1491,6 +1672,93 @@ "max": 5, "min": 0 }, + "Finding": { + "type": "structure", + "required": [ + "creationTime", + "id", + "lastModifiedTime" + ], + "members": { + "creationTime": { + "shape": "Timestamp", + "documentation": "The timestamp for when a finding was created.
" + }, + "details": { + "shape": "FindingDetails", + "documentation": "Details about the finding.
" + }, + "id": { + "shape": "FindingId", + "documentation": "The ID assigned to the finding.
" + }, + "lastModifiedTime": { + "shape": "Timestamp", + "documentation": "The timestamp for when the finding was most recently updated with additional information.
" + } + }, + "documentation": "Information about a specific CodeDeploy deployment or CloudFormation stack creation or update that occurred around the time of a reported incident. These activities can be investigated as a potential cause of the incident.
" + }, + "FindingDetails": { + "type": "structure", + "members": { + "cloudFormationStackUpdate": { + "shape": "CloudFormationStackUpdate", + "documentation": "Information about the CloudFormation stack creation or update associated with the finding.
" + }, + "codeDeployDeployment": { + "shape": "CodeDeployDeployment", + "documentation": "Information about the CodeDeploy deployment associated with the finding.
" + } + }, + "documentation": "Extended textual information about the finding.
", + "union": true + }, + "FindingId": { + "type": "string", + "max": 128, + "min": 0 + }, + "FindingIdList": { + "type": "list", + "member": { + "shape": "FindingId" + }, + "max": 20, + "min": 0 + }, + "FindingList": { + "type": "list", + "member": { + "shape": "Finding" + } + }, + "FindingSummary": { + "type": "structure", + "required": [ + "id", + "lastModifiedTime" + ], + "members": { + "id": { + "shape": "FindingId", + "documentation": "The ID of the finding.
" + }, + "lastModifiedTime": { + "shape": "Timestamp", + "documentation": "The timestamp for when the finding was last updated.
" + } + }, + "documentation": "Identifying information about the finding.
" + }, + "FindingSummaryList": { + "type": "list", + "member": { + "shape": "FindingSummary" + }, + "max": 100, + "min": 0 + }, "GeneratedId": { "type": "string", "max": 200, @@ -1561,7 +1829,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token for the next set of items to return. (You received this token from a previous call.)
" }, "resourceArn": { "shape": "Arn", @@ -1579,7 +1847,7 @@ "members": { "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.
" }, "resourcePolicies": { "shape": "ResourcePolicyList", @@ -1710,7 +1978,7 @@ }, "creationTime": { "shape": "Timestamp", - "documentation": "The time that Incident Manager created the incident record.
" + "documentation": "The timestamp for when Incident Manager created the incident record.
" }, "dedupeString": { "shape": "DedupeString", @@ -1718,7 +1986,7 @@ }, "impact": { "shape": "Impact", - "documentation": "The impact of the incident on customers and applications.
" + "documentation": "The impact of the incident on customers and applications.
Supported impact codes
1
- Critical
2
- High
3
- Medium
4
- Low
5
- No Impact
The time at which the incident was most recently modified.
" + "documentation": "The timestamp for when the incident was most recently modified.
" }, "notificationTargets": { "shape": "NotificationTargetSet", @@ -1738,7 +2006,7 @@ }, "resolvedTime": { "shape": "Timestamp", - "documentation": "The time at which the incident was resolved. This appears as a timeline event.
" + "documentation": "The timestamp for when the incident was resolved. This appears as a timeline event.
" }, "status": { "shape": "IncidentRecordStatus", @@ -1805,7 +2073,7 @@ }, "creationTime": { "shape": "Timestamp", - "documentation": "The time the incident was created.
" + "documentation": "The timestamp for when the incident was created.
" }, "impact": { "shape": "Impact", @@ -1817,7 +2085,7 @@ }, "resolvedTime": { "shape": "Timestamp", - "documentation": "The time the incident was resolved.
" + "documentation": "The timestamp for when the incident was resolved.
" }, "status": { "shape": "IncidentRecordStatus", @@ -1857,11 +2125,11 @@ "members": { "dedupeString": { "shape": "DedupeString", - "documentation": "Used to stop Incident Manager from creating multiple incident records for the same incident.
" + "documentation": "The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.
A deduplication string is a term or phrase the system uses to check for duplicate incidents. If you specify a deduplication string, Incident Manager searches for open incidents that contain the same string in the dedupeString
field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.
By default, Incident Manager automatically deduplicates multiple incidents created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You don't have to enter your own deduplication string to prevent duplication for these resource types.
The impact of the incident on your customers and applications.
" + "documentation": "The impact of the incident on your customers and applications.
Supported impact codes
1
- Critical
2
- High
3
- Medium
4
- Low
5
- No Impact
Describes a related item.
", "union": true }, + "ListIncidentFindingsInput": { + "type": "structure", + "required": [ + "incidentRecordArn" + ], + "members": { + "incidentRecordArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) of the incident for which you want to view associated findings.
" + }, + "maxResults": { + "shape": "ListIncidentFindingsInputMaxResultsInteger", + "documentation": "The maximum number of findings to retrieve per call.
" + }, + "nextToken": { + "shape": "NextToken", + "documentation": "The pagination token for the next set of items to return. (You received this token from a previous call.)
" + } + } + }, + "ListIncidentFindingsInputMaxResultsInteger": { + "type": "integer", + "box": true, + "max": 20, + "min": 1 + }, + "ListIncidentFindingsOutput": { + "type": "structure", + "required": [ + "findings" + ], + "members": { + "findings": { + "shape": "FindingSummaryList", + "documentation": "A list of findings that represent deployments that might be the potential cause of the incident.
" + }, + "nextToken": { + "shape": "NextToken", + "documentation": "The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.
" + } + } + }, "ListIncidentRecordsInput": { "type": "structure", "members": { @@ -1986,7 +2296,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token for the next set of items to return. (You received this token from a previous call.)
" } } }, @@ -2002,7 +2312,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.
" } } }, @@ -2022,7 +2332,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token for the next set of items to return. (You received this token from a previous call.)
" } } }, @@ -2034,7 +2344,7 @@ "members": { "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.
" }, "relatedItems": { "shape": "RelatedItemList", @@ -2051,7 +2361,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token for the next set of items to return. (You received this token from a previous call.)
" } } }, @@ -2063,7 +2373,7 @@ "members": { "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.
" }, "replicationSetArns": { "shape": "ReplicationSetArnList", @@ -2080,7 +2390,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token for the next set of items to return. (You received this token from a previous call.)
" } } }, @@ -2092,7 +2402,7 @@ "members": { "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.
" }, "responsePlanSummaries": { "shape": "ResponsePlanSummaryList", @@ -2108,7 +2418,7 @@ "members": { "resourceArn": { "shape": "String", - "documentation": "The Amazon Resource Name (ARN) of the response plan.
", + "documentation": "The Amazon Resource Name (ARN) of the response plan or incident.
", "location": "uri", "locationName": "resourceArn" } @@ -2122,7 +2432,7 @@ "members": { "tags": { "shape": "TagMap", - "documentation": "A list of tags for the response plan.
" + "documentation": "A list of tags for the response plan or incident.
" } } }, @@ -2134,7 +2444,7 @@ "members": { "filters": { "shape": "FilterList", - "documentation": "Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:
eventTime
eventType
Note the following when deciding how to use Filters:
If you don't specify a Filter, the response includes all timeline events.
If you specify more than one filter in a single request, the response returns timeline events that match all filters.
If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:
eventReference
eventTime
eventType
Note the following when deciding how to use Filters:
If you don't specify a Filter, the response includes all timeline events.
If you specify more than one filter in a single request, the response returns timeline events that match all filters.
If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
The pagination token to continue to the next page of results.
" + "documentation": "The pagination token for the next set of items to return. (You received this token from a previous call.)
" }, "sortBy": { "shape": "TimelineEventSort", @@ -2170,7 +2480,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "The pagination token to continue to the next page of results.
" + "documentation": "The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.
" } } }, @@ -2356,7 +2666,7 @@ }, "statusUpdateDateTime": { "shape": "Timestamp", - "documentation": "The most recent date and time that Incident Manager updated the Amazon Web Services Region's status.
" + "documentation": "The timestamp for when Incident Manager updated the status of the Amazon Web Services Region.
" } }, "documentation": "Information about a Amazon Web Services Region in your replication set.
" @@ -2715,7 +3025,7 @@ }, "impact": { "shape": "Impact", - "documentation": "Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Possible impacts:
1
- Critical impact, this typically relates to full application failure that impacts many to all customers.
2
- High impact, partial application failure with impact to many customers.
3
- Medium impact, the application is providing reduced service to customers.
4
- Low impact, customer might aren't impacted by the problem yet.
5
- No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Supported impact codes
1
- Critical
2
- High
3
- Medium
4
- Low
5
- No Impact
The time that the event occurred.
" + "documentation": "The timestamp for when the event occurred.
" }, "eventType": { "shape": "TimelineEventType", - "documentation": "The type of event that occurred. Currently Incident Manager supports only the Custom Event
type.
The type of event that occurred. Currently Incident Manager supports only the Custom Event
and Note
types.
The time that the timeline event was last updated.
" + "documentation": "The timestamp for when the timeline event was last updated.
" }, "incidentRecordArn": { "shape": "Arn", @@ -2901,7 +3211,7 @@ }, "timestamp": { "shape": "Timestamp", - "documentation": "The time that the incident was detected.
" + "documentation": "The timestamp for when the incident was detected.
" }, "triggerArn": { "shape": "Arn", @@ -2987,7 +3297,7 @@ }, "impact": { "shape": "Impact", - "documentation": "Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.
Possible impacts:
1
- Critical impact, full application failure that impacts many to all customers.
2
- High impact, partial application failure with impact to many customers.
3
- Medium impact, the application is providing reduced service to customers.
4
- Low impact, customer aren't impacted by the problem yet.
5
- No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.
Supported impact codes
1
- Critical
2
- High
3
- Medium
4
- Low
5
- No Impact
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Possible impacts:
5
- Severe impact
4
- High impact
3
- Medium impact
2
- Low impact
1
- No impact
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Supported impact codes
1
- Critical
2
- High
3
- Medium
4
- Low
5
- No Impact
The time that the event occurred.
" + "documentation": "The timestamp for when the event occurred.
" }, "eventType": { "shape": "TimelineEventType", - "documentation": "The type of event. You can update events of type Custom Event
.
The type of event. You can update events of type Custom Event
and Note
.
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
The term principal here refers to a user or group that is defined in IAM Identity Center.
As part of a successful CreateAccountAssignment
call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call ProvisionPermissionSet
to make these updates.
After a successful response, call DescribeAccountAssignmentCreationStatus
to describe the status of an assignment creation request.
Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
After a successful response, call DescribeInstanceAccessControlAttributeConfiguration
to validate that InstanceAccessControlAttributeConfiguration
was created.
Creates an application in IAM Identity Center for the given application provider.
" }, - "CreatePermissionSet": { - "name": "CreatePermissionSet", + "CreateApplicationAssignment": { + "name": "CreateApplicationAssignment", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "CreatePermissionSetRequest" + "shape": "CreateApplicationAssignmentRequest" }, "output": { - "shape": "CreatePermissionSetResponse" + "shape": "CreateApplicationAssignmentResponse" }, "errors": [ { @@ -194,29 +197,29 @@ "shape": "ConflictException" } ], - "documentation": "Creates a permission set within a specified IAM Identity Center instance.
To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment
.
Grant application access to a user or group.
" }, - "DeleteAccountAssignment": { - "name": "DeleteAccountAssignment", + "CreateInstance": { + "name": "CreateInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeleteAccountAssignmentRequest" + "shape": "CreateInstanceRequest" }, "output": { - "shape": "DeleteAccountAssignmentResponse" + "shape": "CreateInstanceResponse" }, "errors": [ { - "shape": "ThrottlingException" + "shape": "ServiceQuotaExceededException" }, { - "shape": "InternalServerException" + "shape": "ThrottlingException" }, { - "shape": "ResourceNotFoundException" + "shape": "InternalServerException" }, { "shape": "AccessDeniedException" @@ -228,19 +231,19 @@ "shape": "ConflictException" } ], - "documentation": "Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
After a successful response, call DescribeAccountAssignmentDeletionStatus
to describe the status of an assignment deletion request.
Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization. You can create only one instance per account and across all Amazon Web Services Regions.
The CreateInstance request is rejected if the following apply:
The instance is created within the organization management account.
An instance already exists in the same account.
Deletes the inline policy from a specified permission set.
" + "documentation": "Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
After a successful response, call DescribeInstanceAccessControlAttributeConfiguration
to validate that InstanceAccessControlAttributeConfiguration
was created.
Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
" + "documentation": "Creates a permission set within a specified IAM Identity Center instance.
To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment
.
Deletes the specified permission set.
" + "documentation": "Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services.
This trusted token issuer describes an external identity provider (IdP) that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication.
" }, - "DeletePermissionsBoundaryFromPermissionSet": { - "name": "DeletePermissionsBoundaryFromPermissionSet", + "DeleteAccountAssignment": { + "name": "DeleteAccountAssignment", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DeletePermissionsBoundaryFromPermissionSetRequest" + "shape": "DeleteAccountAssignmentRequest" }, "output": { - "shape": "DeletePermissionsBoundaryFromPermissionSetResponse" + "shape": "DeleteAccountAssignmentResponse" }, "errors": [ { @@ -359,21 +365,24 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Deletes the permissions boundary from a specified PermissionSet.
" + "documentation": "Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
After a successful response, call DescribeAccountAssignmentDeletionStatus
to describe the status of an assignment deletion request.
Describes the status of the assignment creation request.
" + "documentation": "Deletes the association with the application. The connected service resource still exists.
" }, - "DescribeAccountAssignmentDeletionStatus": { - "name": "DescribeAccountAssignmentDeletionStatus", + "DeleteApplicationAccessScope": { + "name": "DeleteApplicationAccessScope", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribeAccountAssignmentDeletionStatusRequest" - }, - "output": { - "shape": "DescribeAccountAssignmentDeletionStatusResponse" + "shape": "DeleteApplicationAccessScopeRequest" }, "errors": [ { @@ -421,21 +430,25 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Describes the status of the assignment deletion request.
" + "documentation": "Deletes an IAM Identity Center access scope from an application.
", + "idempotent": true }, - "DescribeInstanceAccessControlAttributeConfiguration": { - "name": "DescribeInstanceAccessControlAttributeConfiguration", + "DeleteApplicationAssignment": { + "name": "DeleteApplicationAssignment", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribeInstanceAccessControlAttributeConfigurationRequest" + "shape": "DeleteApplicationAssignmentRequest" }, "output": { - "shape": "DescribeInstanceAccessControlAttributeConfigurationResponse" + "shape": "DeleteApplicationAssignmentResponse" }, "errors": [ { @@ -452,21 +465,22 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
" + "documentation": "Revoke application access to an application by deleting application assignments for a user or group.
", + "idempotent": true }, - "DescribePermissionSet": { - "name": "DescribePermissionSet", + "DeleteApplicationAuthenticationMethod": { + "name": "DeleteApplicationAuthenticationMethod", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribePermissionSetRequest" - }, - "output": { - "shape": "DescribePermissionSetResponse" + "shape": "DeleteApplicationAuthenticationMethodRequest" }, "errors": [ { @@ -483,21 +497,22 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Gets the details of the permission set.
" + "documentation": "Deletes an authentication method from an application.
", + "idempotent": true }, - "DescribePermissionSetProvisioningStatus": { - "name": "DescribePermissionSetProvisioningStatus", + "DeleteApplicationGrant": { + "name": "DeleteApplicationGrant", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DescribePermissionSetProvisioningStatusRequest" - }, - "output": { - "shape": "DescribePermissionSetProvisioningStatusResponse" + "shape": "DeleteApplicationGrantRequest" }, "errors": [ { @@ -514,21 +529,25 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Describes the status for the given permission set provisioning request.
" + "documentation": "Deletes a grant from an application.
", + "idempotent": true }, - "DetachCustomerManagedPolicyReferenceFromPermissionSet": { - "name": "DetachCustomerManagedPolicyReferenceFromPermissionSet", + "DeleteInlinePolicyFromPermissionSet": { + "name": "DeleteInlinePolicyFromPermissionSet", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DetachCustomerManagedPolicyReferenceFromPermissionSetRequest" + "shape": "DeleteInlinePolicyFromPermissionSetRequest" }, "output": { - "shape": "DetachCustomerManagedPolicyReferenceFromPermissionSetResponse" + "shape": "DeleteInlinePolicyFromPermissionSetResponse" }, "errors": [ { @@ -550,19 +569,19 @@ "shape": "ConflictException" } ], - "documentation": "Detaches the specified customer managed policy from the specified PermissionSet.
" + "documentation": "Deletes the inline policy from a specified permission set.
" }, - "DetachManagedPolicyFromPermissionSet": { - "name": "DetachManagedPolicyFromPermissionSet", + "DeleteInstance": { + "name": "DeleteInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "DetachManagedPolicyFromPermissionSetRequest" + "shape": "DeleteInstanceRequest" }, "output": { - "shape": "DetachManagedPolicyFromPermissionSetResponse" + "shape": "DeleteInstanceResponse" }, "errors": [ { @@ -571,9 +590,6 @@ { "shape": "InternalServerException" }, - { - "shape": "ResourceNotFoundException" - }, { "shape": "AccessDeniedException" }, @@ -584,19 +600,19 @@ "shape": "ConflictException" } ], - "documentation": "Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
" + "documentation": "Deletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.
" }, - "GetInlinePolicyForPermissionSet": { - "name": "GetInlinePolicyForPermissionSet", + "DeleteInstanceAccessControlAttributeConfiguration": { + "name": "DeleteInstanceAccessControlAttributeConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "GetInlinePolicyForPermissionSetRequest" + "shape": "DeleteInstanceAccessControlAttributeConfigurationRequest" }, "output": { - "shape": "GetInlinePolicyForPermissionSetResponse" + "shape": "DeleteInstanceAccessControlAttributeConfigurationResponse" }, "errors": [ { @@ -613,21 +629,24 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Obtains the inline policy assigned to the permission set.
" + "documentation": "Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
" }, - "GetPermissionsBoundaryForPermissionSet": { - "name": "GetPermissionsBoundaryForPermissionSet", + "DeletePermissionSet": { + "name": "DeletePermissionSet", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "GetPermissionsBoundaryForPermissionSetRequest" + "shape": "DeletePermissionSetRequest" }, "output": { - "shape": "GetPermissionsBoundaryForPermissionSetResponse" + "shape": "DeletePermissionSetResponse" }, "errors": [ { @@ -644,21 +663,24 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Obtains the permissions boundary for a specified PermissionSet.
" + "documentation": "Deletes the specified permission set.
" }, - "ListAccountAssignmentCreationStatus": { - "name": "ListAccountAssignmentCreationStatus", + "DeletePermissionsBoundaryFromPermissionSet": { + "name": "DeletePermissionsBoundaryFromPermissionSet", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListAccountAssignmentCreationStatusRequest" + "shape": "DeletePermissionsBoundaryFromPermissionSetRequest" }, "output": { - "shape": "ListAccountAssignmentCreationStatusResponse" + "shape": "DeletePermissionsBoundaryFromPermissionSetResponse" }, "errors": [ { @@ -675,21 +697,24 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
" + "documentation": "Deletes the permissions boundary from a specified PermissionSet.
" }, - "ListAccountAssignmentDeletionStatus": { - "name": "ListAccountAssignmentDeletionStatus", + "DeleteTrustedTokenIssuer": { + "name": "DeleteTrustedTokenIssuer", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListAccountAssignmentDeletionStatusRequest" + "shape": "DeleteTrustedTokenIssuerRequest" }, "output": { - "shape": "ListAccountAssignmentDeletionStatusResponse" + "shape": "DeleteTrustedTokenIssuerResponse" }, "errors": [ { @@ -706,21 +731,24 @@ }, { "shape": "ValidationException" + }, + { + "shape": "ConflictException" } ], - "documentation": "Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
" + "documentation": "Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
" + "documentation": "Describes the status of the assignment creation request.
" }, - "ListAccountsForProvisionedPermissionSet": { - "name": "ListAccountsForProvisionedPermissionSet", + "DescribeAccountAssignmentDeletionStatus": { + "name": "DescribeAccountAssignmentDeletionStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListAccountsForProvisionedPermissionSetRequest" + "shape": "DescribeAccountAssignmentDeletionStatusRequest" }, "output": { - "shape": "ListAccountsForProvisionedPermissionSetResponse" + "shape": "DescribeAccountAssignmentDeletionStatusResponse" }, "errors": [ { @@ -770,19 +798,19 @@ "shape": "ValidationException" } ], - "documentation": "Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
" + "documentation": "Describes the status of the assignment deletion request.
" }, - "ListCustomerManagedPolicyReferencesInPermissionSet": { - "name": "ListCustomerManagedPolicyReferencesInPermissionSet", + "DescribeApplication": { + "name": "DescribeApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListCustomerManagedPolicyReferencesInPermissionSetRequest" + "shape": "DescribeApplicationRequest" }, "output": { - "shape": "ListCustomerManagedPolicyReferencesInPermissionSetResponse" + "shape": "DescribeApplicationResponse" }, "errors": [ { @@ -801,19 +829,19 @@ "shape": "ValidationException" } ], - "documentation": "Lists all customer managed policies attached to a specified PermissionSet.
" + "documentation": "Retrieves the details of an application associated with an instance of IAM Identity Center.
" }, - "ListInstances": { - "name": "ListInstances", + "DescribeApplicationAssignment": { + "name": "DescribeApplicationAssignment", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListInstancesRequest" + "shape": "DescribeApplicationAssignmentRequest" }, "output": { - "shape": "ListInstancesResponse" + "shape": "DescribeApplicationAssignmentResponse" }, "errors": [ { @@ -822,6 +850,9 @@ { "shape": "InternalServerException" }, + { + "shape": "ResourceNotFoundException" + }, { "shape": "AccessDeniedException" }, @@ -829,19 +860,19 @@ "shape": "ValidationException" } ], - "documentation": "Lists the IAM Identity Center instances that the caller has access to.
" + "documentation": "Retrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use ListApplicationAssignmentsForPrincipal.
" }, - "ListManagedPoliciesInPermissionSet": { - "name": "ListManagedPoliciesInPermissionSet", + "DescribeApplicationProvider": { + "name": "DescribeApplicationProvider", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListManagedPoliciesInPermissionSetRequest" + "shape": "DescribeApplicationProviderRequest" }, "output": { - "shape": "ListManagedPoliciesInPermissionSetResponse" + "shape": "DescribeApplicationProviderResponse" }, "errors": [ { @@ -860,19 +891,19 @@ "shape": "ValidationException" } ], - "documentation": "Lists the Amazon Web Services managed policy that is attached to a specified permission set.
" + "documentation": "Retrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.
" }, - "ListPermissionSetProvisioningStatus": { - "name": "ListPermissionSetProvisioningStatus", + "DescribeInstance": { + "name": "DescribeInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListPermissionSetProvisioningStatusRequest" + "shape": "DescribeInstanceRequest" }, "output": { - "shape": "ListPermissionSetProvisioningStatusResponse" + "shape": "DescribeInstanceResponse" }, "errors": [ { @@ -881,9 +912,6 @@ { "shape": "InternalServerException" }, - { - "shape": "ResourceNotFoundException" - }, { "shape": "AccessDeniedException" }, @@ -891,19 +919,19 @@ "shape": "ValidationException" } ], - "documentation": "Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
" + "documentation": "Returns the details of an instance of IAM Identity Center. The status can be one of the following:
CREATE_IN_PROGRESS
- The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status of ACTIVE
. While the instance is in the CREATE_IN_PROGRESS
state, you can call only DescribeInstance and DeleteInstance operations.
DELETE_IN_PROGRESS
- The instance is being deleted. Returns AccessDeniedException
after the delete operation completes.
ACTIVE
- The instance is active.
Lists the PermissionSets in an IAM Identity Center instance.
" + "documentation": "Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
" }, - "ListPermissionSetsProvisionedToAccount": { - "name": "ListPermissionSetsProvisionedToAccount", + "DescribePermissionSet": { + "name": "DescribePermissionSet", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListPermissionSetsProvisionedToAccountRequest" + "shape": "DescribePermissionSetRequest" }, "output": { - "shape": "ListPermissionSetsProvisionedToAccountResponse" + "shape": "DescribePermissionSetResponse" }, "errors": [ { @@ -953,19 +981,19 @@ "shape": "ValidationException" } ], - "documentation": "Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
" + "documentation": "Gets the details of the permission set.
" }, - "ListTagsForResource": { - "name": "ListTagsForResource", + "DescribePermissionSetProvisioningStatus": { + "name": "DescribePermissionSetProvisioningStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { - "shape": "ListTagsForResourceRequest" + "shape": "DescribePermissionSetProvisioningStatusRequest" }, "output": { - "shape": "ListTagsForResourceResponse" + "shape": "DescribePermissionSetProvisioningStatusResponse" }, "errors": [ { @@ -984,7 +1012,900 @@ "shape": "ValidationException" } ], - "documentation": "Lists the tags that are attached to a specified resource.
" + "documentation": "Describes the status for the given permission set provisioning request.
" + }, + "DescribeTrustedTokenIssuer": { + "name": "DescribeTrustedTokenIssuer", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTrustedTokenIssuerRequest" + }, + "output": { + "shape": "DescribeTrustedTokenIssuerResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.
" + }, + "DetachCustomerManagedPolicyReferenceFromPermissionSet": { + "name": "DetachCustomerManagedPolicyReferenceFromPermissionSet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DetachCustomerManagedPolicyReferenceFromPermissionSetRequest" + }, + "output": { + "shape": "DetachCustomerManagedPolicyReferenceFromPermissionSetResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Detaches the specified customer managed policy from the specified PermissionSet.
" + }, + "DetachManagedPolicyFromPermissionSet": { + "name": "DetachManagedPolicyFromPermissionSet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DetachManagedPolicyFromPermissionSetRequest" + }, + "output": { + "shape": "DetachManagedPolicyFromPermissionSetResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
" + }, + "GetApplicationAccessScope": { + "name": "GetApplicationAccessScope", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetApplicationAccessScopeRequest" + }, + "output": { + "shape": "GetApplicationAccessScopeResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Retrieves the authorized targets for an IAM Identity Center access scope for an application.
" + }, + "GetApplicationAssignmentConfiguration": { + "name": "GetApplicationAssignmentConfiguration", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetApplicationAssignmentConfigurationRequest" + }, + "output": { + "shape": "GetApplicationAssignmentConfigurationResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Retrieves the configuration of PutApplicationAssignmentConfiguration.
" + }, + "GetApplicationAuthenticationMethod": { + "name": "GetApplicationAuthenticationMethod", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetApplicationAuthenticationMethodRequest" + }, + "output": { + "shape": "GetApplicationAuthenticationMethodResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Retrieves details about an authentication method used by an application.
" + }, + "GetApplicationGrant": { + "name": "GetApplicationGrant", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetApplicationGrantRequest" + }, + "output": { + "shape": "GetApplicationGrantResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Retrieves details about an application grant.
" + }, + "GetInlinePolicyForPermissionSet": { + "name": "GetInlinePolicyForPermissionSet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetInlinePolicyForPermissionSetRequest" + }, + "output": { + "shape": "GetInlinePolicyForPermissionSetResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Obtains the inline policy assigned to the permission set.
" + }, + "GetPermissionsBoundaryForPermissionSet": { + "name": "GetPermissionsBoundaryForPermissionSet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetPermissionsBoundaryForPermissionSetRequest" + }, + "output": { + "shape": "GetPermissionsBoundaryForPermissionSetResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Obtains the permissions boundary for a specified PermissionSet.
" + }, + "ListAccountAssignmentCreationStatus": { + "name": "ListAccountAssignmentCreationStatus", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListAccountAssignmentCreationStatusRequest" + }, + "output": { + "shape": "ListAccountAssignmentCreationStatusResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
" + }, + "ListAccountAssignmentDeletionStatus": { + "name": "ListAccountAssignmentDeletionStatus", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListAccountAssignmentDeletionStatusRequest" + }, + "output": { + "shape": "ListAccountAssignmentDeletionStatusResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
" + }, + "ListAccountAssignments": { + "name": "ListAccountAssignments", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListAccountAssignmentsRequest" + }, + "output": { + "shape": "ListAccountAssignmentsResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the assignee of the specified Amazon Web Services account with the specified permission set.
" + }, + "ListAccountAssignmentsForPrincipal": { + "name": "ListAccountAssignmentsForPrincipal", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListAccountAssignmentsForPrincipalRequest" + }, + "output": { + "shape": "ListAccountAssignmentsForPrincipalResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
" + }, + "ListAccountsForProvisionedPermissionSet": { + "name": "ListAccountsForProvisionedPermissionSet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListAccountsForProvisionedPermissionSetRequest" + }, + "output": { + "shape": "ListAccountsForProvisionedPermissionSetResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
" + }, + "ListApplicationAccessScopes": { + "name": "ListApplicationAccessScopes", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListApplicationAccessScopesRequest" + }, + "output": { + "shape": "ListApplicationAccessScopesResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the access scopes and authorized targets associated with an application.
" + }, + "ListApplicationAssignments": { + "name": "ListApplicationAssignments", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListApplicationAssignmentsRequest" + }, + "output": { + "shape": "ListApplicationAssignmentsResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists Amazon Web Services account users that are assigned to an application.
" + }, + "ListApplicationAssignmentsForPrincipal": { + "name": "ListApplicationAssignmentsForPrincipal", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListApplicationAssignmentsForPrincipalRequest" + }, + "output": { + "shape": "ListApplicationAssignmentsForPrincipalResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the applications to which a specified principal is assigned.
" + }, + "ListApplicationAuthenticationMethods": { + "name": "ListApplicationAuthenticationMethods", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListApplicationAuthenticationMethodsRequest" + }, + "output": { + "shape": "ListApplicationAuthenticationMethodsResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists all of the authentication methods supported by the specified application.
" + }, + "ListApplicationGrants": { + "name": "ListApplicationGrants", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListApplicationGrantsRequest" + }, + "output": { + "shape": "ListApplicationGrantsResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "List the grants associated with an application.
" + }, + "ListApplicationProviders": { + "name": "ListApplicationProviders", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListApplicationProvidersRequest" + }, + "output": { + "shape": "ListApplicationProvidersResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the application providers configured in the IAM Identity Center identity store.
" + }, + "ListApplications": { + "name": "ListApplications", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListApplicationsRequest" + }, + "output": { + "shape": "ListApplicationsResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance in the management account, member accounts must use the applicationAccount
parameter to filter the list to only applications created from that account.
Lists all customer managed policies attached to a specified PermissionSet.
" + }, + "ListInstances": { + "name": "ListInstances", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListInstancesRequest" + }, + "output": { + "shape": "ListInstancesResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.
" + }, + "ListManagedPoliciesInPermissionSet": { + "name": "ListManagedPoliciesInPermissionSet", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListManagedPoliciesInPermissionSetRequest" + }, + "output": { + "shape": "ListManagedPoliciesInPermissionSetResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the Amazon Web Services managed policy that is attached to a specified permission set.
" + }, + "ListPermissionSetProvisioningStatus": { + "name": "ListPermissionSetProvisioningStatus", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListPermissionSetProvisioningStatusRequest" + }, + "output": { + "shape": "ListPermissionSetProvisioningStatusResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
" + }, + "ListPermissionSets": { + "name": "ListPermissionSets", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListPermissionSetsRequest" + }, + "output": { + "shape": "ListPermissionSetsResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the PermissionSets in an IAM Identity Center instance.
" + }, + "ListPermissionSetsProvisionedToAccount": { + "name": "ListPermissionSetsProvisionedToAccount", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListPermissionSetsProvisionedToAccountRequest" + }, + "output": { + "shape": "ListPermissionSetsProvisionedToAccountResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
" + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists the tags that are attached to a specified resource.
" + }, + "ListTrustedTokenIssuers": { + "name": "ListTrustedTokenIssuers", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListTrustedTokenIssuersRequest" + }, + "output": { + "shape": "ListTrustedTokenIssuersResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + } + ], + "documentation": "Lists all the trusted token issuers configured in an instance of IAM Identity Center.
" }, "ProvisionPermissionSet": { "name": "ProvisionPermissionSet", @@ -993,10 +1914,76 @@ "requestUri": "/" }, "input": { - "shape": "ProvisionPermissionSetRequest" + "shape": "ProvisionPermissionSetRequest" + }, + "output": { + "shape": "ProvisionPermissionSetResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "The process by which a specified permission set is provisioned to the specified target.
" + }, + "PutApplicationAccessScope": { + "name": "PutApplicationAccessScope", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutApplicationAccessScopeRequest" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
", + "idempotent": true + }, + "PutApplicationAssignmentConfiguration": { + "name": "PutApplicationAssignmentConfiguration", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutApplicationAssignmentConfigurationRequest" }, "output": { - "shape": "ProvisionPermissionSetResponse" + "shape": "PutApplicationAssignmentConfigurationResponse" }, "errors": [ { @@ -1018,7 +2005,72 @@ "shape": "ConflictException" } ], - "documentation": "The process by which a specified permission set is provisioned to the specified target.
" + "documentation": "Configure how users gain access to an application. If AssignmentsRequired
is true
(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false
, all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired
is set to true
.
Adds or updates an authentication method for an application.
", + "idempotent": true + }, + "PutApplicationGrant": { + "name": "PutApplicationGrant", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutApplicationGrantRequest" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Adds a grant to an application.
", + "idempotent": true }, "PutInlinePolicyToPermissionSet": { "name": "PutInlinePolicyToPermissionSet", @@ -1162,6 +2214,71 @@ ], "documentation": "Disassociates a set of tags from a specified resource.
" }, + "UpdateApplication": { + "name": "UpdateApplication", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateApplicationRequest" + }, + "output": { + "shape": "UpdateApplicationResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Updates application properties.
" + }, + "UpdateInstance": { + "name": "UpdateInstance", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateInstanceRequest" + }, + "output": { + "shape": "UpdateInstanceResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
" + }, "UpdateInstanceAccessControlAttributeConfiguration": { "name": "UpdateInstanceAccessControlAttributeConfiguration", "http": { @@ -1229,6 +2346,40 @@ } ], "documentation": "Updates an existing permission set.
" + }, + "UpdateTrustedTokenIssuer": { + "name": "UpdateTrustedTokenIssuer", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateTrustedTokenIssuerRequest" + }, + "output": { + "shape": "UpdateTrustedTokenIssuerResponse" + }, + "errors": [ + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + } + ], + "documentation": "Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.
The assignment that indicates a principal's limited access to a specified Amazon Web Services account with a specified permission set.
The term principal here refers to a user or group that is defined in IAM Identity Center.
The account ID number of the Amazon Web Services account.
" + }, + "PermissionSetArn": { + "shape": "PermissionSetArn", + "documentation": "The ARN of the IAM Identity Center permission set assigned to this principal for this Amazon Web Services account.
" + }, + "PrincipalId": { + "shape": "PrincipalId", + "documentation": "The ID of the principal.
" + }, + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "The type of the principal.
" + } + }, + "documentation": "A structure that describes an assignment of an Amazon Web Services account to a principal and the permissions that principal has in the account.
" + }, "AccountAssignmentList": { "type": "list", "member": { "shape": "AccountAssignment" } }, + "AccountAssignmentListForPrincipal": { + "type": "list", + "member": { + "shape": "AccountAssignmentForPrincipal" + } + }, "AccountAssignmentOperationStatus": { "type": "structure", "members": { @@ -1336,67 +2515,242 @@ }, "PrincipalId": { "shape": "PrincipalId", - "documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + "documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + }, + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "The entity type for which the assignment will be created.
" + }, + "RequestId": { + "shape": "UUId", + "documentation": "The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" + }, + "Status": { + "shape": "StatusValues", + "documentation": "The status of the permission set provisioning process.
" + }, + "TargetId": { + "shape": "TargetId", + "documentation": "TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" + }, + "TargetType": { + "shape": "TargetType", + "documentation": "The entity type for which the assignment will be created.
" + } + }, + "documentation": "The status of the creation or deletion operation of an assignment that a principal needs to access an account.
" + }, + "AccountAssignmentOperationStatusList": { + "type": "list", + "member": { + "shape": "AccountAssignmentOperationStatusMetadata" + } + }, + "AccountAssignmentOperationStatusMetadata": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "Date", + "documentation": "The date that the permission set was created.
" + }, + "RequestId": { + "shape": "UUId", + "documentation": "The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" + }, + "Status": { + "shape": "StatusValues", + "documentation": "The status of the permission set provisioning process.
" + } + }, + "documentation": "Provides information about the AccountAssignment creation request.
" + }, + "AccountId": { + "type": "string", + "max": 12, + "min": 12, + "pattern": "^\\d{12}$" + }, + "AccountList": { + "type": "list", + "member": { + "shape": "AccountId" + } + }, + "ActorPolicyDocument": { + "type": "structure", + "members": {}, + "document": true + }, + "Application": { + "type": "structure", + "members": { + "ApplicationAccount": { + "shape": "AccountId", + "documentation": "The Amazon Web Services account ID number of the application.
" + }, + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "The ARN of the application.
" + }, + "ApplicationProviderArn": { + "shape": "ApplicationProviderArn", + "documentation": "The ARN of the application provider for this application.
" + }, + "CreatedDate": { + "shape": "Date", + "documentation": "The date and time when the application was originally created.
" + }, + "Description": { + "shape": "Description", + "documentation": "The description of the application.
" + }, + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "The ARN of the instance of IAM Identity Center that is configured with this application.
" + }, + "Name": { + "shape": "NameType", + "documentation": "The name of the application.
" + }, + "PortalOptions": { + "shape": "PortalOptions", + "documentation": "A structure that describes the options for the access portal associated with this application.
" + }, + "Status": { + "shape": "ApplicationStatus", + "documentation": "The current status of the application in this instance of IAM Identity Center.
" + } + }, + "documentation": "A structure that describes an application that uses IAM Identity Center for access management.
" + }, + "ApplicationArn": { + "type": "string", + "max": 1224, + "min": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" + }, + "ApplicationAssignment": { + "type": "structure", + "required": [ + "ApplicationArn", + "PrincipalId", + "PrincipalType" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "The ARN of the application that has principals assigned.
" + }, + "PrincipalId": { + "shape": "PrincipalId", + "documentation": "The unique identifier of the principal assigned to the application.
" }, "PrincipalType": { "shape": "PrincipalType", - "documentation": "The entity type for which the assignment will be created.
" - }, - "RequestId": { - "shape": "UUId", - "documentation": "The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" - }, - "Status": { - "shape": "StatusValues", - "documentation": "The status of the permission set provisioning process.
" + "documentation": "The type of the principal assigned to the application.
" + } + }, + "documentation": "A structure that describes an assignment of a principal to an application.
" + }, + "ApplicationAssignmentForPrincipal": { + "type": "structure", + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "The ARN of the application to which the specified principal is assigned.
" }, - "TargetId": { - "shape": "TargetId", - "documentation": "TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" + "PrincipalId": { + "shape": "PrincipalId", + "documentation": "The unique identifier of the principal assigned to the application.
" }, - "TargetType": { - "shape": "TargetType", - "documentation": "The entity type for which the assignment will be created.
" + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "The type of the principal assigned to the application.
" } }, - "documentation": "The status of the creation or deletion operation of an assignment that a principal needs to access an account.
" + "documentation": "A structure that describes an application to which a principal is assigned.
" }, - "AccountAssignmentOperationStatusList": { + "ApplicationAssignmentListForPrincipal": { "type": "list", "member": { - "shape": "AccountAssignmentOperationStatusMetadata" + "shape": "ApplicationAssignmentForPrincipal" } }, - "AccountAssignmentOperationStatusMetadata": { + "ApplicationAssignmentsList": { + "type": "list", + "member": { + "shape": "ApplicationAssignment" + } + }, + "ApplicationList": { + "type": "list", + "member": { + "shape": "Application" + }, + "max": 50, + "min": 0 + }, + "ApplicationProvider": { "type": "structure", + "required": [ + "ApplicationProviderArn" + ], "members": { - "CreatedDate": { - "shape": "Date", - "documentation": "The date that the permission set was created.
" + "ApplicationProviderArn": { + "shape": "ApplicationProviderArn", + "documentation": "The ARN of the application provider.
" }, - "RequestId": { - "shape": "UUId", - "documentation": "The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" + "DisplayData": { + "shape": "DisplayData", + "documentation": "A structure that describes how IAM Identity Center represents the application provider in the portal.
" }, - "Status": { - "shape": "StatusValues", - "documentation": "The status of the permission set provisioning process.
" + "FederationProtocol": { + "shape": "FederationProtocol", + "documentation": "The protocol that the application provider uses to perform federation.
" + }, + "ResourceServerConfig": { + "shape": "ResourceServerConfig", + "documentation": "A structure that describes the application provider's resource server.
" } }, - "documentation": "Provides information about the AccountAssignment creation request.
" + "documentation": "A structure that describes a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.
" }, - "AccountId": { + "ApplicationProviderArn": { "type": "string", - "max": 12, - "min": 12, - "pattern": "^\\d{12}$" + "max": 1224, + "min": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$" }, - "AccountList": { + "ApplicationProviderList": { "type": "list", "member": { - "shape": "AccountId" + "shape": "ApplicationProvider" } }, + "ApplicationStatus": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "ApplicationUrl": { + "type": "string", + "max": 512, + "min": 1, + "pattern": "^http(s)?:\\/\\/[-a-zA-Z0-9+&@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\\/%?=~_|]$" + }, + "ApplicationVisibility": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "AssignmentRequired": { + "type": "boolean", + "box": true + }, "AttachCustomerManagedPolicyReferenceToPermissionSetRequest": { "type": "structure", "required": [ @@ -1469,6 +2823,87 @@ "shape": "AttachedManagedPolicy" } }, + "AuthenticationMethod": { + "type": "structure", + "members": { + "Iam": { + "shape": "IamAuthenticationMethod", + "documentation": "A structure that describes details for IAM authentication.
" + } + }, + "documentation": "A structure that describes an authentication method that can be used by an application.
", + "union": true + }, + "AuthenticationMethodItem": { + "type": "structure", + "members": { + "AuthenticationMethod": { + "shape": "AuthenticationMethod", + "documentation": "A structure that describes an authentication method. The contents of this structure is determined by the AuthenticationMethodType
.
The type of authentication that is used by this method.
" + } + }, + "documentation": "A structure that describes an authentication method and its type.
" + }, + "AuthenticationMethodType": { + "type": "string", + "enum": [ + "IAM" + ] + }, + "AuthenticationMethods": { + "type": "list", + "member": { + "shape": "AuthenticationMethodItem" + } + }, + "AuthorizationCodeGrant": { + "type": "structure", + "members": { + "RedirectUris": { + "shape": "RedirectUris", + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + }, + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + }, + "AuthorizedTokenIssuer": { + "type": "structure", + "members": { + "AuthorizedAudiences": { + "shape": "TokenIssuerAudiences", + "documentation": "An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer.
" + }, + "TrustedTokenIssuerArn": { + "shape": "TrustedTokenIssuerArn", + "documentation": "The ARN of the trusted token issuer.
" + } + }, + "documentation": "A structure that describes a trusted token issuer and associates it with a set of authorized audiences.
" + }, + "AuthorizedTokenIssuers": { + "type": "list", + "member": { + "shape": "AuthorizedTokenIssuer" + }, + "max": 10, + "min": 1 + }, + "ClaimAttributePath": { + "type": "string", + "max": 255, + "min": 1, + "pattern": "^\\p{L}+(?:(\\.|\\_)\\p{L}+){0,2}$" + }, + "ClientToken": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "^[!-~]+$" + }, "CreateAccountAssignmentRequest": { "type": "structure", "required": [ @@ -1515,6 +2950,84 @@ } } }, + "CreateApplicationAssignmentRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "PrincipalId", + "PrincipalType" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "The ARN of the application provider under which the operation will run.
" + }, + "PrincipalId": { + "shape": "PrincipalId", + "documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + }, + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "The entity type for which the assignment will be created.
" + } + } + }, + "CreateApplicationAssignmentResponse": { + "type": "structure", + "members": {} + }, + "CreateApplicationRequest": { + "type": "structure", + "required": [ + "ApplicationProviderArn", + "InstanceArn", + "Name" + ], + "members": { + "ApplicationProviderArn": { + "shape": "ApplicationProviderArn", + "documentation": "The ARN of the application provider under which the operation will run.
" + }, + "ClientToken": { + "shape": "ClientToken", + "documentation": "Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken
, but with different parameters, the retry fails with an IdempotentParameterMismatch
error.
The description of the .
" + }, + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "Name": { + "shape": "NameType", + "documentation": "The name of the .
" + }, + "PortalOptions": { + "shape": "PortalOptions", + "documentation": "A structure that describes the options for the portal associated with an application.
" + }, + "Status": { + "shape": "ApplicationStatus", + "documentation": "Specifies whether the application is enabled or disabled.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "Specifies tags to be attached to the application.
" + } + } + }, + "CreateApplicationResponse": { + "type": "structure", + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application.
" + } + } + }, "CreateInstanceAccessControlAttributeConfigurationRequest": { "type": "structure", "required": [ @@ -1536,6 +3049,33 @@ "type": "structure", "members": {} }, + "CreateInstanceRequest": { + "type": "structure", + "members": { + "ClientToken": { + "shape": "ClientToken", + "documentation": "Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken
, but with different parameters, the retry fails with an IdempotentParameterMismatch
error.
The name of the instance of IAM Identity Center.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "Specifies tags to be attached to the instance of IAM Identity Center.
" + } + } + }, + "CreateInstanceResponse": { + "type": "structure", + "members": { + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "The ARN of the instance of IAM Identity Center under which the operation will run.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + } + } + }, "CreatePermissionSetRequest": { "type": "structure", "required": [ @@ -1578,6 +3118,51 @@ } } }, + "CreateTrustedTokenIssuerRequest": { + "type": "structure", + "required": [ + "InstanceArn", + "Name", + "TrustedTokenIssuerConfiguration", + "TrustedTokenIssuerType" + ], + "members": { + "ClientToken": { + "shape": "ClientToken", + "documentation": "Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken
, but with different parameters, the retry fails with an IdempotentParameterMismatch
error.
Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration.
" + }, + "Name": { + "shape": "TrustedTokenIssuerName", + "documentation": "Specifies the name of the new trusted token issuer configuration.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "Specifies tags to be attached to the new trusted token issuer configuration.
" + }, + "TrustedTokenIssuerConfiguration": { + "shape": "TrustedTokenIssuerConfiguration", + "documentation": "Specifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what TrustedTokenIssuerType
you specify.
Specifies the type of the new trusted token issuer.
" + } + } + }, + "CreateTrustedTokenIssuerResponse": { + "type": "structure", + "members": { + "TrustedTokenIssuerArn": { + "shape": "TrustedTokenIssuerArn", + "documentation": "The ARN of the new trusted token issuer configuration.
" + } + } + }, "CustomerManagedPolicyReference": { "type": "structure", "required": [ @@ -1641,15 +3226,108 @@ } } }, - "DeleteAccountAssignmentResponse": { + "DeleteAccountAssignmentResponse": { + "type": "structure", + "members": { + "AccountAssignmentDeletionStatus": { + "shape": "AccountAssignmentOperationStatus", + "documentation": "The status object for the account assignment deletion operation.
" + } + } + }, + "DeleteApplicationAccessScopeRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "Scope" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application with the access scope to delete.
" + }, + "Scope": { + "shape": "Scope", + "documentation": "Specifies the name of the access scope to remove from the application.
" + } + } + }, + "DeleteApplicationAssignmentRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "PrincipalId", + "PrincipalType" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application.
" + }, + "PrincipalId": { + "shape": "PrincipalId", + "documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + }, + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "The entity type for which the assignment will be deleted.
" + } + } + }, + "DeleteApplicationAssignmentResponse": { + "type": "structure", + "members": {} + }, + "DeleteApplicationAuthenticationMethodRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "AuthenticationMethodType" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application with the authentication method to delete.
" + }, + "AuthenticationMethodType": { + "shape": "AuthenticationMethodType", + "documentation": "Specifies the authentication method type to delete from the application.
" + } + } + }, + "DeleteApplicationGrantRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "GrantType" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application with the grant to delete.
" + }, + "GrantType": { + "shape": "GrantType", + "documentation": "Specifies the type of grant to delete from the application.
" + } + } + }, + "DeleteApplicationRequest": { "type": "structure", + "required": [ + "ApplicationArn" + ], "members": { - "AccountAssignmentDeletionStatus": { - "shape": "AccountAssignmentOperationStatus", - "documentation": "The status object for the account assignment deletion operation.
" + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" } } }, + "DeleteApplicationResponse": { + "type": "structure", + "members": {} + }, "DeleteInlinePolicyFromPermissionSetRequest": { "type": "structure", "required": [ @@ -1687,6 +3365,22 @@ "type": "structure", "members": {} }, + "DeleteInstanceRequest": { + "type": "structure", + "required": [ + "InstanceArn" + ], + "members": { + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "The ARN of the instance of IAM Identity Center under which the operation will run.
" + } + } + }, + "DeleteInstanceResponse": { + "type": "structure", + "members": {} + }, "DeletePermissionSetRequest": { "type": "structure", "required": [ @@ -1729,6 +3423,22 @@ "type": "structure", "members": {} }, + "DeleteTrustedTokenIssuerRequest": { + "type": "structure", + "required": [ + "TrustedTokenIssuerArn" + ], + "members": { + "TrustedTokenIssuerArn": { + "shape": "TrustedTokenIssuerArn", + "documentation": "Specifies the ARN of the trusted token issuer configuration to delete.
" + } + } + }, + "DeleteTrustedTokenIssuerResponse": { + "type": "structure", + "members": {} + }, "DescribeAccountAssignmentCreationStatusRequest": { "type": "structure", "required": [ @@ -1781,6 +3491,134 @@ } } }, + "DescribeApplicationAssignmentRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "PrincipalId", + "PrincipalType" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "PrincipalId": { + "shape": "PrincipalId", + "documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + }, + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "The entity type for which the assignment will be created.
" + } + } + }, + "DescribeApplicationAssignmentResponse": { + "type": "structure", + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "PrincipalId": { + "shape": "PrincipalId", + "documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + }, + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "The entity type for which the assignment will be created.
" + } + } + }, + "DescribeApplicationProviderRequest": { + "type": "structure", + "required": [ + "ApplicationProviderArn" + ], + "members": { + "ApplicationProviderArn": { + "shape": "ApplicationProviderArn", + "documentation": "Specifies the ARN of the application provider for which you want details.
" + } + } + }, + "DescribeApplicationProviderResponse": { + "type": "structure", + "required": [ + "ApplicationProviderArn" + ], + "members": { + "ApplicationProviderArn": { + "shape": "ApplicationProviderArn", + "documentation": "The ARN of the application provider.
" + }, + "DisplayData": { + "shape": "DisplayData", + "documentation": "A structure with details about the display data for the application provider.
" + }, + "FederationProtocol": { + "shape": "FederationProtocol", + "documentation": "The protocol used to federate to the application provider.
" + }, + "ResourceServerConfig": { + "shape": "ResourceServerConfig", + "documentation": "A structure with details about the receiving application.
" + } + } + }, + "DescribeApplicationRequest": { + "type": "structure", + "required": [ + "ApplicationArn" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + } + } + }, + "DescribeApplicationResponse": { + "type": "structure", + "members": { + "ApplicationAccount": { + "shape": "AccountId", + "documentation": "The account ID.
" + }, + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application.
" + }, + "ApplicationProviderArn": { + "shape": "ApplicationProviderArn", + "documentation": "The ARN of the application provider under which the operation will run.
" + }, + "CreatedDate": { + "shape": "Date", + "documentation": "The date the application was created.
" + }, + "Description": { + "shape": "Description", + "documentation": "The description of the .
" + }, + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "Name": { + "shape": "NameType", + "documentation": "The application name.
" + }, + "PortalOptions": { + "shape": "PortalOptions", + "documentation": "A structure that describes the options for the portal associated with an application.
" + }, + "Status": { + "shape": "ApplicationStatus", + "documentation": "Specifies whether the application is enabled or disabled.
" + } + } + }, "DescribeInstanceAccessControlAttributeConfigurationRequest": { "type": "structure", "required": [ @@ -1810,6 +3648,47 @@ } } }, + "DescribeInstanceRequest": { + "type": "structure", + "required": [ + "InstanceArn" + ], + "members": { + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "The ARN of the instance of IAM Identity Center under which the operation will run.
" + } + } + }, + "DescribeInstanceResponse": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "Date", + "documentation": "The date the instance was created.
" + }, + "IdentityStoreId": { + "shape": "Id", + "documentation": "The identifier of the identity store that is connected to the instance of IAM Identity Center.
" + }, + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "Name": { + "shape": "NameType", + "documentation": "Specifies the instance name.
" + }, + "OwnerAccountId": { + "shape": "AccountId", + "documentation": "The identifier of the Amazon Web Services account for which the instance was created.
" + }, + "Status": { + "shape": "InstanceStatus", + "documentation": "The status of the instance.
" + } + } + }, "DescribePermissionSetProvisioningStatusRequest": { "type": "structure", "required": [ @@ -1862,6 +3741,44 @@ } } }, + "DescribeTrustedTokenIssuerRequest": { + "type": "structure", + "required": [ + "TrustedTokenIssuerArn" + ], + "members": { + "TrustedTokenIssuerArn": { + "shape": "TrustedTokenIssuerArn", + "documentation": "Specifies the ARN of the trusted token issuer configuration that you want details about.
" + } + } + }, + "DescribeTrustedTokenIssuerResponse": { + "type": "structure", + "members": { + "Name": { + "shape": "TrustedTokenIssuerName", + "documentation": "The name of the trusted token issuer configuration.
" + }, + "TrustedTokenIssuerArn": { + "shape": "TrustedTokenIssuerArn", + "documentation": "The ARN of the trusted token issuer configuration.
" + }, + "TrustedTokenIssuerConfiguration": { + "shape": "TrustedTokenIssuerConfiguration", + "documentation": "A structure the describes the settings that apply of this trusted token issuer.
" + }, + "TrustedTokenIssuerType": { + "shape": "TrustedTokenIssuerType", + "documentation": "The type of the trusted token issuer.
" + } + } + }, + "Description": { + "type": "string", + "max": 128, + "min": 1 + }, "DetachCustomerManagedPolicyReferenceFromPermissionSetRequest": { "type": "structure", "required": [ @@ -1914,12 +3831,149 @@ "type": "structure", "members": {} }, + "DisplayData": { + "type": "structure", + "members": { + "Description": { + "shape": "Description", + "documentation": "The description of the application provider that appears in the portal.
" + }, + "DisplayName": { + "shape": "Name", + "documentation": "The name of the application provider that appears in the portal.
" + }, + "IconUrl": { + "shape": "IconUrl", + "documentation": "A URL that points to an icon that represents the application provider.
" + } + }, + "documentation": "A structure that describes how the portal represents an application provider.
" + }, "Duration": { "type": "string", "max": 100, "min": 1, "pattern": "^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$" }, + "FederationProtocol": { + "type": "string", + "enum": [ + "SAML", + "OAUTH" + ] + }, + "GetApplicationAccessScopeRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "Scope" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application with the access scope that you want to retrieve.
" + }, + "Scope": { + "shape": "Scope", + "documentation": "Specifies the name of the access scope for which you want the authorized targets.
" + } + } + }, + "GetApplicationAccessScopeResponse": { + "type": "structure", + "required": [ + "Scope" + ], + "members": { + "AuthorizedTargets": { + "shape": "ScopeTargets", + "documentation": "An array of authorized targets associated with this access scope.
" + }, + "Scope": { + "shape": "Scope", + "documentation": "The name of the access scope that can be used with the authorized targets.
" + } + } + }, + "GetApplicationAssignmentConfigurationRequest": { + "type": "structure", + "required": [ + "ApplicationArn" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + } + } + }, + "GetApplicationAssignmentConfigurationResponse": { + "type": "structure", + "required": [ + "AssignmentRequired" + ], + "members": { + "AssignmentRequired": { + "shape": "AssignmentRequired", + "documentation": "If AssignmentsRequired
is true
(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false
, all users have access to the application.
Specifies the ARN of the application.
" + }, + "AuthenticationMethodType": { + "shape": "AuthenticationMethodType", + "documentation": "Specifies the type of authentication method for which you want details.
" + } + } + }, + "GetApplicationAuthenticationMethodResponse": { + "type": "structure", + "members": { + "AuthenticationMethod": { + "shape": "AuthenticationMethod", + "documentation": "A structure that contains details about the requested authentication method.
" + } + } + }, + "GetApplicationGrantRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "GrantType" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application that contains the grant.
" + }, + "GrantType": { + "shape": "GrantType", + "documentation": "Specifies the type of grant.
" + } + } + }, + "GetApplicationGrantResponse": { + "type": "structure", + "required": [ + "Grant" + ], + "members": { + "Grant": { + "shape": "Grant", + "documentation": "A structure that describes the requested grant.
" + } + } + }, "GetInlinePolicyForPermissionSetRequest": { "type": "structure", "required": [ @@ -1963,14 +4017,81 @@ } } }, - "GetPermissionsBoundaryForPermissionSetResponse": { + "GetPermissionsBoundaryForPermissionSetResponse": { + "type": "structure", + "members": { + "PermissionsBoundary": { + "shape": "PermissionsBoundary", + "documentation": "The permissions boundary attached to the specified permission set.
" + } + } + }, + "Grant": { + "type": "structure", + "members": { + "AuthorizationCode": { + "shape": "AuthorizationCodeGrant", + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + }, + "JwtBearer": { + "shape": "JwtBearerGrant", + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + }, + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
", + "union": true + }, + "GrantItem": { + "type": "structure", + "required": [ + "Grant", + "GrantType" + ], + "members": { + "Grant": { + "shape": "Grant", + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + }, + "GrantType": { + "shape": "GrantType", + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + }, + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + }, + "GrantType": { + "type": "string", + "enum": [ + "authorization_code", + "refresh_token", + "urn:ietf:params:oauth:grant-type:jwt-bearer", + "urn:ietf:params:oauth:grant-type:token-exchange" + ] + }, + "Grants": { + "type": "list", + "member": { + "shape": "GrantItem" + } + }, + "IamAuthenticationMethod": { "type": "structure", + "required": [ + "ActorPolicy" + ], "members": { - "PermissionsBoundary": { - "shape": "PermissionsBoundary", - "documentation": "The permissions boundary attached to the specified permission set.
" + "ActorPolicy": { + "shape": "ActorPolicyDocument", + "documentation": "An IAM policy document in JSON.
" } - } + }, + "documentation": "A structure that describes details for authentication that uses IAM.
" + }, + "IconUrl": { + "type": "string", + "max": 768, + "min": 1, + "pattern": "^(http|https):\\/\\/.*$" }, "Id": { "type": "string", @@ -2012,22 +4133,70 @@ "type": "list", "member": { "shape": "InstanceMetadata" - } + }, + "max": 10, + "min": 0 }, "InstanceMetadata": { "type": "structure", "members": { + "CreatedDate": { + "shape": "Date", + "documentation": "The date and time that the Identity Center instance was created.
" + }, "IdentityStoreId": { "shape": "Id", - "documentation": "The identifier of the identity store that is connected to the IAM Identity Center instance.
" + "documentation": "The identifier of the identity store that is connected to the Identity Center instance.
" }, "InstanceArn": { "shape": "InstanceArn", - "documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + "documentation": "The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "Name": { + "shape": "NameType", + "documentation": "The name of the Identity Center instance.
" + }, + "OwnerAccountId": { + "shape": "AccountId", + "documentation": "The Amazon Web Services account ID number of the owner of the Identity Center instance.
" + }, + "Status": { + "shape": "InstanceStatus", + "documentation": "The current status of this Identity Center instance.
" } }, "documentation": "Provides information about the IAM Identity Center instance.
" }, + "InstanceStatus": { + "type": "string", + "enum": [ + "CREATE_IN_PROGRESS", + "DELETE_IN_PROGRESS", + "ACTIVE" + ] + }, + "JMESPath": { + "type": "string", + "max": 255, + "min": 1, + "pattern": "^\\p{L}+(?:\\.\\p{L}+){0,2}$" + }, + "JwksRetrievalOption": { + "type": "string", + "enum": [ + "OPEN_ID_DISCOVERY" + ] + }, + "JwtBearerGrant": { + "type": "structure", + "members": { + "AuthorizedTokenIssuers": { + "shape": "AuthorizedTokenIssuers", + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + }, + "documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + }, "ListAccountAssignmentCreationStatusRequest": { "type": "structure", "required": [ @@ -2102,6 +4271,63 @@ } } }, + "ListAccountAssignmentsFilter": { + "type": "structure", + "members": { + "AccountId": { + "shape": "AccountId", + "documentation": "The ID number of an Amazon Web Services account that filters the results in the response.
" + } + }, + "documentation": "A structure that describes a filter for account assignments.
" + }, + "ListAccountAssignmentsForPrincipalRequest": { + "type": "structure", + "required": [ + "InstanceArn", + "PrincipalId", + "PrincipalType" + ], + "members": { + "Filter": { + "shape": "ListAccountAssignmentsFilter", + "documentation": "Specifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number.
" + }, + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "Specifies the ARN of the instance of IAM Identity Center that contains the principal.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken
response element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken
response to request the next page of results.
Specifies the principal for which you want to retrieve the list of account assignments.
" + }, + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "Specifies the type of the principal.
" + } + } + }, + "ListAccountAssignmentsForPrincipalResponse": { + "type": "structure", + "members": { + "AccountAssignments": { + "shape": "AccountAssignmentListForPrincipal", + "documentation": "An array list of the account assignments for the principal.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the last page of results.
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + "documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + } + } + }, + "ListApplicationAccessScopesRequest": { + "type": "structure", + "required": [ + "ApplicationArn" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application.
" + }, + "MaxResults": { + "shape": "ListApplicationAccessScopesRequestMaxResultsInteger", + "documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken
response element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken
response to request the next page of results.
If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the last page of results.
An array list of access scopes and their authorized targets that are associated with the application.
" + } + } + }, + "ListApplicationAssignmentsFilter": { + "type": "structure", + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "The ARN of an application.
" + } + }, + "documentation": "A structure that describes a filter for application assignments.
" + }, + "ListApplicationAssignmentsForPrincipalRequest": { + "type": "structure", + "required": [ + "InstanceArn", + "PrincipalId", + "PrincipalType" + ], + "members": { + "Filter": { + "shape": "ListApplicationAssignmentsFilter", + "documentation": "Filters the output to include only assignments associated with the application that has the specified ARN.
" + }, + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "Specifies the instance of IAM Identity Center that contains principal and applications.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken
response element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken
response to request the next page of results.
Specifies the unique identifier of the principal for which you want to retrieve its assignments.
" + }, + "PrincipalType": { + "shape": "PrincipalType", + "documentation": "Specifies the type of the principal for which you want to retrieve its assignments.
" + } + } + }, + "ListApplicationAssignmentsForPrincipalResponse": { + "type": "structure", + "members": { + "ApplicationAssignments": { + "shape": "ApplicationAssignmentListForPrincipal", + "documentation": "An array list of the application assignments for the specified principal.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the last page of results.
Specifies the ARN of the application.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken
response element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken
response to request the next page of results.
The list of users assigned to an application.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the last page of results.
Specifies the ARN of the application with the authentication methods you want to list.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken
response to request the next page of results.
An array list of authentication methods for the specified application.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the last page of results.
Specifies the ARN of the application whose grants you want to list.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken
response to request the next page of results.
An array list of structures that describe the requested grants.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the last page of results.
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken
response element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken
response to request the next page of results.
An array list of structures that describe application providers.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the last page of results.
An Amazon Web Services account ID number that filters the results in the response.
" + }, + "ApplicationProvider": { + "shape": "ApplicationProviderArn", + "documentation": "The ARN of an application provider that can filter the results in the response.
" + } + }, + "documentation": "A structure that describes a filter for applications.
" + }, + "ListApplicationsRequest": { + "type": "structure", + "required": [ + "InstanceArn" + ], + "members": { + "Filter": { + "shape": "ListApplicationsFilter", + "documentation": "Filters response results.
" + }, + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken
response element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken
response to request the next page of results.
Retrieves all applications associated with the instance.
" + }, + "NextToken": { + "shape": "Token", + "documentation": "If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the last page of results.
Specifies the ARN of the instance of IAM Identity Center with the trusted token issuer configurations that you want to list.
" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken
response element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken
response to request the next page of results.
If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the last page of results.
An array list of the trusted token issuer configurations.
" + } + } + }, "ManagedPolicyArn": { "type": "string", "max": 2048, @@ -2464,6 +4992,58 @@ "max": 100, "min": 1 }, + "NameType": { + "type": "string", + "max": 255, + "min": 0, + "pattern": "^[\\w+=,.@-]+$" + }, + "OidcJwtConfiguration": { + "type": "structure", + "required": [ + "ClaimAttributePath", + "IdentityStoreAttributePath", + "IssuerUrl", + "JwksRetrievalOption" + ], + "members": { + "ClaimAttributePath": { + "shape": "ClaimAttributePath", + "documentation": "The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath
when a trusted token issuer token is exchanged for an IAM Identity Center token.
The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath
when a trusted token issuer token is exchanged for an IAM Identity Center token.
The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.
" + }, + "JwksRetrievalOption": { + "shape": "JwksRetrievalOption", + "documentation": "The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.
" + } + }, + "documentation": "A structure that describes configuration settings for a trusted token issuer that supports OpenID Connect (OIDC) and JSON Web Tokens (JWTs).
" + }, + "OidcJwtUpdateConfiguration": { + "type": "structure", + "members": { + "ClaimAttributePath": { + "shape": "ClaimAttributePath", + "documentation": "The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath
when a trusted token issuer token is exchanged for an IAM Identity Center token.
The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath
when a trusted token issuer token is exchanged for an IAM Identity Center token.
The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.
" + } + }, + "documentation": "A structure that describes updated configuration settings for a trusted token issuer that supports OpenID Connect (OIDC) and JSON Web Tokens (JWTs).
" + }, "OperationStatusFilter": { "type": "structure", "members": { @@ -2472,7 +5052,7 @@ "documentation": "Filters the list operations result based on the status attribute.
" } }, - "documentation": "Filters he operation status list based on the passed attribute value.
" + "documentation": "Filters the operation status list based on the passed attribute value.
" }, "PermissionSet": { "type": "structure", @@ -2602,6 +5182,20 @@ }, "documentation": "Specifies the configuration of the Amazon Web Services managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference
to use the name and path of a customer managed policy, or ManagedPolicyArn
to use the ARN of an Amazon Web Services managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide.
Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
A structure that describes the sign-in options for the access portal.
" + }, + "Visibility": { + "shape": "ApplicationVisibility", + "documentation": "Indicates whether this application is visible in the access portal.
" + } + }, + "documentation": "A structure that describes the options for the access portal associated with an application.
" + }, "PrincipalId": { "type": "string", "max": 47, @@ -2664,6 +5258,92 @@ "LATEST_PERMISSION_SET_NOT_PROVISIONED" ] }, + "PutApplicationAccessScopeRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "Scope" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application with the access scope with the targets to add or update.
" + }, + "AuthorizedTargets": { + "shape": "ScopeTargets", + "documentation": "Specifies an array list of ARNs that represent the authorized targets for this access scope.
" + }, + "Scope": { + "shape": "Scope", + "documentation": "Specifies the name of the access scope to be associated with the specified targets.
" + } + } + }, + "PutApplicationAssignmentConfigurationRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "AssignmentRequired" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "AssignmentRequired": { + "shape": "AssignmentRequired", + "documentation": "If AssignmentsRequired
is true
(default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false
, all users have access to the application.
Specifies the ARN of the application with the authentication method to add or update.
" + }, + "AuthenticationMethod": { + "shape": "AuthenticationMethod", + "documentation": "Specifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the AuthenticationMethodType
parameter.
Specifies the type of the authentication method that you want to add or update.
" + } + } + }, + "PutApplicationGrantRequest": { + "type": "structure", + "required": [ + "ApplicationArn", + "Grant", + "GrantType" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application to update.
" + }, + "Grant": { + "shape": "Grant", + "documentation": "Specifies a structure that describes the grant to update.
" + }, + "GrantType": { + "shape": "GrantType", + "documentation": "Specifies the type of grant to update.
" + } + } + }, "PutInlinePolicyToPermissionSetRequest": { "type": "structure", "required": [ @@ -2720,12 +5400,126 @@ "type": "string", "pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" }, + "RedirectUris": { + "type": "list", + "member": { + "shape": "URI" + }, + "max": 10, + "min": 1 + }, "RelayState": { "type": "string", "max": 240, "min": 1, "pattern": "^[a-zA-Z0-9&$@#\\\\\\/%?=~\\-_'\"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+$" }, + "ResourceServerConfig": { + "type": "structure", + "members": { + "Scopes": { + "shape": "ResourceServerScopes", + "documentation": "A list of the IAM Identity Center access scopes that are associated with this resource server.
" + } + }, + "documentation": "A structure that describes the configuration of a resource server.
" + }, + "ResourceServerScope": { + "type": "string", + "max": 80, + "min": 1, + "pattern": "^[^:=\\-\\.\\s][0-9a-zA-Z_:\\-\\.]+$" + }, + "ResourceServerScopeDetails": { + "type": "structure", + "members": { + "DetailedTitle": { + "shape": "Description", + "documentation": "The title of an access scope for a resource server.
" + }, + "LongDescription": { + "shape": "Description", + "documentation": "The description of an access scope for a resource server.
" + } + }, + "documentation": "A structure that describes details for an IAM Identity Center access scope that is associated with a resource server.
" + }, + "ResourceServerScopes": { + "type": "map", + "key": { + "shape": "ResourceServerScope" + }, + "value": { + "shape": "ResourceServerScopeDetails" + } + }, + "Scope": { + "type": "string", + "pattern": "^([A-Za-z0-9_]{1,50})(:[A-Za-z0-9_]{1,50}){0,1}(:[A-Za-z0-9_]{1,50}){0,1}$" + }, + "ScopeDetails": { + "type": "structure", + "required": [ + "Scope" + ], + "members": { + "AuthorizedTargets": { + "shape": "ScopeTargets", + "documentation": "An array list of ARNs of applications.
" + }, + "Scope": { + "shape": "Scope", + "documentation": "The name of the access scope.
" + } + }, + "documentation": "A structure that describes an IAM Identity Center access scope and its authorized targets.
" + }, + "ScopeTarget": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}|:instance/(sso)?ins-[a-zA-Z0-9-.]{16})$" + }, + "ScopeTargets": { + "type": "list", + "member": { + "shape": "ScopeTarget" + }, + "max": 10, + "min": 1 + }, + "Scopes": { + "type": "list", + "member": { + "shape": "ScopeDetails" + }, + "max": 10, + "min": 0 + }, + "SignInOptions": { + "type": "structure", + "required": [ + "Origin" + ], + "members": { + "ApplicationUrl": { + "shape": "ApplicationUrl", + "documentation": "The URL that accepts authentication requests for an application. This is a required parameter if the Origin
parameter is APPLICATION
.
This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:
APPLICATION
: IAM Identity Center redirects the customer to the configured ApplicationUrl
.
IDENTITY_CENTER
: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.
A structure that describes the sign-in options for an application portal.
" + }, + "SignInOrigin": { + "type": "string", + "enum": [ + "IDENTITY_CENTER", + "APPLICATION" + ] + }, "StatusValues": { "type": "string", "enum": [ @@ -2763,7 +5557,7 @@ "member": { "shape": "TagKey" }, - "max": 50, + "max": 75, "min": 1 }, "TagList": { @@ -2771,13 +5565,12 @@ "member": { "shape": "Tag" }, - "max": 50, + "max": 75, "min": 0 }, "TagResourceRequest": { "type": "structure", "required": [ - "InstanceArn", "ResourceArn", "Tags" ], @@ -2810,7 +5603,7 @@ "type": "string", "max": 2048, "min": 10, - "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}$" + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::((:instance/(sso)?ins-[a-zA-Z0-9-.]{16})|(:permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16})|(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16})|(\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}))$" }, "TargetId": { "type": "string", @@ -2830,6 +5623,92 @@ "min": 0, "pattern": "^[-a-zA-Z0-9+=/_]*$" }, + "TokenIssuerAudience": { + "type": "string", + "max": 512, + "min": 1 + }, + "TokenIssuerAudiences": { + "type": "list", + "member": { + "shape": "TokenIssuerAudience" + }, + "max": 10, + "min": 1 + }, + "TrustedTokenIssuerArn": { + "type": "string", + "max": 1224, + "min": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "TrustedTokenIssuerConfiguration": { + "type": "structure", + "members": { + "OidcJwtConfiguration": { + "shape": "OidcJwtConfiguration", + "documentation": "A structure that describes the settings for a trusted token issuer that works with OpenID Connect (OIDC) by using JSON Web Tokens (JWT).
" + } + }, + "documentation": "A structure that describes the configuration of a trusted token issuer. The structure and available settings are determined by the type of the trusted token issuer.
", + "union": true + }, + "TrustedTokenIssuerList": { + "type": "list", + "member": { + "shape": "TrustedTokenIssuerMetadata" + } + }, + "TrustedTokenIssuerMetadata": { + "type": "structure", + "members": { + "Name": { + "shape": "TrustedTokenIssuerName", + "documentation": "The name of the trusted token issuer configuration in the instance of IAM Identity Center.
" + }, + "TrustedTokenIssuerArn": { + "shape": "TrustedTokenIssuerArn", + "documentation": "The ARN of the trusted token issuer configuration in the instance of IAM Identity Center.
" + }, + "TrustedTokenIssuerType": { + "shape": "TrustedTokenIssuerType", + "documentation": "The type of trusted token issuer.
" + } + }, + "documentation": "A structure that describes a trusted token issuer.
" + }, + "TrustedTokenIssuerName": { + "type": "string", + "max": 255, + "min": 1, + "pattern": "^[\\w+=,.@-]+$" + }, + "TrustedTokenIssuerType": { + "type": "string", + "enum": [ + "OIDC_JWT" + ] + }, + "TrustedTokenIssuerUpdateConfiguration": { + "type": "structure", + "members": { + "OidcJwtConfiguration": { + "shape": "OidcJwtUpdateConfiguration", + "documentation": "A structure that describes an updated configuration for a trusted token issuer that uses OpenID Connect (OIDC) with JSON web tokens (JWT).
" + } + }, + "documentation": "A structure that contains details to be updated for a trusted token issuer configuration. The structure and settings that you can include depend on the type of the trusted token issuer being updated.
", + "union": true + }, + "TrustedTokenIssuerUrl": { + "type": "string", + "max": 512, + "min": 1, + "pattern": "^https?:\\/\\/[-a-zA-Z0-9+&@\\/%=~_|!:,.;]*[-a-zA-Z0-9+&@\\/%=~_|]$" + }, + "URI": { + "type": "string" + }, "UUId": { "type": "string", "max": 36, @@ -2839,7 +5718,6 @@ "UntagResourceRequest": { "type": "structure", "required": [ - "InstanceArn", "ResourceArn", "TagKeys" ], @@ -2862,6 +5740,47 @@ "type": "structure", "members": {} }, + "UpdateApplicationPortalOptions": { + "type": "structure", + "members": { + "SignInOptions": { + "shape": "SignInOptions" + } + }, + "documentation": "" + }, + "UpdateApplicationRequest": { + "type": "structure", + "required": [ + "ApplicationArn" + ], + "members": { + "ApplicationArn": { + "shape": "ApplicationArn", + "documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "Description": { + "shape": "Description", + "documentation": "The description of the .
" + }, + "Name": { + "shape": "NameType", + "documentation": "Specifies the updated name for the application.
" + }, + "PortalOptions": { + "shape": "UpdateApplicationPortalOptions", + "documentation": "A structure that describes the options for the portal associated with an application.
" + }, + "Status": { + "shape": "ApplicationStatus", + "documentation": "Specifies whether the application is enabled or disabled.
" + } + } + }, + "UpdateApplicationResponse": { + "type": "structure", + "members": {} + }, "UpdateInstanceAccessControlAttributeConfigurationRequest": { "type": "structure", "required": [ @@ -2883,6 +5802,27 @@ "type": "structure", "members": {} }, + "UpdateInstanceRequest": { + "type": "structure", + "required": [ + "InstanceArn", + "Name" + ], + "members": { + "InstanceArn": { + "shape": "InstanceArn", + "documentation": "The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "Name": { + "shape": "NameType", + "documentation": "Updates the instance name.
" + } + } + }, + "UpdateInstanceResponse": { + "type": "structure", + "members": {} + }, "UpdatePermissionSetRequest": { "type": "structure", "required": [ @@ -2915,6 +5855,30 @@ "UpdatePermissionSetResponse": { "type": "structure", "members": {} + }, + "UpdateTrustedTokenIssuerRequest": { + "type": "structure", + "required": [ + "TrustedTokenIssuerArn" + ], + "members": { + "Name": { + "shape": "TrustedTokenIssuerName", + "documentation": "Specifies the updated name to be applied to the trusted token issuer configuration.
" + }, + "TrustedTokenIssuerArn": { + "shape": "TrustedTokenIssuerArn", + "documentation": "Specifies the ARN of the trusted token issuer configuration that you want to update.
" + }, + "TrustedTokenIssuerConfiguration": { + "shape": "TrustedTokenIssuerUpdateConfiguration", + "documentation": "Specifies a structure with settings to apply to the specified trusted token issuer. The settings that you can provide are determined by the type of the trusted token issuer that you are updating.
" + } + } + }, + "UpdateTrustedTokenIssuerResponse": { + "type": "structure", + "members": {} } }, "documentation": "IAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size and type.
IAM Identity Center uses the sso
and identitystore
API namespaces.
This reference guide provides information on single sign-on operations which could be used for access management of Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server
call. For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to FILE
if you want a mapping to have a file target.
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server
call. For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to FILE
if you want a mapping to have a file target.
Describes the properties of a file transfer protocol-enabled server that was specified.
" @@ -3398,6 +3406,14 @@ "min": 12, "pattern": "d-[0-9a-f]{10}" }, + "DirectoryListingOptimization": { + "type": "string", + "documentation": "Indicates whether optimization to directory listing on S3 servers is used. Disabled by default for compatibility.
", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, "Domain": { "type": "string", "enum": [ @@ -3617,7 +3633,7 @@ "type": "string", "max": 1024, "min": 0, - "pattern": "$|/.*" + "pattern": "(|/.*)" }, "HomeDirectoryMapEntry": { "type": "structure", @@ -3632,7 +3648,11 @@ }, "Target": { "shape": "MapTarget", - "documentation": "Represents the map target that is used in a HomeDirectorymapEntry
.
Represents the map target that is used in a HomeDirectoryMapEntry
.
Specifies the type of mapping. Set the type to FILE
if you want the mapping to point to a file, or DIRECTORY
for the directory to point to a directory.
By default, home directory mappings have a Type
of DIRECTORY
when you create a Transfer Family server. You would need to explicitly set Type
to FILE
if you want a mapping to have a file target.
Represents an object that contains entries and targets for HomeDirectoryMappings
.
The following is an Entry
and Target
pair example for chroot
.
[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to FILE
if you want a mapping to have a file target.
The Amazon S3 storage options that are configured for your server.
" + }, "S3Tag": { "type": "structure", "required": [ @@ -5767,6 +5804,10 @@ "StructuredLogDestinations": { "shape": "StructuredLogDestinations", "documentation": "Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server
call. For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to FILE
if you want a mapping to have a file target.