The traffic sources associated with this Auto Scaling group.
" } + }, + "InstanceMaintenancePolicy": { + "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", + "traits": { + "smithy.api#documentation": "An instance maintenance policy.
" + } } }, "traits": { @@ -2498,14 +2504,14 @@ "VirtualName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the instance store volume (virtual device) to attach to an instance at\n launch. The name must be in the form ephemeralX where\n X is a number starting from zero (0), for example,\n ephemeral0.
The name of the instance store volume (virtual device) to attach to an instance at\n launch. The name must be in the form ephemeralX where\n X is a number starting from zero (0), for example,\n ephemeral0.
The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n instances in the Amazon EC2 User Guide for Linux Instances.
To define a block device mapping, set the device name and exactly one of the\n following properties: Ebs, NoDevice, or\n VirtualName.
The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n instances in the Amazon EC2 User Guide for Linux Instances.
To define a block device mapping, set the device name and exactly one of the\n following properties: Ebs, NoDevice, or\n VirtualName.
The list of traffic sources to attach to this Auto Scaling group. You can use any of the\n following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and\n VPC Lattice.
" } + }, + "InstanceMaintenancePolicy": { + "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", + "traits": { + "smithy.api#documentation": "An instance maintenance policy. For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.
" + } } } }, @@ -3008,7 +3020,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
\nAmazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
\nCreates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
\nAmazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
\nThe ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
\nIf you specify InstanceId, an ImageId is not\n required.
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
\nIf you specify InstanceId, an ImageId is not\n required.
The name of the key pair. For more information, see Amazon EC2 key pairs and Linux\n instances in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The name of the key pair. For more information, see Amazon EC2 key pairs and Linux\n instances in the Amazon EC2 User Guide for Linux Instances.
" } }, "SecurityGroups": { "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { - "smithy.api#documentation": "A list that contains the security group IDs to assign to the instances in the Auto Scaling\n group. For more information, see Control traffic to\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.
" + "smithy.api#documentation": "A list that contains the security group IDs to assign to the instances in the Auto Scaling\n group. For more information, see Control traffic to\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.
" } }, "ClassicLinkVPCId": { @@ -3070,13 +3082,13 @@ "UserData": { "target": "com.amazonaws.autoscaling#XmlStringUserData", "traits": { - "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" + "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" } }, "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.
\nTo create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.
\nFor more information, see Creating a launch\n configuration using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.
\nTo create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.
\nFor more information, see Creating a launch\n configuration using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "InstanceType": { @@ -3088,13 +3100,13 @@ "KernelId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The ID of the kernel associated with the AMI.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.
\nThe ID of the kernel associated with the AMI.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.
\nThe ID of the RAM disk to select.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.
\nThe ID of the RAM disk to select.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.
\nThe maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Range: Minimum value of 0.001
\nWhen you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.
\nThe maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Range: Minimum value of 0.001
\nWhen you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.
\nSpecifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.
\nIf you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.
\nIf you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated. For more information,\n see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
Valid values: default | dedicated\n
The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated. For more information,\n see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
Valid values: default | dedicated\n
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" } } } @@ -5567,7 +5579,7 @@ "VolumeType": { "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType", "traits": { - "smithy.api#documentation": "The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide for Linux Instances.
\nValid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n
The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide for Linux Instances.
\nValid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n
The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for Instances\n built on the Nitro System. Other instance families guarantee performance up\n to 32,000 IOPS.
\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)
The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for Instances\n built on the Nitro System. Other instance families guarantee performance up\n to 32,000 IOPS.
\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.
\nIf you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.
\nFor more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.
\nSpecifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.
\nIf you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.
\nFor more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.
\nSpecifies the lower threshold as a percentage of the desired capacity of the Auto Scaling\n group. It represents the minimum percentage of the group to keep in service, healthy,\n and ready to use to support your workload when replacing instances. Value range is 0 to\n 100. After it's set, a value of -1 will clear the previously set\n value.
Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling\n group. It represents the maximum percentage of the group that can be in service and\n healthy, or pending, to support your workload when replacing instances. Value range is\n 100 to 200. After it's set, a value of -1 will clear the previously set\n value.
Both MinHealthyPercentage and MaxHealthyPercentage must be\n specified, and the difference between them cannot be greater than 100. A large range\n increases the number of instances that can be replaced at the same time.
Describes an instance maintenance policy.
\nFor more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.
" + } + }, "com.amazonaws.autoscaling#InstanceMetadataEndpointState": { "type": "enum", "members": { @@ -6738,6 +6770,33 @@ } } }, + "com.amazonaws.autoscaling#IntPercent100To200": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 100, + "max": 200 + } + } + }, + "com.amazonaws.autoscaling#IntPercent100To200Resettable": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 200 + } + } + }, + "com.amazonaws.autoscaling#IntPercentResettable": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 100 + } + } + }, "com.amazonaws.autoscaling#InvalidNextToken": { "type": "structure", "members": { @@ -6796,20 +6855,20 @@ "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
", "smithy.api#required": {} } }, "KeyName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the key pair.
\nFor more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The name of the key pair.
\nFor more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.
" } }, "SecurityGroups": { "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { - "smithy.api#documentation": "A list that contains the security groups to assign to the instances in the Auto Scaling group.\n For more information, see Security Groups for Your\n VPC in the Amazon Virtual Private Cloud User\n Guide.
" + "smithy.api#documentation": "A list that contains the security groups to assign to the instances in the Auto Scaling group.\n For more information, see Security Groups for Your\n VPC in the Amazon Virtual Private Cloud User\n Guide.
" } }, "ClassicLinkVPCId": { @@ -6827,7 +6886,7 @@ "UserData": { "target": "com.amazonaws.autoscaling#XmlStringUserData", "traits": { - "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" + "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" } }, "InstanceType": { @@ -6859,7 +6918,7 @@ "InstanceMonitoring": { "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { - "smithy.api#documentation": "Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.
For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.
For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "SpotPrice": { @@ -6897,13 +6956,13 @@ "PlacementTenancy": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.
For more information, see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.
For more information, see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "MetadataOptions": { "target": "com.amazonaws.autoscaling#InstanceMetadataOptions", "traits": { - "smithy.api#documentation": "The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" } } }, @@ -6948,7 +7007,7 @@ "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The amount of capacity in the Auto Scaling group that must pass your group's health checks to\n allow the operation to continue. The value is expressed as a percentage of the desired\n capacity of the Auto Scaling group (rounded up to the nearest integer). The default is\n 90.
Setting the minimum healthy percentage to 100 percent limits the rate of replacement\n to one instance at a time. In contrast, setting it to 0 percent has the effect of\n replacing all instances at the same time.
" + "smithy.api#documentation": "Specifies the minimum percentage of the group to keep in service, healthy, and ready\n to use to support your workload to allow the operation to continue. The value is\n expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to\n 100.
\nIf you do not specify this property, the default is 90 percent, or the percentage set\n in the instance maintenance policy for the Auto Scaling group, if defined.
" } }, "InstanceWarmup": { @@ -9125,6 +9184,12 @@ "traits": { "smithy.api#documentation": "(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any\n issues and fail the operation if an alarm threshold is met.
" } + }, + "MaxHealthyPercentage": { + "target": "com.amazonaws.autoscaling#IntPercent100To200", + "traits": { + "smithy.api#documentation": "Specifies the maximum percentage of the group that can be in service and healthy, or\n pending, to support your workload when replacing instances. The value is expressed as a\n percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.
\nIf you specify MaxHealthyPercentage, you must also specify\n MinHealthyPercentage, and the difference between them cannot be greater\n than 100. A larger range increases the number of instances that can be replaced at the\n same time.
If you do not specify this property, the default is 100 percent, or the percentage set\n in the instance maintenance policy for the Auto Scaling group, if defined.
" + } } }, "traits": { @@ -9474,7 +9539,7 @@ "PolicyType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "One of the following policy types:
\n\n TargetTrackingScaling\n
\n StepScaling\n
\n SimpleScaling (default)
\n PredictiveScaling\n
For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "One of the following policy types:
\n\n TargetTrackingScaling\n
\n StepScaling\n
\n SimpleScaling (default)
\n PredictiveScaling\n
For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
" } }, "AdjustmentType": { @@ -9492,7 +9557,7 @@ "MinAdjustmentMagnitude": { "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", "traits": { - "smithy.api#documentation": "The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.
The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.
The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.
The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.
Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling\n update of instances in an Auto Scaling group. Instances are terminated first and then replaced,\n which temporarily reduces the capacity available within your Auto Scaling group.
\nThis operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.
\nIf successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.
\nAn instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.
If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.
Starts an instance refresh.
\nThis operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.
\nIf successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.
\nAn instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.
If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.
Sets your preferences for the instance refresh so that it performs as expected when\n you start it. Includes the instance warmup time, the minimum healthy percentage, and the\n behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby\n state or protected from scale in are found. You can also choose to enable additional\n features, such as the following:
Auto rollback
\nCheckpoints
\nCloudWatch alarms
\nSkip matching
\nSets your preferences for the instance refresh so that it performs as expected when\n you start it. Includes the instance warmup time, the minimum and maximum healthy\n percentages, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in\n Standby state or protected from scale in are found. You can also choose\n to enable additional features, such as the following:
Auto rollback
\nCheckpoints
\nCloudWatch alarms
\nSkip matching
\nIndicates whether to return the timestamps and raw data values of this metric.
\nIf you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).
Indicates whether to return the timestamps and raw data values of this metric.
\nIf you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).
This structure defines the CloudWatch metric to return, along with the statistic and\n unit.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.
" + "smithy.api#documentation": "This structure defines the CloudWatch metric to return, along with the statistic and\n unit.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.
" } }, "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroup": { @@ -10734,6 +10800,12 @@ "traits": { "smithy.api#documentation": "The amount of time, in seconds, until a new instance is considered to have finished\n initializing and resource consumption to become stable after it enters the\n InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an\n instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the\n warm-up period before aggregating the metrics for new instances with existing instances\n in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage\n data. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nTo manage various warm-up settings at the group level, we recommend that you set\n the default instance warmup, even if it is set to 0 seconds. To\n remove a value that you previously set, include the property but specify\n -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a value of 0 or other\n nominal value.
An instance maintenance policy. For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.
" + } } } }, diff --git a/codegen/sdk/aws-models/cloudtrail.json b/codegen/sdk/aws-models/cloudtrail.json index 8415debbc24..75a32c14951 100644 --- a/codegen/sdk/aws-models/cloudtrail.json +++ b/codegen/sdk/aws-models/cloudtrail.json @@ -302,6 +302,23 @@ } } }, + "com.amazonaws.cloudtrail#BillingMode": { + "type": "enum", + "members": { + "EXTENDABLE_RETENTION_PRICING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTENDABLE_RETENTION_PRICING" + } + }, + "FIXED_RETENTION_PRICING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED_RETENTION_PRICING" + } + } + } + }, "com.amazonaws.cloudtrail#Boolean": { "type": "boolean" }, @@ -2073,7 +2090,7 @@ "RetentionPeriod": { "target": "com.amazonaws.cloudtrail#RetentionPeriod", "traits": { - "smithy.api#documentation": "The retention period of the event data store, in days. You can set a retention period of\n up to 2557 days, the equivalent of seven years. CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.
If you plan to copy trail events to this event data store, we recommend \n that you consider both the age of the events that you\n want to copy as well as how long you want to keep the copied events\n in your event data store. For example, if you copy trail events that are 5 years old \n and specify a retention period of 7 years, the event data store \n will retain those events for two years.
\nThe retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of\n up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of\n up to 2557 days, the equivalent of seven years.
CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.
If you plan to copy trail events to this event data store, we recommend \n that you consider both the age of the events that you\n want to copy as well as how long you want to keep the copied events\n in your event data store. For example, if you copy trail events that are 5 years old \n and specify a retention period of 7 years, the event data store \n will retain those events for two years.
\nSpecifies whether the event data store should start ingesting live events. The default is true.
" } + }, + "BillingMode": { + "target": "com.amazonaws.cloudtrail#BillingMode", + "traits": { + "smithy.api#documentation": "The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.
\nThe following are the possible values:
\n\n EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). \n The default retention period for this billing mode is 366 days.
\n FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). \n The default retention period for this billing mode is 2557 days.
The default value is EXTENDABLE_RETENTION_PRICING.
For more information about CloudTrail pricing, \n see CloudTrail Pricing and \n Managing CloudTrail Lake costs.
" + } } }, "traits": { @@ -2173,6 +2196,12 @@ "traits": { "smithy.api#documentation": "Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
The billing mode for the event data store.
" + } } }, "traits": { @@ -3305,7 +3334,7 @@ } }, "traits": { - "smithy.api#documentation": "A storage lake of event data against which you can run complex SQL-based queries. An\n event data store can include events that you have logged on your account from the last 90\n to 2557 days (about three months to up to seven years). To select events for an event data\n store, use advanced event selectors.
" + "smithy.api#documentation": "A storage lake of event data against which you can run complex SQL-based queries. An\n event data store can include events that you have logged on your account. To select events for an event data\n store, use advanced event selectors.
" } }, "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException": { @@ -3757,6 +3786,12 @@ "traits": { "smithy.api#documentation": "Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
The billing mode for the event data store.
" + } } }, "traits": { @@ -7683,6 +7718,12 @@ "traits": { "smithy.api#documentation": "Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
The billing mode for the event data store.
" + } } }, "traits": { @@ -7694,7 +7735,7 @@ "traits": { "smithy.api#range": { "min": 7, - "max": 2557 + "max": 3653 } } }, @@ -8935,7 +8976,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 90 and\n 2557. By default, TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management, data, or Insights events in your event data store. For more\n information about AdvancedEventSelectors, see AdvancedEventSelectors.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.
Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 7 and\n 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management, data, or Insights events in your event data store. For more\n information about AdvancedEventSelectors, see AdvancedEventSelectors.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.
The retention period of the event data store, in days. You can set a retention period of\n up to 2557 days, the equivalent of seven years. CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.
If you decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous \n retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.
The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of\n up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of\n up to 2557 days, the equivalent of seven years.
CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.
If you decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous \n retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.
Specifies the KMS key ID to use to encrypt the events delivered by\n CloudTrail. The value can be an alias name prefixed by alias/, a\n fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.
Disabling or deleting the KMS key, or removing CloudTrail\n permissions on the key, prevents CloudTrail from logging events to the event data\n store, and prevents users from querying the data in the event data store that was\n encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\n disable or delete a KMS key that you are using with an event data store,\n delete or back up your event data store.
\nCloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.
\nExamples:
\n\n alias/MyAliasName\n
\n arn:aws:kms:us-east-2:123456789012:alias/MyAliasName\n
\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
\n 12345678-1234-1234-1234-123456789012\n
You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to \n EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.
The billing mode for the event data store determines the cost \n for ingesting events and the default and maximum retention period for the event data store.
\nThe following are the possible values:
\n\n EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is \n 366 days.
\n FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). \n The default retention period for this billing mode is 2557 days.
For more information about CloudTrail pricing, \n see CloudTrail Pricing and \n Managing CloudTrail Lake costs.
" + } } }, "traits": { @@ -9064,6 +9111,12 @@ "traits": { "smithy.api#documentation": "Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.
\n\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n
The billing mode for the event data store.
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/codecatalyst.json b/codegen/sdk/aws-models/codecatalyst.json index 2715c329fe1..52db2cae834 100644 --- a/codegen/sdk/aws-models/codecatalyst.json +++ b/codegen/sdk/aws-models/codecatalyst.json @@ -152,7 +152,7 @@ "endpointPrefix": "codecatalyst" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst \n API to work with the following objects.
\nSpaces, by calling the following:
\n\n DeleteSpace, which deletes a space.
\n\n GetSpace, which returns information about a space.
\n\n GetSubscription, which returns information about the Amazon Web Services account used for billing purposes \n and the billing plan for the space.
\n\n ListSpaces, which retrieves a list of spaces.
\n\n UpdateSpace, which hanges one or more values for a space.
\nProjects, by calling the following:
\n\n CreateProject which creates a project in a specified space.
\n\n GetProject, which returns information about a project.
\n\n ListProjects, which retrieves a list of projects in a space.
\nUsers, by calling the following:
\n\n GetUserDetails, which returns information about a user in Amazon CodeCatalyst.
\nSource repositories, by calling the following:
\n\n CreateSourceRepository, which creates an empty Git-based source repository in a specified project.
\n\n CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.
\n\n DeleteSourceRepository, which deletes a source repository.
\n\n GetSourceRepository, which returns information about a source repository.
\n\n GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source\n repository.
\n\n ListSourceRepositories, which retrieves a list of source repositories in a project.
\n\n ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.
\nDev Environments and the Amazon Web Services Toolkits, by calling the following:
\n\n CreateDevEnvironment, which creates a Dev Environment, \n where you can quickly work on the code stored in the source repositories of your project.
\n\n DeleteDevEnvironment, which deletes a Dev Environment.
\n\n GetDevEnvironment, which returns information about a Dev Environment.
\n\n ListDevEnvironments, which retrieves a list of Dev Environments in a project.
\n\n ListDevEnvironmentSessions, which retrieves a list of active Dev Environment sessions in a project.
\n\n StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.
\n\n StartDevEnvironmentSession, which starts a session to a specified Dev Environment.
\n\n StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.
\n\n StopDevEnvironmentSession, which stops a session for a specified Dev Environment.
\n\n UpdateDevEnvironment, which changes one or more values for a Dev Environment.
\nSecurity, activity, and resource management in Amazon CodeCatalyst, by calling the following:
\n\n CreateAccessToken, which creates a personal access token (PAT) for the current user.
\n\n DeleteAccessToken, which deletes a specified personal access token (PAT).
\n\n ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.
\n\n ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.
\n\n VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.
\nIf you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO).\n For more information, see Setting up to use the CLI with Amazon CodeCatalyst\n and the SSO documentation for your SDK.
\nWelcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst \n API to work with the following objects.
\nSpaces, by calling the following:
\n\n DeleteSpace, which deletes a space.
\n\n GetSpace, which returns information about a space.
\n\n GetSubscription, which returns information about the Amazon Web Services account used for billing purposes \n and the billing plan for the space.
\n\n ListSpaces, which retrieves a list of spaces.
\n\n UpdateSpace, which changes one or more values for a space.
\nProjects, by calling the following:
\n\n CreateProject which creates a project in a specified space.
\n\n GetProject, which returns information about a project.
\n\n ListProjects, which retrieves a list of projects in a space.
\nUsers, by calling the following:
\n\n GetUserDetails, which returns information about a user in Amazon CodeCatalyst.
\nSource repositories, by calling the following:
\n\n CreateSourceRepository, which creates an empty Git-based source repository in a specified project.
\n\n CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.
\n\n DeleteSourceRepository, which deletes a source repository.
\n\n GetSourceRepository, which returns information about a source repository.
\n\n GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source\n repository.
\n\n ListSourceRepositories, which retrieves a list of source repositories in a project.
\n\n ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.
\nDev Environments and the Amazon Web Services Toolkits, by calling the following:
\n\n CreateDevEnvironment, which creates a Dev Environment, \n where you can quickly work on the code stored in the source repositories of your project.
\n\n DeleteDevEnvironment, which deletes a Dev Environment.
\n\n GetDevEnvironment, which returns information about a Dev Environment.
\n\n ListDevEnvironments, which retrieves a list of Dev Environments in a project.
\n\n ListDevEnvironmentSessions, which retrieves a list of active Dev Environment sessions in a project.
\n\n StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.
\n\n StartDevEnvironmentSession, which starts a session to a specified Dev Environment.
\n\n StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.
\n\n StopDevEnvironmentSession, which stops a session for a specified Dev Environment.
\n\n UpdateDevEnvironment, which changes one or more values for a Dev Environment.
\nWorkflows, by calling the following:
\n\n GetWorkflow, which returns information about a workflow.
\n\n GetWorkflowRun, which returns information about a specified run of a workflow.
\n\n ListWorkflowRuns, which retrieves a list of runs of a specified workflow.
\n\n ListWorkflows, which retrieves a list of workflows in a specified project.
\n\n StartWorkflowRun, which starts a run of a specified workflow.
\nSecurity, activity, and resource management in Amazon CodeCatalyst, by calling the following:
\n\n CreateAccessToken, which creates a personal access token (PAT) for the current user.
\n\n DeleteAccessToken, which deletes a specified personal access token (PAT).
\n\n ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.
\n\n ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.
\n\n VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.
\nIf you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO).\n For more information, see Setting up to use the CLI with Amazon CodeCatalyst\n and the SSO documentation for your SDK.
\nInformation about the amount of storage allocated to the Dev Environment.
\nBy 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\n creating a Dev Environment. \n Valid values for persistent storage are based on memory sizes in 16GB increments. Valid\n values are 16, 32, and 64.
\nThe name of the connection to use connect to a Amazon VPC.
" + } } } }, @@ -695,6 +705,12 @@ "smithy.api#required": {}, "smithy.api#resourceIdentifier": "devEnvironmentId" } + }, + "vpcConnectionName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
" + } } } }, @@ -1308,9 +1324,6 @@ "delete": { "target": "com.amazonaws.codecatalyst#DeleteDevEnvironment" }, - "list": { - "target": "com.amazonaws.codecatalyst#ListDevEnvironments" - }, "operations": [ { "target": "com.amazonaws.codecatalyst#ListDevEnvironmentSessions" @@ -1606,6 +1619,12 @@ "smithy.api#documentation": "Information about the configuration of persistent storage for the Dev Environment.
", "smithy.api#required": {} } + }, + "vpcConnectionName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
" + } } }, "traits": { @@ -1857,6 +1876,10 @@ { "name": "HAS_ACCESS_TO", "value": "hasAccessTo" + }, + { + "name": "NAME", + "value": "name" } ] } @@ -2014,6 +2037,12 @@ "smithy.api#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.
", "smithy.api#required": {} } + }, + "vpcConnectionName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
" + } } } }, @@ -2438,6 +2467,273 @@ } } }, + "com.amazonaws.codecatalyst#GetWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#GetWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#GetWorkflowResponse" + }, + "traits": { + "smithy.api#documentation": "Returns information about a workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/workflows/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#GetWorkflowRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workflowId" + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the project in the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codecatalyst#GetWorkflowResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the space.
", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the project in the space.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The ID of the workflow.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workflowId" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString", + "traits": { + "smithy.api#documentation": "The name of the source repository where the workflow YAML is stored.
" + } + }, + "sourceBranchName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranchString", + "traits": { + "smithy.api#documentation": "The name of the branch that contains the workflow YAML.
" + } + }, + "definition": { + "target": "com.amazonaws.codecatalyst#WorkflowDefinition", + "traits": { + "smithy.api#documentation": "Information about the workflow definition file for the workflow.
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339\n
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339\n
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "runMode": { + "target": "com.amazonaws.codecatalyst#WorkflowRunMode", + "traits": { + "smithy.api#documentation": "The behavior to use when multiple workflows occur at the same time. For more information, see \n https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.codecatalyst#WorkflowStatus", + "traits": { + "smithy.api#documentation": "The status of the workflow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codecatalyst#GetWorkflowRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#GetWorkflowRunRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#GetWorkflowRunResponse" + }, + "traits": { + "smithy.api#documentation": "Returns information about a specified run of a workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/workflowRuns/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#GetWorkflowRunRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workflowRunId" + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the project in the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codecatalyst#GetWorkflowRunResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the space.
", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the project in the space.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The ID of the workflow run.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workflowRunId" + } + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The ID of the workflow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.codecatalyst#WorkflowRunStatus", + "traits": { + "smithy.api#documentation": "The status of the workflow run.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.codecatalyst#WorkflowRunStatusReasons", + "traits": { + "smithy.api#documentation": "Information about the reasons for the status of the workflow run.
" + } + }, + "startTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339\n
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "endTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339\n
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.codecatalyst#Ide": { "type": "structure", "members": { @@ -2733,7 +3029,7 @@ "smithy.api#documentation": "Retrieves a list of Dev Environments in a project.
", "smithy.api#http": { "method": "POST", - "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments", + "uri": "/v1/spaces/{spaceName}/devEnvironments", "code": 200 }, "smithy.api#paginated": { @@ -2759,9 +3055,7 @@ "projectName": { "target": "com.amazonaws.codecatalyst#NameString", "traits": { - "smithy.api#documentation": "The name of the project in the space.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The name of the project in the space.
" } }, "filters": { @@ -2819,7 +3113,7 @@ "target": "com.amazonaws.codecatalyst#ListEventLogsResponse" }, "traits": { - "smithy.api#documentation": "Retrieves a list of events that occurred during a specified time period in a space. You can use these events to audit user and system activity in a space.
", + "smithy.api#documentation": "Retrieves a list of events that occurred during a specific time in a space. You can\n use these events to audit user and system activity in a space. For more information, see\n Monitoring in the Amazon CodeCatalyst User Guide.
\nListEventLogs guarantees events for the last 30 days in a given space. You can also\n view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the\n CloudTrail console by viewing Event history, or by creating a trail to create\n and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with\n CloudTrail trails.
\nRetrieves a list of workflow runs of a specified workflow.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/workflowRuns", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#ListWorkflowRunsRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.
", + "smithy.api#httpQuery": "workflowId" + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the project in the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A token returned from a call to this API to indicate the next batch of results to return, if any.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Information used to sort the items in the returned list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codecatalyst#ListWorkflowRunsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A token returned from a call to this API to indicate the next batch of results to return, if any.
" + } + }, + "items": { + "target": "com.amazonaws.codecatalyst#WorkflowRunSummaries", + "traits": { + "smithy.api#documentation": "Information about the runs of a workflow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codecatalyst#ListWorkflows": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#ListWorkflowsRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#ListWorkflowsResponse" + }, + "traits": { + "smithy.api#documentation": "Retrieves a list of workflows in a specified project.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/workflows", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codecatalyst#ListWorkflowsRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the project in the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A token returned from a call to this API to indicate the next batch of results to return, if any.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Information used to sort the items in the returned list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codecatalyst#ListWorkflowsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A token returned from a call to this API to indicate the next batch of results to return, if any.
" + } + }, + "items": { + "target": "com.amazonaws.codecatalyst#WorkflowSummaries", + "traits": { + "smithy.api#documentation": "Information about the workflows in a project.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codecatalyst#NameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*$" } @@ -3396,6 +3895,12 @@ }, { "target": "com.amazonaws.codecatalyst#SourceRepository" + }, + { + "target": "com.amazonaws.codecatalyst#Workflow" + }, + { + "target": "com.amazonaws.codecatalyst#WorkflowRun" } ] }, @@ -3708,6 +4213,11 @@ "list": { "target": "com.amazonaws.codecatalyst#ListSpaces" }, + "operations": [ + { + "target": "com.amazonaws.codecatalyst#ListDevEnvironments" + } + ], "resources": [ { "target": "com.amazonaws.codecatalyst#EventLogResource" @@ -3967,33 +4477,25 @@ } } }, - "com.amazonaws.codecatalyst#StatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1024 - } - } - }, - "com.amazonaws.codecatalyst#StopDevEnvironment": { + "com.amazonaws.codecatalyst#StartWorkflowRun": { "type": "operation", "input": { - "target": "com.amazonaws.codecatalyst#StopDevEnvironmentRequest" + "target": "com.amazonaws.codecatalyst#StartWorkflowRunRequest" }, "output": { - "target": "com.amazonaws.codecatalyst#StopDevEnvironmentResponse" + "target": "com.amazonaws.codecatalyst#StartWorkflowRunResponse" }, "traits": { - "smithy.api#documentation": "Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.
", + "smithy.api#documentation": "Begins a run of a specified workflow.
", "smithy.api#http": { "method": "PUT", - "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/stop", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/workflowRuns", "code": 200 }, "smithy.api#idempotent": {} } }, - "com.amazonaws.codecatalyst#StopDevEnvironmentRequest": { + "com.amazonaws.codecatalyst#StartWorkflowRunRequest": { "type": "structure", "members": { "spaceName": { @@ -4001,6 +4503,9 @@ "traits": { "smithy.api#documentation": "The name of the space.
", "smithy.api#httpLabel": {}, + "smithy.api#length": { + "min": 1 + }, "smithy.api#required": {} } }, @@ -4009,21 +4514,38 @@ "traits": { "smithy.api#documentation": "The name of the project in the space.
", "smithy.api#httpLabel": {}, + "smithy.api#length": { + "min": 1 + }, "smithy.api#required": {} } }, - "id": { + "workflowId": { "target": "com.amazonaws.codecatalyst#Uuid", "traits": { - "smithy.api#documentation": "The system-generated unique ID of the Dev Environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "devEnvironmentId" + "smithy.api#documentation": "The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.
", + "smithy.api#httpQuery": "workflowId", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A user-specified idempotency token. Idempotency ensures that an API request completes only once. \n With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+(?:[-_\\.][a-zA-Z0-9]+)*$" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.codecatalyst#StopDevEnvironmentResponse": { + "com.amazonaws.codecatalyst#StartWorkflowRunResponse": { "type": "structure", "members": { "spaceName": { @@ -4043,39 +4565,49 @@ "id": { "target": "com.amazonaws.codecatalyst#Uuid", "traits": { - "smithy.api#documentation": "The system-generated unique ID of the Dev Environment.
", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "devEnvironmentId" + "smithy.api#documentation": "The system-generated unique ID of the workflow run.
", + "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.codecatalyst#DevEnvironmentStatus", + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid", "traits": { - "smithy.api#documentation": "The status of the Dev Environment.
", + "smithy.api#documentation": "The system-generated unique ID of the workflow.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.codecatalyst#StopDevEnvironmentSession": { + "com.amazonaws.codecatalyst#StatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.codecatalyst#StopDevEnvironment": { "type": "operation", "input": { - "target": "com.amazonaws.codecatalyst#StopDevEnvironmentSessionRequest" + "target": "com.amazonaws.codecatalyst#StopDevEnvironmentRequest" }, "output": { - "target": "com.amazonaws.codecatalyst#StopDevEnvironmentSessionResponse" + "target": "com.amazonaws.codecatalyst#StopDevEnvironmentResponse" }, "traits": { - "smithy.api#documentation": "Stops a session for a specified Dev Environment.
", + "smithy.api#documentation": "Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.
", "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session/{sessionId}", + "method": "PUT", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/stop", "code": 200 }, "smithy.api#idempotent": {} } }, - "com.amazonaws.codecatalyst#StopDevEnvironmentSessionRequest": { + "com.amazonaws.codecatalyst#StopDevEnvironmentRequest": { "type": "structure", "members": { "spaceName": { @@ -4097,16 +4629,98 @@ "id": { "target": "com.amazonaws.codecatalyst#Uuid", "traits": { - "smithy.api#documentation": "The system-generated unique ID of the Dev Environment. To obtain this ID, use ListDevEnvironments.
", + "smithy.api#documentation": "The system-generated unique ID of the Dev Environment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "devEnvironmentId" } - }, - "sessionId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.
", + } + } + }, + "com.amazonaws.codecatalyst#StopDevEnvironmentResponse": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the space.
", + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the project in the space.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The system-generated unique ID of the Dev Environment.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "status": { + "target": "com.amazonaws.codecatalyst#DevEnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of the Dev Environment.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codecatalyst#StopDevEnvironmentSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecatalyst#StopDevEnvironmentSessionRequest" + }, + "output": { + "target": "com.amazonaws.codecatalyst#StopDevEnvironmentSessionResponse" + }, + "traits": { + "smithy.api#documentation": "Stops a session for a specified Dev Environment.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/spaces/{spaceName}/projects/{projectName}/devEnvironments/{id}/session/{sessionId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codecatalyst#StopDevEnvironmentSessionRequest": { + "type": "structure", + "members": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString", + "traits": { + "smithy.api#documentation": "The name of the project in the space.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The system-generated unique ID of the Dev Environment. To obtain this ID, use ListDevEnvironments.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "devEnvironmentId" + } + }, + "sessionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.
", "smithy.api#httpLabel": {}, "smithy.api#length": { "min": 1, @@ -4596,6 +5210,365 @@ } } } + }, + "com.amazonaws.codecatalyst#Workflow": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + }, + "read": { + "target": "com.amazonaws.codecatalyst#GetWorkflow" + }, + "list": { + "target": "com.amazonaws.codecatalyst#ListWorkflows" + } + }, + "com.amazonaws.codecatalyst#WorkflowDefinition": { + "type": "structure", + "members": { + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The path to the workflow definition file stored in the source repository for the project, including the file name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a workflow definition file.
" + } + }, + "com.amazonaws.codecatalyst#WorkflowDefinitionSummary": { + "type": "structure", + "members": { + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The path to the workflow definition file stored in the source repository for the project, including the file name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a workflow definition.
" + } + }, + "com.amazonaws.codecatalyst#WorkflowRun": { + "type": "resource", + "identifiers": { + "spaceName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "projectName": { + "target": "com.amazonaws.codecatalyst#NameString" + }, + "workflowRunId": { + "target": "com.amazonaws.codecatalyst#Uuid" + } + }, + "create": { + "target": "com.amazonaws.codecatalyst#StartWorkflowRun" + }, + "read": { + "target": "com.amazonaws.codecatalyst#GetWorkflowRun" + }, + "list": { + "target": "com.amazonaws.codecatalyst#ListWorkflowRuns" + } + }, + "com.amazonaws.codecatalyst#WorkflowRunMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "QUEUED", + "value": "QUEUED" + }, + { + "name": "PARALLEL", + "value": "PARALLEL" + }, + { + "name": "SUPERSEDED", + "value": "SUPERSEDED" + } + ] + } + }, + "com.amazonaws.codecatalyst#WorkflowRunSortCriteria": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Information used to sort workflow runs in the returned list.
" + } + }, + "com.amazonaws.codecatalyst#WorkflowRunSortCriteriaList": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#WorkflowRunSortCriteria" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.codecatalyst#WorkflowRunStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SUCCEEDED", + "value": "SUCCEEDED" + }, + { + "name": "FAILED", + "value": "FAILED" + }, + { + "name": "STOPPED", + "value": "STOPPED" + }, + { + "name": "SUPERSEDED", + "value": "SUPERSEDED" + }, + { + "name": "CANCELLED", + "value": "CANCELLED" + }, + { + "name": "NOT_RUN", + "value": "NOT_RUN" + }, + { + "name": "VALIDATING", + "value": "VALIDATING" + }, + { + "name": "PROVISIONING", + "value": "PROVISIONING" + }, + { + "name": "IN_PROGRESS", + "value": "IN_PROGRESS" + }, + { + "name": "STOPPING", + "value": "STOPPING" + }, + { + "name": "ABANDONED", + "value": "ABANDONED" + } + ] + } + }, + "com.amazonaws.codecatalyst#WorkflowRunStatusReason": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Information about the status of a workflow run.
" + } + }, + "com.amazonaws.codecatalyst#WorkflowRunStatusReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#WorkflowRunStatusReason" + } + }, + "com.amazonaws.codecatalyst#WorkflowRunSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#WorkflowRunSummary" + } + }, + "com.amazonaws.codecatalyst#WorkflowRunSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The system-generated unique ID of the workflow run.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workflowRunId" + } + }, + "workflowId": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The system-generated unique ID of the workflow.
", + "smithy.api#required": {} + } + }, + "workflowName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.codecatalyst#WorkflowRunStatus", + "traits": { + "smithy.api#documentation": "The status of the workflow run.
", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.codecatalyst#WorkflowRunStatusReasons", + "traits": { + "smithy.api#documentation": "The reasons for the workflow run status.
" + } + }, + "startTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "endTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339\n
", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339\n
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a workflow run.
" + } + }, + "com.amazonaws.codecatalyst#WorkflowSortCriteria": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Information used to sort workflows in the returned list.
" + } + }, + "com.amazonaws.codecatalyst#WorkflowSortCriteriaList": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#WorkflowSortCriteria" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.codecatalyst#WorkflowStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "INVALID", + "value": "INVALID" + }, + { + "name": "ACTIVE", + "value": "ACTIVE" + } + ] + } + }, + "com.amazonaws.codecatalyst#WorkflowSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.codecatalyst#WorkflowSummary" + } + }, + "com.amazonaws.codecatalyst#WorkflowSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.codecatalyst#Uuid", + "traits": { + "smithy.api#documentation": "The system-generated unique ID of a workflow.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workflowId" + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "sourceRepositoryName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryNameString", + "traits": { + "smithy.api#documentation": "The name of the source repository where the workflow definition file is stored.
", + "smithy.api#required": {} + } + }, + "sourceBranchName": { + "target": "com.amazonaws.codecatalyst#SourceRepositoryBranchString", + "traits": { + "smithy.api#documentation": "The name of the branch of the source repository where the workflow definition file is stored.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.codecatalyst#WorkflowDefinitionSummary", + "traits": { + "smithy.api#documentation": "Information about the workflow definition file.
", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339\n
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.codecatalyst#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339\n
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "runMode": { + "target": "com.amazonaws.codecatalyst#WorkflowRunMode", + "traits": { + "smithy.api#documentation": "The run mode of the workflow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.codecatalyst#WorkflowStatus", + "traits": { + "smithy.api#documentation": "The status of the workflow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a workflow.
" + } } } } \ No newline at end of file diff --git a/codegen/sdk/aws-models/dlm.json b/codegen/sdk/aws-models/dlm.json index eb12cbbfcc3..951f8d032b9 100644 --- a/codegen/sdk/aws-models/dlm.json +++ b/codegen/sdk/aws-models/dlm.json @@ -88,7 +88,7 @@ } }, "traits": { - "smithy.api#documentation": "\n [Snapshot policies only] Specifies information about the archive storage tier retention period.
" + "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies information about the archive storage tier retention period.
" } }, "com.amazonaws.dlm#ArchiveRule": { @@ -104,7 +104,7 @@ } }, "traits": { - "smithy.api#documentation": "\n [Snapshot policies only] Specifies a snapshot archiving rule for a schedule.
" + "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies a snapshot archiving rule for a schedule.
" } }, "com.amazonaws.dlm#AvailabilityZone": { @@ -164,6 +164,14 @@ } } }, + "com.amazonaws.dlm#CreateInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.dlm#CreateLifecyclePolicy": { "type": "operation", "input": { @@ -184,7 +192,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a policy to manage the lifecycle of the specified Amazon Web Services resources. You can\n\t\t\tcreate up to 100 lifecycle policies.
", + "smithy.api#documentation": "Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types:
\nCustom EBS snapshot policy
\nCustom EBS-backed AMI policy
\nCross-account copy event policy
\nDefault policy for EBS snapshots
\nDefault policy for EBS-backed AMIs
\nFor more information, see \n\t\t\tDefault policies vs custom policies.
\nIf you create a default policy, you can specify the request parameters either in \n\t\t\t\tthe request body, or in the PolicyDetails request structure, but not both.
\nThe desired activation state of the lifecycle policy after creation.
", + "smithy.api#documentation": "The activation state of the lifecycle policy after creation.
", "smithy.api#required": {} } }, "PolicyDetails": { "target": "com.amazonaws.dlm#PolicyDetails", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration details of the lifecycle policy.
", - "smithy.api#required": {} + "smithy.api#documentation": "The configuration details of the lifecycle policy.
\nIf you create a default policy, you can specify the request parameters either in \n\t\t\t\tthe request body, or in the PolicyDetails request structure, but not both.
\nThe tags to apply to the lifecycle policy during creation.
" } + }, + "DefaultPolicy": { + "target": "com.amazonaws.dlm#DefaultPolicyTypeValues", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specify the type of default policy to create.
\nTo create a default policy for EBS snapshots, that creates snapshots of all volumes in the\n\t\t\t\t\tRegion that do not have recent backups, specify VOLUME.
To create a default policy for EBS-backed AMIs, that creates EBS-backed \n\t\t\t\t\tAMIs from all instances in the Region that do not have recent backups, specify \n\t\t\t\t\tINSTANCE.
\n [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. \n\t\t\tThe creation frequency can range from 1 to 7 days. If you do not specify a value, the \n\t\t\tdefault is 1.
\nDefault: 1
" + } + }, + "RetainInterval": { + "target": "com.amazonaws.dlm#RetainInterval", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies how long the policy should retain snapshots or AMIs before \n\t\t\tdeleting them. The retention period can range from 2 to 14 days, but it must be greater \n\t\t\tthan the creation frequency to ensure that the policy retains at least 1 snapshot or \n\t\t\tAMI at any given time. If you do not specify a value, the default is 7.
\nDefault: 7
" + } + }, + "CopyTags": { + "target": "com.amazonaws.dlm#CopyTagsNullable", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Indicates whether the policy should copy tags from the source resource \n\t\t\tto the snapshot or AMI. If you do not specify a value, the default is false.
Default: false
" + } + }, + "ExtendDeletion": { + "target": "com.amazonaws.dlm#ExtendDeletion", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the \n\t\t\tsource volume or instance is deleted, or if the policy enters the error, disabled, or \n\t\t\tdeleted state.
\nBy default (ExtendDeletion=false):
\nIf a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously \n\t\t\t\tcreated snapshots or AMIs, up to but not including the last one, based on the \n\t\t\t\tspecified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, \n\t\t\t\tincluding the last one, specify true.
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting \n\t\t\t\t\tsnapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, \n\t\t\t\t\tincluding the last one, if the policy enters one of these states, specify \n\t\t\t\t\ttrue.
If you enable extended deletion (ExtendDeletion=true), \n\t\t\tyou override both default behaviors simultaneously.
\nIf you do not specify a value, the default is false.
Default: false
" + } + }, + "CrossRegionCopyTargets": { + "target": "com.amazonaws.dlm#CrossRegionCopyTargetList", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify \n\t\t\tup to 3 destination Regions. If you do not want to create cross-Region copies, omit this \n\t\t\tparameter.
" + } + }, + "Exclusions": { + "target": "com.amazonaws.dlm#Exclusions", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies exclusion parameters for volumes or instances for which you \n\t\t\tdo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs \n\t\t\tfor target resources that match any of the specified exclusion parameters.
" + } } }, "traits": { @@ -258,7 +306,7 @@ "Location": { "target": "com.amazonaws.dlm#LocationValues", "traits": { - "smithy.api#documentation": "\n [Snapshot policies only] Specifies the destination for snapshots created by the policy. To create \n\t\t\tsnapshots in the same Region as the source resource, specify CLOUD. To create \n\t\t\tsnapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. \n\t\t\tIf you omit this parameter, CLOUD is used by default.
If the policy targets resources in an Amazon Web Services Region, then you must create \n\t\t\tsnapshots in the same Region as the source resource. If the policy targets resources on an \n\t\t\tOutpost, then you can create snapshots on the same Outpost as the source resource, or in \n\t\t\tthe Region of that Outpost.
" + "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create \n\t\t\tsnapshots in the same Region as the source resource, specify CLOUD. To create \n\t\t\tsnapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. \n\t\t\tIf you omit this parameter, CLOUD is used by default.
If the policy targets resources in an Amazon Web Services Region, then you must create \n\t\t\tsnapshots in the same Region as the source resource. If the policy targets resources on an \n\t\t\tOutpost, then you can create snapshots on the same Outpost as the source resource, or in \n\t\t\tthe Region of that Outpost.
" } }, "Interval": { @@ -288,12 +336,12 @@ "Scripts": { "target": "com.amazonaws.dlm#ScriptsList", "traits": { - "smithy.api#documentation": "\n [Snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy \n\t\t\tthat targets instances. This is useful for creating application-consistent snapshots, or for \n\t\t\tperforming specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
\nFor more information, see Automating \n\t\t\t\tapplication-consistent snapshots with pre and post scripts.
" + "smithy.api#documentation": "\n [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy \n\t\t\tthat targets instances. This is useful for creating application-consistent snapshots, or for \n\t\t\tperforming specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
\nFor more information, see Automating \n\t\t\t\tapplication-consistent snapshots with pre and post scripts.
" } } }, "traits": { - "smithy.api#documentation": "\n [Snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.
\nYou must specify either CronExpression, or \n\t\t\t\t\t\tInterval, IntervalUnit, \n\t\t\t\t\t\tand Times.
\nIf you need to specify an ArchiveRule \n\t\t\t\t\t\tfor the schedule, then you must specify a creation frequency of at least \n\t\t\t\t\t\t28 days.
\n\n [Custom snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.
\nYou must specify either CronExpression, or \n\t\t\t\t\t\tInterval, IntervalUnit, \n\t\t\t\t\t\tand Times.
\nIf you need to specify an ArchiveRule \n\t\t\t\t\t\tfor the schedule, then you must specify a creation frequency of at least \n\t\t\t\t\t\t28 days.
\n\n [AMI policies only] Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.
" + "smithy.api#documentation": "\n [Custom AMI policies only] Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.
" } }, "com.amazonaws.dlm#CrossRegionCopyRetainRule": { @@ -391,13 +439,13 @@ "TargetRegion": { "target": "com.amazonaws.dlm#TargetRegion", "traits": { - "smithy.api#documentation": "Use this parameter for AMI policies only. For snapshot policies, use \n\t\t\t\tTarget instead. For snapshot policies \n\t\t\t\tcreated before the Target parameter \n\t\t\t\twas introduced, this parameter indicates the target Region for snapshot \n\t\t\t\tcopies.
\n \n\n [AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the \n\t\t\tsnapshot copies.
" + "smithy.api#documentation": "Use this parameter for AMI policies only. For snapshot policies, use \n\t\t\t\tTarget instead. For snapshot policies \n\t\t\t\tcreated before the Target parameter \n\t\t\t\twas introduced, this parameter indicates the target Region for snapshot \n\t\t\t\tcopies.
\n \n\n [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the \n\t\t\tsnapshot copies.
" } }, "Target": { "target": "com.amazonaws.dlm#Target", "traits": { - "smithy.api#documentation": "Use this parameter for snapshot policies only. For AMI policies, use \n\t\t\t\tTargetRegion instead.
\n\n [Snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the \n\t\t\tsnapshot copies.
" + "smithy.api#documentation": "Use this parameter for snapshot policies only. For AMI policies, use \n\t\t\t\tTargetRegion instead.
\n\n [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the \n\t\t\tsnapshot copies.
" } }, "Encrypted": { @@ -429,12 +477,12 @@ "DeprecateRule": { "target": "com.amazonaws.dlm#CrossRegionCopyDeprecateRule", "traits": { - "smithy.api#documentation": "\n [AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
" + "smithy.api#documentation": "\n [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
" } } }, "traits": { - "smithy.api#documentation": "\n [Snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.
\nTo specify a cross-Region copy action for event-based polices, use \n\t\t\t\tCrossRegionCopyAction.
\n\n [Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.
\nTo specify a cross-Region copy action for event-based polices, use \n\t\t\t\tCrossRegionCopyAction.
\nThe target Region, for example us-east-1.
\n [Default policies only] Specifies a destination Region for cross-Region copy actions.
" + } + }, + "com.amazonaws.dlm#CrossRegionCopyTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.dlm#CrossRegionCopyTarget" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.dlm#DefaultPoliciesTypeValues": { + "type": "enum", + "members": { + "VOLUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOLUME" + } + }, + "INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.dlm#DefaultPolicy": { + "type": "boolean" + }, + "com.amazonaws.dlm#DefaultPolicyTypeValues": { + "type": "enum", + "members": { + "VOLUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOLUME" + } + }, + "INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE" + } + } + } + }, "com.amazonaws.dlm#DeleteLifecyclePolicy": { "type": "operation", "input": { @@ -523,7 +640,7 @@ } }, "traits": { - "smithy.api#documentation": "\n [AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.
\nFor age-based schedules, you must specify Interval and \n\t\t\tIntervalUnit. For count-based schedules, you must specify \n\t\t\tCount.
" + "smithy.api#documentation": "\n [Custom AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.
\nFor age-based schedules, you must specify Interval and \n\t\t\tIntervalUnit. For count-based schedules, you must specify \n\t\t\tCount.
" } }, "com.amazonaws.dlm#DescriptionRegex": { @@ -646,6 +763,9 @@ "com.amazonaws.dlm#ExcludeBootVolume": { "type": "boolean" }, + "com.amazonaws.dlm#ExcludeBootVolumes": { + "type": "boolean" + }, "com.amazonaws.dlm#ExcludeDataVolumeTagList": { "type": "list", "member": { @@ -658,6 +778,56 @@ } } }, + "com.amazonaws.dlm#ExcludeTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.dlm#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.dlm#ExcludeVolumeTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.dlm#VolumeTypeValues" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + } + } + }, + "com.amazonaws.dlm#Exclusions": { + "type": "structure", + "members": { + "ExcludeBootVolumes": { + "target": "com.amazonaws.dlm#ExcludeBootVolumes", + "traits": { + "smithy.api#documentation": "\n [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to \n\t\t\tinstances as the boot volume. If you exclude boot volumes, only volumes attached as data \n\t\t\t(non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify \n\t\t\ttrue.
\n [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified \n\t\t\ttypes will not be targeted by the policy.
" + } + }, + "ExcludeTags": { + "target": "com.amazonaws.dlm#ExcludeTagsList", + "traits": { + "smithy.api#documentation": "\n [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies exclusion parameters for volumes or instances for which you \n\t\t\tdo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs \n\t\t\tfor target resources that match any of the specified exclusion parameters.
" + } + }, "com.amazonaws.dlm#ExecuteOperationOnScriptFailure": { "type": "boolean" }, @@ -692,6 +862,9 @@ "smithy.api#pattern": "^arn:aws(-[a-z]{1,3}){0,2}:iam::\\d+:role/" } }, + "com.amazonaws.dlm#ExtendDeletion": { + "type": "boolean" + }, "com.amazonaws.dlm#FastRestoreRule": { "type": "structure", "members": { @@ -723,7 +896,7 @@ } }, "traits": { - "smithy.api#documentation": "\n [Snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by\n\t\t\tsnapshot policies. You can enable fast snapshot restore based on either a count or a\n\t\t\ttime interval.
" + "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by\n\t\t\tsnapshot policies. You can enable fast snapshot restore based on either a count or a\n\t\t\ttime interval.
" } }, "com.amazonaws.dlm#GetLifecyclePolicies": { @@ -794,6 +967,13 @@ "smithy.api#documentation": "The tags to add to objects created by the policy.
\nTags are strings in the format key=value.
These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.
", "smithy.api#httpQuery": "tagsToAdd" } + }, + "DefaultPolicyType": { + "target": "com.amazonaws.dlm#DefaultPoliciesTypeValues", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies the type of default policy to get. Specify one of the following:
\n\n VOLUME - To get only the default policy for EBS snapshots
\n INSTANCE - To get only the default policy for EBS-backed AMIs
\n ALL - To get all default policies
The Amazon Resource Name (ARN) of the policy.
" } + }, + "DefaultPolicy": { + "target": "com.amazonaws.dlm#DefaultPolicy", + "traits": { + "smithy.api#documentation": "\n [Default policies only] The type of default policy. Values include:
\n\n VOLUME - Default policy for EBS snapshots
\n INSTANCE - Default policy for EBS-backed AMIs
\n [All policy types] Detailed information about a snapshot, AMI, or event-based lifecycle policy.
" + "smithy.api#documentation": "\n [Custom policies only] Detailed information about a snapshot, AMI, or event-based lifecycle policy.
" } }, "com.amazonaws.dlm#LifecyclePolicySummary": { @@ -1058,6 +1244,12 @@ "traits": { "smithy.api#documentation": "The type of policy. EBS_SNAPSHOT_MANAGEMENT indicates that the policy \n\t\t\tmanages the lifecycle of Amazon EBS snapshots. IMAGE_MANAGEMENT \n\t\t\tindicates that the policy manages the lifecycle of EBS-backed AMIs. \n\t\t\tEVENT_BASED_POLICY indicates that the policy automates cross-account \n\t\t\tsnapshot copies for snapshots that are shared with your account.
\n [Default policies only] The type of default policy. Values include:
\n\n VOLUME - Default policy for EBS snapshots
\n INSTANCE - Default policy for EBS-backed AMIs
\n [Snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume \n\t\t\tsnapshot sets. The default is false. If you specify true, \n\t\t\tthen the root volumes attached to targeted instances will be excluded from the multi-volume \n\t\t\tsnapshot sets created by the policy.
\n [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume \n\t\t\tsnapshot sets. The default is false. If you specify true, \n\t\t\tthen the root volumes attached to targeted instances will be excluded from the multi-volume \n\t\t\tsnapshot sets created by the policy.
\n [AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy \n\t\t\truns. true indicates that targeted instances are not rebooted when the policy \n\t\t\truns. false indicates that target instances are rebooted when the policy runs. \n\t\t\tThe default is true (instances are not rebooted).
\n [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy \n\t\t\truns. true indicates that targeted instances are not rebooted when the policy \n\t\t\truns. false indicates that target instances are rebooted when the policy runs. \n\t\t\tThe default is true (instances are not rebooted).
\n [Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from \n\t\t\tmulti-volume snapshot sets.
\nIf you create a snapshot lifecycle policy that targets instances and you specify tags for \n\t\t\tthis parameter, then data volumes with the specified tags that are attached to targeted \n\t\t\tinstances will be excluded from the multi-volume snapshot sets created by the policy.
" + "smithy.api#documentation": "\n [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from \n\t\t\tmulti-volume snapshot sets.
\nIf you create a snapshot lifecycle policy that targets instances and you specify tags for \n\t\t\tthis parameter, then data volumes with the specified tags that are attached to targeted \n\t\t\tinstances will be excluded from the multi-volume snapshot sets created by the policy.
" } } }, "traits": { - "smithy.api#documentation": "\n [Snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The \n\t\t\tset of valid parameters depends on the combination of policy type and target resource \n\t\t\ttype.
\nIf you choose to exclude boot volumes and you specify tags that consequently exclude \n\t\t\tall of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create \n\t\t\tany snapshots for the affected instance, and it will emit a SnapshotsCreateFailed \n\t\t\tAmazon CloudWatch metric. For more information, see Monitor your policies \n\t\t\t\tusing Amazon CloudWatch.
\n [Custom snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The \n\t\t\tset of valid parameters depends on the combination of policy type and target resource \n\t\t\ttype.
\nIf you choose to exclude boot volumes and you specify tags that consequently exclude \n\t\t\tall of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create \n\t\t\tany snapshots for the affected instance, and it will emit a SnapshotsCreateFailed \n\t\t\tAmazon CloudWatch metric. For more information, see Monitor your policies \n\t\t\t\tusing Amazon CloudWatch.
\n [All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY \n\t\t\tto 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.
\n [Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY \n\t\t\tto 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.
\n [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to \n\t\t\tcreate snapshots of individual volumes or use INSTANCE to create multi-volume \n\t\t\tsnapshots from the volumes for an instance.
\n [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to \n\t\t\tcreate snapshots of individual volumes or use INSTANCE to create multi-volume \n\t\t\tsnapshots from the volumes for an instance.
\n [Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an \n\t\t\tAmazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost \n\t\t\tin your account, specify OUTPOST.
If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources \n\t\t\t\tof the specified type with matching target tags across all of the Outposts in your account.
\n [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an \n\t\t\tAmazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost \n\t\t\tin your account, specify OUTPOST.
If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources \n\t\t\t\tof the specified type with matching target tags across all of the Outposts in your account.
\n [Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
" + "smithy.api#documentation": "\n [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
" } }, "Schedules": { "target": "com.amazonaws.dlm#ScheduleList", "traits": { - "smithy.api#documentation": "\n [Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy \n\t\t\tcan have up to four schedules—one mandatory schedule and up to three optional schedules.
" + "smithy.api#documentation": "\n [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy \n\t\t\tcan have up to four schedules—one mandatory schedule and up to three optional schedules.
" } }, "Parameters": { "target": "com.amazonaws.dlm#Parameters", "traits": { - "smithy.api#documentation": "\n [Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
\nIf you are modifying a policy that was created or previously modified using the Amazon \n\t\t\t\tData Lifecycle Manager console, then you must include this parameter and specify either \n\t\t\t\tthe default values or the new values that you require. You can't omit this parameter or \n\t\t\t\tset its values to null.
\n\n [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
\nIf you are modifying a policy that was created or previously modified using the Amazon \n\t\t\t\tData Lifecycle Manager console, then you must include this parameter and specify either \n\t\t\t\tthe default values or the new values that you require. You can't omit this parameter or \n\t\t\t\tset its values to null.
\n\n [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify \n\t\t\tonly one action per policy.
" } + }, + "PolicyLanguage": { + "target": "com.amazonaws.dlm#PolicyLanguageValues", + "traits": { + "smithy.api#documentation": "The type of policy to create. Specify one of the following:
\n\n SIMPLIFIED To create a default policy.
\n STANDARD To create a custom policy.
\n [Default policies only] Specify the type of default policy to create.
\nTo create a default policy for EBS snapshots, that creates snapshots of all volumes in the\n\t\t\t\t\tRegion that do not have recent backups, specify VOLUME.
To create a default policy for EBS-backed AMIs, that creates EBS-backed \n\t\t\t\t\tAMIs from all instances in the Region that do not have recent backups, specify \n\t\t\t\t\tINSTANCE.
\n [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. \n\t\t\tThe creation frequency can range from 1 to 7 days. If you do not specify a value, the \n\t\t\tdefault is 1.
\nDefault: 1
" + } + }, + "RetainInterval": { + "target": "com.amazonaws.dlm#RetainInterval", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies how long the policy should retain snapshots or AMIs before \n\t\t\tdeleting them. The retention period can range from 2 to 14 days, but it must be greater \n\t\t\tthan the creation frequency to ensure that the policy retains at least 1 snapshot or \n\t\t\tAMI at any given time. If you do not specify a value, the default is 7.
\nDefault: 7
" + } + }, + "CopyTags": { + "target": "com.amazonaws.dlm#CopyTagsNullable", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Indicates whether the policy should copy tags from the source resource \n\t\t\tto the snapshot or AMI. If you do not specify a value, the default is false.
Default: false
" + } + }, + "CrossRegionCopyTargets": { + "target": "com.amazonaws.dlm#CrossRegionCopyTargetList", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify \n\t\t\tup to 3 destination Regions. If you do not want to create cross-Region copies, omit this \n\t\t\tparameter.
" + } + }, + "ExtendDeletion": { + "target": "com.amazonaws.dlm#ExtendDeletion", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the \n\t\t\tsource volume or instance is deleted, or if the policy enters the error, disabled, or \n\t\t\tdeleted state.
\nBy default (ExtendDeletion=false):
\nIf a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously \n\t\t\t\t\tcreated snapshots or AMIs, up to but not including the last one, based on the \n\t\t\t\t\tspecified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, \n\t\t\t\t\tincluding the last one, specify true.
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting \n\t\t\t\t\tsnapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, \n\t\t\t\t\tincluding the last one, if the policy enters one of these states, specify \n\t\t\t\t\ttrue.
If you enable extended deletion (ExtendDeletion=true), \n\t\t\tyou override both default behaviors simultaneously.
\nIf you do not specify a value, the default is false.
Default: false
" + } + }, + "Exclusions": { + "target": "com.amazonaws.dlm#Exclusions", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies exclusion parameters for volumes or instances for which you \n\t\t\tdo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs \n\t\t\tfor target resources that match any of the specified exclusion parameters.
" + } } }, "traits": { - "smithy.api#documentation": "\n [All policy types] Specifies the configuration of a lifecycle policy.
" + "smithy.api#documentation": "Specifies the configuration of a lifecycle policy.
" } }, "com.amazonaws.dlm#PolicyId": { @@ -1288,7 +1528,7 @@ "min": 0, "max": 64 }, - "smithy.api#pattern": "^policy-[A-Za-z0-9]+$" + "smithy.api#pattern": "^policy-[a-f0-9]+$" } }, "com.amazonaws.dlm#PolicyIdList": { @@ -1297,6 +1537,23 @@ "target": "com.amazonaws.dlm#PolicyId" } }, + "com.amazonaws.dlm#PolicyLanguageValues": { + "type": "enum", + "members": { + "SIMPLIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIMPLIFIED" + } + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + } + } + }, "com.amazonaws.dlm#PolicyTypeValues": { "type": "enum", "members": { @@ -1406,6 +1663,14 @@ } } }, + "com.amazonaws.dlm#RetainInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.dlm#RetainRule": { "type": "structure", "members": { @@ -1429,7 +1694,7 @@ } }, "traits": { - "smithy.api#documentation": "\n [Snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs \n\t\t\tcreated by AMI policies.
\nFor snapshot policies that have an ArchiveRule, this retention rule\n\t\t\t\tapplies to standard tier retention. When the retention threshold is met, snapshots\n\t\t\t\tare moved from the standard to the archive tier.
\nFor snapshot policies that do not have an ArchiveRule, snapshots \n\t\t\t\tare permanently deleted when this retention threshold is met.
\nYou can retain snapshots based on either a count or a time interval.
\n\n Count-based retention\n
\nYou must specify Count. \n\t\t\t\t\tIf you specify an ArchiveRule for the schedule, then you can specify a retention count of \n\t\t\t\t\t0 to archive snapshots immediately after creation. If you specify a FastRestoreRule, \n\t\t\t\t\tShareRule, or a \n\t\t\t\t\tCrossRegionCopyRule, then you must specify a retention count \n\t\t\t\t\tof 1 or more.
\n Age-based retention\n
\nYou must specify Interval \n\t\t\t\t\tand IntervalUnit. If you specify an ArchiveRule for the \n\t\t\t\t\tschedule, then you can specify a retention interval of 0 days to archive snapshots immediately \n\t\t\t\t\tafter creation. If you specify a FastRestoreRule, ShareRule, or a \n\t\t\t\t\tCrossRegionCopyRule, \n\t\t\t\t\tthen you must specify a retention interval of 1 day or \n\t\t\t\t\tmore.
\n [Custom snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs \n\t\t\tcreated by AMI policies.
\nFor snapshot policies that have an ArchiveRule, this retention rule\n\t\t\t\tapplies to standard tier retention. When the retention threshold is met, snapshots\n\t\t\t\tare moved from the standard to the archive tier.
\nFor snapshot policies that do not have an ArchiveRule, snapshots \n\t\t\t\tare permanently deleted when this retention threshold is met.
\nYou can retain snapshots based on either a count or a time interval.
\n\n Count-based retention\n
\nYou must specify Count. \n\t\t\t\t\tIf you specify an ArchiveRule for the schedule, then you can specify a retention count of \n\t\t\t\t\t0 to archive snapshots immediately after creation. If you specify a FastRestoreRule, \n\t\t\t\t\tShareRule, or a \n\t\t\t\t\tCrossRegionCopyRule, then you must specify a retention count \n\t\t\t\t\tof 1 or more.
\n Age-based retention\n
\nYou must specify Interval \n\t\t\t\t\tand IntervalUnit. If you specify an ArchiveRule for the \n\t\t\t\t\tschedule, then you can specify a retention interval of 0 days to archive snapshots immediately \n\t\t\t\t\tafter creation. If you specify a FastRestoreRule, ShareRule, or a \n\t\t\t\t\tCrossRegionCopyRule, \n\t\t\t\t\tthen you must specify a retention interval of 1 day or \n\t\t\t\t\tmore.
\n [Snapshot policies only] Describes the retention rule for archived snapshots. Once the archive \n\t\t\tretention threshold is met, the snapshots are permanently deleted from the archive tier.
\nThe archive retention rule must retain snapshots in the archive tier for a minimum \n\t\t\t\tof 90 days.
\nFor count-based schedules, you must specify Count. For age-based\n\t\t\t\tschedules, you must specify Interval and\n\t\t\t\t IntervalUnit.
\nFor more information about using snapshot archiving, see Considerations for \n\t\t\tsnapshot lifecycle policies.
" + "smithy.api#documentation": "\n [Custom snapshot policies only] Describes the retention rule for archived snapshots. Once the archive \n\t\t\tretention threshold is met, the snapshots are permanently deleted from the archive tier.
\nThe archive retention rule must retain snapshots in the archive tier for a minimum \n\t\t\t\tof 90 days.
\nFor count-based schedules, you must specify Count. For age-based\n\t\t\t\tschedules, you must specify Interval and\n\t\t\t\t IntervalUnit.
\nFor more information about using snapshot archiving, see Considerations for \n\t\t\tsnapshot lifecycle policies.
" } }, "com.amazonaws.dlm#RetentionIntervalUnitValues": { @@ -1529,7 +1794,7 @@ "FastRestoreRule": { "target": "com.amazonaws.dlm#FastRestoreRule", "traits": { - "smithy.api#documentation": "\n [Snapshot policies only] The rule for enabling fast snapshot restore.
" + "smithy.api#documentation": "\n [Custom snapshot policies only] The rule for enabling fast snapshot restore.
" } }, "CrossRegionCopyRules": { @@ -1541,24 +1806,24 @@ "ShareRules": { "target": "com.amazonaws.dlm#ShareRules", "traits": { - "smithy.api#documentation": "\n [Snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
" + "smithy.api#documentation": "\n [Custom snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
" } }, "DeprecateRule": { "target": "com.amazonaws.dlm#DeprecateRule", "traits": { - "smithy.api#documentation": "\n [AMI policies only] The AMI deprecation rule for the schedule.
" + "smithy.api#documentation": "\n [Custom AMI policies only] The AMI deprecation rule for the schedule.
" } }, "ArchiveRule": { "target": "com.amazonaws.dlm#ArchiveRule", "traits": { - "smithy.api#documentation": "\n [Snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving \n\t\t\trule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's \n\t\t\tretention threshold is met. Snapshots are then retained in the archive tier for the archive retention \n\t\t\tperiod that you specify.
\nFor more information about using snapshot archiving, see Considerations for \n\t\t\t\tsnapshot lifecycle policies.
" + "smithy.api#documentation": "\n [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving \n\t\t\trule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's \n\t\t\tretention threshold is met. Snapshots are then retained in the archive tier for the archive retention \n\t\t\tperiod that you specify.
\nFor more information about using snapshot archiving, see Considerations for \n\t\t\t\tsnapshot lifecycle policies.
" } } }, "traits": { - "smithy.api#documentation": "\n [Snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
" + "smithy.api#documentation": "\n [Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
" } }, "com.amazonaws.dlm#ScheduleList": { @@ -1626,7 +1891,7 @@ } }, "traits": { - "smithy.api#documentation": "\n [Snapshot policies that target instances only] Information about pre and/or post scripts for a \n\t\t\tsnapshot lifecycle policy that targets instances. For more information, see \n\t\t\t\n\t\t\t\tAutomating application-consistent snapshots with pre and post scripts.
" + "smithy.api#documentation": "\n [Custom snapshot policies that target instances only] Information about pre and/or post scripts for a \n\t\t\tsnapshot lifecycle policy that targets instances. For more information, see \n\t\t\t\n\t\t\t\tAutomating application-consistent snapshots with pre and post scripts.
" } }, "com.amazonaws.dlm#ScriptExecutionTimeout": { @@ -1701,7 +1966,7 @@ } }, "traits": { - "smithy.api#documentation": "\n [Snapshot policies only] Specifies a rule for sharing snapshots across Amazon Web Services accounts.
" + "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies a rule for sharing snapshots across Amazon Web Services accounts.
" } }, "com.amazonaws.dlm#ShareRules": { @@ -2166,6 +2431,42 @@ "traits": { "smithy.api#documentation": "The configuration of the lifecycle policy. You cannot update the policy type or the\n\t\t\tresource type.
" } + }, + "CreateInterval": { + "target": "com.amazonaws.dlm#CreateInterval", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. \n\t\t\tThe creation frequency can range from 1 to 7 days.
" + } + }, + "RetainInterval": { + "target": "com.amazonaws.dlm#RetainInterval", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies how long the policy should retain snapshots or AMIs before \n\t\t\tdeleting them. The retention period can range from 2 to 14 days, but it must be greater \n\t\t\tthan the creation frequency to ensure that the policy retains at least 1 snapshot or \n\t\t\tAMI at any given time.
" + } + }, + "CopyTags": { + "target": "com.amazonaws.dlm#CopyTagsNullable", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Indicates whether the policy should copy tags from the source resource \n\t\t\tto the snapshot or AMI.
" + } + }, + "ExtendDeletion": { + "target": "com.amazonaws.dlm#ExtendDeletion", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the \n\t\t\tsource volume or instance is deleted, or if the policy enters the error, disabled, or \n\t\t\tdeleted state.
\nBy default (ExtendDeletion=false):
\nIf a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously \n\t\t\t\t\tcreated snapshots or AMIs, up to but not including the last one, based on the \n\t\t\t\t\tspecified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, \n\t\t\t\t\tincluding the last one, specify true.
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting \n\t\t\t\t\tsnapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, \n\t\t\t\t\tincluding the last one, if the policy enters one of these states, specify \n\t\t\t\t\ttrue.
If you enable extended deletion (ExtendDeletion=true), \n\t\t\tyou override both default behaviors simultaneously.
\nDefault: false
" + } + }, + "CrossRegionCopyTargets": { + "target": "com.amazonaws.dlm#CrossRegionCopyTargetList", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify \n\t\t\tup to 3 destination Regions. If you do not want to create cross-Region copies, omit this \n\t\t\tparameter.
" + } + }, + "Exclusions": { + "target": "com.amazonaws.dlm#Exclusions", + "traits": { + "smithy.api#documentation": "\n [Default policies only] Specifies exclusion parameters for volumes or instances for which you \n\t\t\tdo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs \n\t\t\tfor target resources that match any of the specified exclusion parameters.
" + } } }, "traits": { @@ -2191,6 +2492,9 @@ } } }, + "com.amazonaws.dlm#VolumeTypeValues": { + "type": "string" + }, "com.amazonaws.dlm#dlm_20180112": { "type": "service", "version": "2018-01-12", @@ -3195,17 +3499,6 @@ "expect": { "error": "Invalid Configuration: Missing Region" } - }, - { - "documentation": "Partition doesn't support DualStack", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } } ], "version": "1.0" diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 2af0b76c8fa..326c24105c8 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -2956,6 +2956,9 @@ { "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaces" }, + { + "target": "com.amazonaws.ec2#DescribeLockedSnapshots" + }, { "target": "com.amazonaws.ec2#DescribeManagedPrefixLists" }, @@ -3514,6 +3517,9 @@ { "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBin" }, + { + "target": "com.amazonaws.ec2#LockSnapshot" + }, { "target": "com.amazonaws.ec2#ModifyAddressAttribute" }, @@ -3898,6 +3904,9 @@ { "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddress" }, + { + "target": "com.amazonaws.ec2#UnlockSnapshot" + }, { "target": "com.amazonaws.ec2#UnmonitorInstances" }, @@ -12790,6 +12799,18 @@ } } }, + "com.amazonaws.ec2#CoolOffPeriodRequestHours": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 72 + } + } + }, + "com.amazonaws.ec2#CoolOffPeriodResponseHours": { + "type": "integer" + }, "com.amazonaws.ec2#CopyFpgaImage": { "type": "operation", "input": { @@ -19943,6 +19964,12 @@ "traits": { "smithy.api#documentation": "The ID of the tenant application with the device-identity provider.
" } + }, + "PublicSigningKeyUrl": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "\n The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.\n
" + } } }, "traits": { @@ -32943,6 +32970,91 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DescribeLockedSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeLockedSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeLockedSnapshotsResult" + }, + "traits": { + "smithy.api#documentation": "Describes the lock status for a snapshot.
" + } + }, + "com.amazonaws.ec2#DescribeLockedSnapshotsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeLockedSnapshotsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "The filters.
\n\n lock-state - The state of the snapshot lock (compliance-cooloff | \n governance | compliance | expired).
The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.
" + } + }, + "SnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", + "traits": { + "smithy.api#documentation": "The IDs of the snapshots for which to view the lock status.
", + "smithy.api#xmlName": "SnapshotId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Information about the snapshots.
", + "smithy.api#xmlName": "snapshotSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.
The ID of the tenant application with the device-identity provider.
", "smithy.api#xmlName": "tenantId" } + }, + "PublicSigningKeyUrl": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicSigningKeyUrl", + "smithy.api#documentation": "\n The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.\n
", + "smithy.api#xmlName": "publicSigningKeyUrl" + } } }, "traits": { @@ -41187,6 +41307,12 @@ "traits": { "smithy.api#enumValue": "crowdstrike" } + }, + "jumpcloud": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jumpcloud" + } } } }, @@ -63892,6 +64018,12 @@ "traits": { "smithy.api#enumValue": "r7i.48xlarge" } + }, + "dl2q_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dl2q.24xlarge" + } } } }, @@ -70515,6 +70647,273 @@ } } }, + "com.amazonaws.ec2#LockMode": { + "type": "enum", + "members": { + "compliance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compliance" + } + }, + "governance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "governance" + } + } + } + }, + "com.amazonaws.ec2#LockSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#LockSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.ec2#LockSnapshotResult" + }, + "traits": { + "smithy.api#documentation": "Locks an Amazon EBS snapshot in either governance or compliance \n mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot \n can't be deleted.
\nYou can also use this action to modify the lock settings for a snapshot that is already locked. The \n allowed modifications depend on the lock mode and lock state:
\nIf the snapshot is locked in governance mode, you can modify the lock mode and the lock duration \n or lock expiration date.
\nIf the snapshot is locked in compliance mode and it is in the cooling-off period, you can modify \n the lock mode and the lock duration or lock expiration date.
\nIf the snapshot is locked in compliance mode and the cooling-off period has lapsed, you can \n only increase the lock duration or extend the lock expiration date.
\nThe ID of the snapshot to lock.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The mode in which to lock the snapshot. Specify one of the following:
\n\n governance - Locks the snapshot in governance mode. Snapshots locked in governance \n mode can't be deleted until one of the following conditions are met:
The lock duration expires.
\nThe snapshot is unlocked by a user with the appropriate permissions.
\nUsers with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock \n duration, and change the lock mode to compliance at any time.
If you lock a snapshot in governance mode, omit \n CoolOffPeriod.
\n compliance - Locks the snapshot in compliance mode. Snapshots locked in compliance \n mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users \n can't decrease the lock duration or change the lock mode to governance. However, users \n with appropriate IAM permissions can increase the lock duration at any time.
If you lock a snapshot in compliance mode, you can optionally specify \n CoolOffPeriod.
The cooling-off period during which you can unlock the snapshot or modify the lock settings after \n locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't \n unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase \n the lock duration after the cooling-off period expires.
\nThe cooling-off period is optional when locking a snapshot in compliance mode. If you are locking \n the snapshot in governance mode, omit this parameter.
\nTo lock the snapshot in compliance mode immediately without a cooling-off period, omit this \n parameter.
\nIf you are extending the lock duration for a snapshot that is locked in compliance mode after \n the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such \n a request, the request fails.
\nAllowed values: Min 1, max 72.
" + } + }, + "LockDuration": { + "target": "com.amazonaws.ec2#RetentionPeriodRequestDays", + "traits": { + "smithy.api#documentation": "The period of time for which to lock the snapshot, in days. The snapshot lock will automatically \n expire after this period lapses.
\nYou must specify either this parameter or ExpirationDate, but \n not both.
\nAllowed values: Min: 1, max 36500
" + } + }, + "ExpirationDate": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "The date and time at which the snapshot lock is to automatically expire, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).
You must specify either this parameter or LockDuration, but \n not both.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#LockSnapshotResult": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "The ID of the snapshot
", + "smithy.api#xmlName": "snapshotId" + } + }, + "LockState": { + "target": "com.amazonaws.ec2#LockState", + "traits": { + "aws.protocols#ec2QueryName": "LockState", + "smithy.api#documentation": "The state of the snapshot lock. Valid states include:
\n\n compliance-cooloff - The snapshot has been locked in \n compliance mode but it is still within the cooling-off period. The snapshot can't be \n deleted, but it can be unlocked and the lock settings can be modified by users with \n appropriate permissions.
\n governance - The snapshot is locked in governance mode. The \n snapshot can't be deleted, but it can be unlocked and the lock settings can be \n modified by users with appropriate permissions.
\n compliance - The snapshot is locked in compliance mode and the \n cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock \n duration can only be increased by users with appropriate permissions.
\n expired - The snapshot was locked in compliance or governance \n mode but the lock duration has expired. The snapshot is not locked and can be deleted.
The period of time for which the snapshot is locked, in days.
", + "smithy.api#xmlName": "lockDuration" + } + }, + "CoolOffPeriod": { + "target": "com.amazonaws.ec2#CoolOffPeriodResponseHours", + "traits": { + "aws.protocols#ec2QueryName": "CoolOffPeriod", + "smithy.api#documentation": "The compliance mode cooling-off period, in hours.
", + "smithy.api#xmlName": "coolOffPeriod" + } + }, + "CoolOffPeriodExpiresOn": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CoolOffPeriodExpiresOn", + "smithy.api#documentation": "The date and time at which the compliance mode cooling-off period expires, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the snapshot was locked, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the lock will expire, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the lock duration started, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).
The account ID of the Amazon Web Services account that owns the snapshot.
", + "smithy.api#xmlName": "ownerId" + } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "The ID of the snapshot.
", + "smithy.api#xmlName": "snapshotId" + } + }, + "LockState": { + "target": "com.amazonaws.ec2#LockState", + "traits": { + "aws.protocols#ec2QueryName": "LockState", + "smithy.api#documentation": "The state of the snapshot lock. Valid states include:
\n\n compliance-cooloff - The snapshot has been locked in \n compliance mode but it is still within the cooling-off period. The snapshot can't be \n deleted, but it can be unlocked and the lock settings can be modified by users with \n appropriate permissions.
\n governance - The snapshot is locked in governance mode. The \n snapshot can't be deleted, but it can be unlocked and the lock settings can be \n modified by users with appropriate permissions.
\n compliance - The snapshot is locked in compliance mode and the \n cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock \n duration can only be increased by users with appropriate permissions.
\n expired - The snapshot was locked in compliance or governance \n mode but the lock duration has expired. The snapshot is not locked and can be deleted.
The period of time for which the snapshot is locked, in days.
", + "smithy.api#xmlName": "lockDuration" + } + }, + "CoolOffPeriod": { + "target": "com.amazonaws.ec2#CoolOffPeriodResponseHours", + "traits": { + "aws.protocols#ec2QueryName": "CoolOffPeriod", + "smithy.api#documentation": "The compliance mode cooling-off period, in hours.
", + "smithy.api#xmlName": "coolOffPeriod" + } + }, + "CoolOffPeriodExpiresOn": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CoolOffPeriodExpiresOn", + "smithy.api#documentation": "The date and time at which the compliance mode cooling-off period expires, in the UTC time zone \n (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the snapshot was locked, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the lock duration started, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
If you lock a snapshot that is in the pending state, the lock duration \n starts only once the snapshot enters the completed state.
The date and time at which the lock will expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
Information about a locked snapshot.
" + } + }, + "com.amazonaws.ec2#LockedSnapshotsInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#LockedSnapshotsInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#LogDestinationType": { "type": "enum", "members": { @@ -74912,6 +75311,20 @@ "smithy.api#documentation": "Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.
" } }, + "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderDeviceOptions": { + "type": "structure", + "members": { + "PublicSigningKeyUrl": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Modifies the configuration of the specified device-based Amazon Web Services Verified Access trust provider.
" + } + }, "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderOidcOptions": { "type": "structure", "members": { @@ -74979,6 +75392,12 @@ "smithy.api#documentation": "The options for an OpenID Connect-compatible user-identity trust provider.
" } }, + "DeviceOptions": { + "target": "com.amazonaws.ec2#ModifyVerifiedAccessTrustProviderDeviceOptions", + "traits": { + "smithy.api#documentation": "The options for a device-based trust provider. This parameter is required when the\n provider type is device.
Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode \n but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance \n mode after the cooling-off period has expired.
" + } + }, + "com.amazonaws.ec2#UnlockSnapshotRequest": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the snapshot to unlock.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the snapshot.
", + "smithy.api#xmlName": "snapshotId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#UnmonitorInstances": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/finspace-data.json b/codegen/sdk/aws-models/finspace-data.json index 6c9e2724795..2bc2fd0087f 100644 --- a/codegen/sdk/aws-models/finspace-data.json +++ b/codegen/sdk/aws-models/finspace-data.json @@ -956,6 +956,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
", "smithy.api#http": { "method": "POST", @@ -1417,6 +1420,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Creates a new Changeset in a FinSpace Dataset.
", "smithy.api#http": { "method": "POST", @@ -1520,6 +1526,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Creates a Dataview for a Dataset.
", "smithy.api#http": { "method": "POST", @@ -1638,6 +1647,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Creates a new FinSpace Dataset.
", "smithy.api#http": { "method": "POST", @@ -1751,6 +1763,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Creates a group of permissions for various actions that a user can perform in FinSpace.
", "smithy.api#http": { "method": "POST", @@ -1837,6 +1852,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Creates a new user in FinSpace.
", "smithy.api#http": { "method": "POST", @@ -2384,6 +2402,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Deletes a FinSpace Dataset.
", "smithy.api#http": { "method": "DELETE", @@ -2464,6 +2485,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Deletes a permission group. This action is irreversible.
", "smithy.api#http": { "method": "DELETE", @@ -2539,6 +2563,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Denies access to the FinSpace web application and API for the specified user.
", "smithy.api#http": { "method": "POST", @@ -2613,6 +2640,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Removes a user from a permission group.
", "smithy.api#http": { "method": "DELETE", @@ -2712,6 +2742,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Allows the specified user to access the FinSpace web application and API.
", "smithy.api#http": { "method": "POST", @@ -2898,6 +2931,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Get information about a Changeset.
", "smithy.api#http": { "method": "GET", @@ -3047,6 +3083,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Gets information about a Dataview.
", "smithy.api#http": { "method": "GET", @@ -3194,6 +3233,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Returns information about a Dataset.
", "smithy.api#http": { "method": "GET", @@ -3316,6 +3358,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Returns the credentials to access the external Dataview from an S3 location. To call this API:
\nYou must retrieve the programmatic credentials.
\nYou must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.
Retrieves the details of a specific permission group.
", "smithy.api#http": { "method": "GET", @@ -3452,6 +3500,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.
", "smithy.api#http": { "method": "GET", @@ -3531,6 +3582,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Retrieves details for a specific user.
", "smithy.api#http": { "method": "GET", @@ -3669,6 +3723,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "A temporary Amazon S3 location, where you can copy your files from a source location to stage or use\n as a scratch space in FinSpace notebook.
", "smithy.api#http": { "method": "POST", @@ -3830,6 +3887,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Lists the FinSpace Changesets for a Dataset.
", "smithy.api#http": { "method": "GET", @@ -3922,6 +3982,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Lists all available Dataviews for a Dataset.
", "smithy.api#http": { "method": "GET", @@ -4013,6 +4076,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Lists all of the active Datasets that a user has access to.
", "smithy.api#http": { "method": "GET", @@ -4094,6 +4160,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Lists all available permission groups in FinSpace.
", "smithy.api#http": { "method": "GET", @@ -4134,6 +4203,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Lists all the permission groups that are associated with a specific user.
", "smithy.api#http": { "method": "GET", @@ -4259,6 +4331,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Lists all available users in FinSpace.
", "smithy.api#http": { "method": "GET", @@ -4299,6 +4374,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Lists details of all the users in a specific permission group.
", "smithy.api#http": { "method": "GET", @@ -4640,6 +4718,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.
", "smithy.api#http": { "method": "POST", @@ -4988,6 +5069,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Updates a FinSpace Changeset.
", "smithy.api#http": { "method": "PUT", @@ -5092,6 +5176,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Updates a FinSpace Dataset.
", "smithy.api#http": { "method": "PUT", @@ -5200,6 +5287,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Modifies the details of a permission group. You cannot modify a permissionGroupID.
Modifies the details of the specified user. You cannot update the userId for a user.
Create a new FinSpace environment.
", "smithy.api#http": { "method": "POST", @@ -2155,6 +2161,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Delete an FinSpace environment.
", "smithy.api#http": { "method": "DELETE", @@ -2913,6 +2922,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Returns the FinSpace environment object.
", "smithy.api#http": { "method": "GET", @@ -3854,7 +3866,7 @@ "type": { "target": "com.amazonaws.finspace#KxCacheStorageType", "traits": { - "smithy.api#documentation": "The type of cache storage . The valid values are:
\nCACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
\nThe type of cache storage. The valid values are:
\nCACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
\nCACHE_250 – This type provides at least 250 MB/s disk access throughput.
\nCACHE_12 – This type provides at least 12 MB/s disk access throughput.
\nFor cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.
The details of a kdb cluster.
" } }, + "com.amazonaws.finspace#KxClusterCodeDeploymentConfiguration": { + "type": "structure", + "members": { + "deploymentStrategy": { + "target": "com.amazonaws.finspace#KxClusterCodeDeploymentStrategy", + "traits": { + "smithy.api#documentation": "\n The type of deployment that you want on a cluster.\n \n
\nROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
\nFORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.
\n\n The configuration that allows you to choose how you want to update code on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.\n
" + } + }, + "com.amazonaws.finspace#KxClusterCodeDeploymentStrategy": { + "type": "enum", + "members": { + "ROLLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLING" + } + }, + "FORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORCE" + } + } + } + }, "com.amazonaws.finspace#KxClusterDescription": { "type": "string", "traits": { @@ -4284,13 +4328,13 @@ "deploymentStrategy": { "target": "com.amazonaws.finspace#KxDeploymentStrategy", "traits": { - "smithy.api#documentation": "\n The type of deployment that you want on a cluster.\n \n
\nROLLING – This options loads the updated database by stopping the exiting q process and starting a new q process with updated configuration.
\nNO_RESTART – This option loads the updated database on the running q process without stopping it. This option is quicker as it reduces the turn around time to update a kdb database changeset configuration on a cluster.
\n\n The type of deployment that you want on a cluster.\n \n
\nROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
\nNO_RESTART – This option updates the cluster without stopping the running q process. It is only available for HDB type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.
With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.
\n The configuration that allows you to choose how you want to update the databases on a cluster. Depending on the option you choose, you can reduce the time it takes to update the database changesets on to a cluster.\n
" + "smithy.api#documentation": "\n The configuration that allows you to choose how you want to update the databases on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.\n
" } }, "com.amazonaws.finspace#KxDeploymentStrategy": { @@ -4614,6 +4658,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "A list of all of your FinSpace environments.
", "smithy.api#http": { "method": "GET", @@ -5889,6 +5936,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, "smithy.api#documentation": "Update your FinSpace environment.
", "smithy.api#http": { "method": "PUT", @@ -5948,6 +5998,108 @@ "smithy.api#output": {} } }, + "com.amazonaws.finspace#UpdateKxClusterCodeConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. \n The configuration that you want to update will override any existing configurations on the cluster. \n
", + "smithy.api#http": { + "method": "PUT", + "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/code", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "\n A unique identifier of the kdb environment.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "The name of the cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + }, + "code": { + "target": "com.amazonaws.finspace#CodeConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "initializationScript": { + "target": "com.amazonaws.finspace#InitializationScriptFilePath", + "traits": { + "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
Specifies the key-value pairs to make them available inside the cluster.
" + } + }, + "deploymentConfiguration": { + "target": "com.amazonaws.finspace#KxClusterCodeDeploymentConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that allows you to choose how you want to update the code on a cluster.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.finspace#UpdateKxClusterDatabases": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index 68d8f9a789c..8e894bd4a02 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.json @@ -1403,7 +1403,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem), or CLI\n (update-file-system).
\n THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a THROUGHPUT_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n THROUGHPUT_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n throughput capacity in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n and throughput capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a IOPS_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n IOPS_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n provisioned SSD IOPS in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a STORAGE_TYPE_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_TYPE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED.
\n VOLUME_UPDATE - A volume update to an Amazon FSx for NetApp ONTAP or\n Amazon FSx for OpenZFS volume initiated from the Amazon FSx\n console, API (UpdateVolume), or CLI\n (update-volume).
\n VOLUME_RESTORE - An Amazon FSx for OpenZFS volume\n is returned to the state saved by the specified snapshot, initiated from an\n API (RestoreVolumeFromSnapshot) or CLI\n (restore-volume-from-snapshot).
\n SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot), or CLI (update-snapshot).
\n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem), or CLI\n (update-file-system).
\n THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a THROUGHPUT_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n THROUGHPUT_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n throughput capacity in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a IOPS_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n IOPS_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n provisioned SSD IOPS in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a STORAGE_TYPE_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_TYPE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED.
\n VOLUME_UPDATE - A volume update to an Amazon FSx for NetApp ONTAP or\n Amazon FSx for OpenZFS volume initiated from the Amazon FSx\n console, API (UpdateVolume), or CLI\n (update-volume).
\n VOLUME_RESTORE - An Amazon FSx for OpenZFS volume\n is returned to the state saved by the specified snapshot, initiated from an\n API (RestoreVolumeFromSnapshot) or CLI\n (restore-volume-from-snapshot).
\n SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot), or CLI (update-snapshot).
\n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n SelfManagedActiveDirectoryConfiguration\n
\n StorageCapacity\n
\n StorageType\n
\n ThroughputCapacity\n
\n DiskIopsConfiguration\n
\n WeeklyMaintenanceStartTime\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DataCompressionType\n
\n LogConfiguration\n
\n LustreRootSquashConfiguration\n
\n StorageCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n FsxAdminPassword\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n CopyTagsToBackups\n
\n CopyTagsToVolumes\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n SelfManagedActiveDirectoryConfiguration\n
\n StorageCapacity\n
\n StorageType\n
\n ThroughputCapacity\n
\n DiskIopsConfiguration\n
\n WeeklyMaintenanceStartTime\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DataCompressionType\n
\n LogConfiguration\n
\n LustreRootSquashConfiguration\n
\n PerUnitStorageThroughput\n
\n StorageCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n FsxAdminPassword\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n CopyTagsToBackups\n
\n CopyTagsToVolumes\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
The Lustre root squash configuration used when updating an Amazon FSx for Lustre\n file system. When enabled, root squash restricts root-level access from clients that\n try to access your file system as a root user.
" } + }, + "PerUnitStorageThroughput": { + "target": "com.amazonaws.fsx#PerUnitStorageThroughput", + "traits": { + "smithy.api#documentation": "The throughput of an Amazon FSx for Lustre Persistent SSD-based file system,\n measured in megabytes per second per tebibyte (MB/s/TiB). You can increase or decrease\n your file system's throughput. Valid values depend on the deployment type of the file\n system, as follows:
\nFor PERSISTENT_1 SSD-based deployment types, valid values\n are 50, 100, and 200 MB/s/TiB.
For PERSISTENT_2 SSD-based deployment types, valid values\n are 125, 250, 500, and 1000 MB/s/TiB.
For more information, see \n \n Managing throughput capacity.
" + } } }, "traits": { @@ -10950,7 +10956,7 @@ "ThroughputCapacity": { "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second\u2028 (MB/s). Valid values depend on the DeploymentType you choose, as follows:
\nFor MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640,\n 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\u2028 (MB/s). Valid values depend on the DeploymentType you choose, as follows:
\nFor MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640,\n 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.
A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An exception thrown when you try to stop a task run when there is no task running.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskRun": { + "type": "structure", + "members": { + "CustomerId": { + "target": "com.amazonaws.glue#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
" + } + }, + "ColumnStatisticsTaskRunId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "The identifier for the particular column statistics task run.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#DatabaseName", + "traits": { + "smithy.api#documentation": "The database where the table resides.
" + } + }, + "TableName": { + "target": "com.amazonaws.glue#TableName", + "traits": { + "smithy.api#documentation": "The name of the table for which column statistics is generated.
" + } + }, + "ColumnNameList": { + "target": "com.amazonaws.glue#ColumnNameList", + "traits": { + "smithy.api#documentation": "A list of the column names. If none is supplied, all column names for the table will be used by default.
" + } + }, + "CatalogID": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.glue#Role", + "traits": { + "smithy.api#documentation": "The IAM role that the service assumes to generate statistics.
" + } + }, + "SampleSize": { + "target": "com.amazonaws.glue#SampleSizePercentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
" + } + }, + "SecurityConfiguration": { + "target": "com.amazonaws.glue#CrawlerSecurityConfiguration", + "traits": { + "smithy.api#documentation": "Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
" + } + }, + "NumberOfWorkers": { + "target": "com.amazonaws.glue#PositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
" + } + }, + "WorkerType": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The type of workers being used for generating stats. The default is g.1x.
The status of the task run.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this task was created.
" + } + }, + "LastUpdated": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The last point in time when this task was modified.
" + } + }, + "StartTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the task.
" + } + }, + "EndTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the task.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "The error message for the job.
" + } + }, + "DPUSeconds": { + "target": "com.amazonaws.glue#NonNegativeDouble", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The calculated DPU usage in seconds for all autoscaled workers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object that shows the details of the column stats run.
" + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskRunIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#HashString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskRunningException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An exception thrown when you try to start another job while running a column stats generation job.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskRunsList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRun" + } + }, + "com.amazonaws.glue#ColumnStatisticsTaskStoppingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An exception thrown when you try to stop a task run.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.glue#ColumnStatisticsType": { "type": "enum", "members": { @@ -15036,6 +15263,134 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#GetColumnStatisticsTaskRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetColumnStatisticsTaskRunRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetColumnStatisticsTaskRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Get the associated metadata/information for a task run, given a task run ID.
" + } + }, + "com.amazonaws.glue#GetColumnStatisticsTaskRunRequest": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRunId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "The identifier for the particular column statistics task run.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetColumnStatisticsTaskRunResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRun": { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRun", + "traits": { + "smithy.api#documentation": "A ColumnStatisticsTaskRun object representing the details of the column stats run.
Retrieves information about all runs associated with the specified table.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#GetColumnStatisticsTaskRunsRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.glue#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database where the table resides.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the table.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "The maximum size of the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is a continuation call.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetColumnStatisticsTaskRunsResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRuns": { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRunsList", + "traits": { + "smithy.api#documentation": "A list of column statistics task runs.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if not all task runs have yet been returned.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#GetConnection": { "type": "operation", "input": { @@ -22614,6 +22969,68 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#ListColumnStatisticsTaskRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListColumnStatisticsTaskRunsRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListColumnStatisticsTaskRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "List all task runs for a particular account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#ListColumnStatisticsTaskRunsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "The maximum size of the response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if this is a continuation call.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#ListColumnStatisticsTaskRunsResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRunIds": { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRunIdList", + "traits": { + "smithy.api#documentation": "A list of column statistics task run IDs.
" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "A continuation token, if not all task run IDs have yet been returned.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#ListCrawlers": { "type": "operation", "input": { @@ -26024,6 +26441,15 @@ } } }, + "com.amazonaws.glue#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.glue#PositiveLong": { "type": "long", "traits": { @@ -28687,6 +29113,16 @@ "target": "com.amazonaws.glue#S3Target" } }, + "com.amazonaws.glue#SampleSizePercentage": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.glue#ScalaCode": { "type": "string" }, @@ -30349,6 +30785,106 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#StartColumnStatisticsTaskRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#StartColumnStatisticsTaskRunRequest" + }, + "output": { + "target": "com.amazonaws.glue#StartColumnStatisticsTaskRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ColumnStatisticsTaskRunningException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a column statistics task run, for a specified table and columns.
" + } + }, + "com.amazonaws.glue#StartColumnStatisticsTaskRunRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the database where the table resides.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the table to generate statistics.
", + "smithy.api#required": {} + } + }, + "ColumnNameList": { + "target": "com.amazonaws.glue#ColumnNameList", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The IAM role that the service assumes to generate statistics.
", + "smithy.api#required": {} + } + }, + "SampleSize": { + "target": "com.amazonaws.glue#SampleSizePercentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
" + } + }, + "CatalogID": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#StartColumnStatisticsTaskRunResponse": { + "type": "structure", + "members": { + "ColumnStatisticsTaskRunId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "The identifier for the column statistics task run.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#StartCrawler": { "type": "operation", "input": { @@ -31357,6 +31893,61 @@ } } }, + "com.amazonaws.glue#StopColumnStatisticsTaskRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#StopColumnStatisticsTaskRunRequest" + }, + "output": { + "target": "com.amazonaws.glue#StopColumnStatisticsTaskRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#ColumnStatisticsTaskNotRunningException" + }, + { + "target": "com.amazonaws.glue#ColumnStatisticsTaskStoppingException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a task run for the specified table.
" + } + }, + "com.amazonaws.glue#StopColumnStatisticsTaskRunRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.glue#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database where the table resides.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the table.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#StopColumnStatisticsTaskRunResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#StopCrawler": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/imagebuilder.json b/codegen/sdk/aws-models/imagebuilder.json index a5309131504..ead8fba46c8 100644 --- a/codegen/sdk/aws-models/imagebuilder.json +++ b/codegen/sdk/aws-models/imagebuilder.json @@ -311,7 +311,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token that was used for this request.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "imageBuildVersionArn": { @@ -325,6 +325,86 @@ "smithy.api#output": {} } }, + "com.amazonaws.imagebuilder#CancelLifecycleExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CancelLifecycleExecutionRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CancelLifecycleExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Cancel a specific image lifecycle policy runtime instance.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/CancelLifecycleExecution", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#CancelLifecycleExecutionRequest": { + "type": "structure", + "members": { + "lifecycleExecutionId": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", + "traits": { + "smithy.api#documentation": "Identifies the specific runtime instance of the image lifecycle to cancel.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#CancelLifecycleExecutionResponse": { + "type": "structure", + "members": { + "lifecycleExecutionId": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", + "traits": { + "smithy.api#documentation": "The unique identifier for the image lifecycle runtime instance that was canceled.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.imagebuilder#ClientException": { "type": "structure", "members": { @@ -1235,7 +1315,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token of the component.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1257,13 +1337,13 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "componentBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the component that this request created.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the component that the request created.
" } } }, @@ -1425,7 +1505,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The client token used to make this request idempotent.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1447,7 +1527,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The client token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "containerRecipeArn": { @@ -1545,7 +1625,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token of the distribution configuration.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1567,7 +1647,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "distributionConfigurationArn": { @@ -1750,7 +1830,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1778,7 +1858,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "imagePipelineArn": { @@ -1908,7 +1988,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1930,7 +2010,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "imageRecipeArn": { @@ -1993,7 +2073,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -2021,13 +2101,13 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the image that this request created.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the image that the request created.
" } } }, @@ -2170,7 +2250,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -2192,7 +2272,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "infrastructureConfigurationArn": { @@ -2206,6 +2286,144 @@ "smithy.api#output": {} } }, + "com.amazonaws.imagebuilder#CreateLifecyclePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CreateLifecyclePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CreateLifecyclePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Create a lifecycle policy resource.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/CreateLifecyclePolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#CreateLifecyclePolicyRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the lifecycle policy to create.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "Optional description for the lifecycle policy.
" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyStatus", + "traits": { + "smithy.api#documentation": "Indicates whether the lifecycle policy resource is enabled.
" + } + }, + "executionRole": { + "target": "com.amazonaws.imagebuilder#RoleNameOrArn", + "traits": { + "smithy.api#documentation": "The role name or Amazon Resource Name (ARN) for the IAM role that grants \n\t\t\tImage Builder access to run lifecycle actions.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceType", + "traits": { + "smithy.api#documentation": "The type of Image Builder resource that the lifecycle policy applies to.
", + "smithy.api#required": {} + } + }, + "policyDetails": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetails", + "traits": { + "smithy.api#documentation": "Configuration details for the lifecycle policy rules.
", + "smithy.api#required": {} + } + }, + "resourceSelection": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelection", + "traits": { + "smithy.api#documentation": "Selection criteria for the resources that the lifecycle policy applies to.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "Tags to apply to the lifecycle policy resource.
" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#CreateLifecyclePolicyResponse": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "The client token that uniquely identifies the request.
" + } + }, + "lifecyclePolicyArn": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle policy that the request created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.imagebuilder#CvssScore": { "type": "structure", "members": { @@ -2852,6 +3070,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.imagebuilder#DeleteLifecyclePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#DeleteLifecyclePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#DeleteLifecyclePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceDependencyException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Delete the specified lifecycle policy resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteLifecyclePolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#DeleteLifecyclePolicyRequest": { + "type": "structure", + "members": { + "lifecyclePolicyArn": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle policy resource to delete.
", + "smithy.api#httpQuery": "lifecyclePolicyArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#DeleteLifecyclePolicyResponse": { + "type": "structure", + "members": { + "lifecyclePolicyArn": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", + "traits": { + "smithy.api#documentation": "The ARN of the lifecycle policy that was deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.imagebuilder#DiskImageFormat": { "type": "enum", "members": { @@ -4191,13 +4479,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#GetWorkflowExecution": { + "com.amazonaws.imagebuilder#GetLifecycleExecution": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest" + "target": "com.amazonaws.imagebuilder#GetLifecycleExecutionRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse" + "target": "com.amazonaws.imagebuilder#GetLifecycleExecutionResponse" }, "errors": [ { @@ -4220,22 +4508,22 @@ } ], "traits": { - "smithy.api#documentation": "Get the runtime information that was logged for a specific runtime instance \n\t\t\tof the workflow.
", + "smithy.api#documentation": "Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.
", "smithy.api#http": { "method": "GET", - "uri": "/GetWorkflowExecution", + "uri": "/GetLifecycleExecution", "code": 200 } } }, - "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest": { + "com.amazonaws.imagebuilder#GetLifecycleExecutionRequest": { "type": "structure", "members": { - "workflowExecutionId": { - "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", + "lifecycleExecutionId": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { - "smithy.api#documentation": "Use the unique identifier for a runtime instance of the workflow to get \n\t\t\truntime details.
", - "smithy.api#httpQuery": "workflowExecutionId", + "smithy.api#documentation": "Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.
", + "smithy.api#httpQuery": "lifecycleExecutionId", "smithy.api#required": {} } } @@ -4244,16 +4532,150 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse": { + "com.amazonaws.imagebuilder#GetLifecycleExecutionResponse": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "lifecycleExecution": { + "target": "com.amazonaws.imagebuilder#LifecycleExecution", "traits": { - "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + "smithy.api#documentation": "Runtime details for the specified runtime instance of the lifecycle policy.
" } - }, - "workflowBuildVersionArn": { + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetLifecyclePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetLifecyclePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetLifecyclePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Get details for the specified image lifecycle policy.
", + "smithy.api#http": { + "method": "GET", + "uri": "/GetLifecyclePolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetLifecyclePolicyRequest": { + "type": "structure", + "members": { + "lifecyclePolicyArn": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", + "traits": { + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.
", + "smithy.api#httpQuery": "lifecyclePolicyArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetLifecyclePolicyResponse": { + "type": "structure", + "members": { + "lifecyclePolicy": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicy", + "traits": { + "smithy.api#documentation": "The ARN of the image lifecycle policy resource that was returned.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#GetWorkflowExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Get the runtime information that was logged for a specific runtime instance \n\t\t\tof the workflow.
", + "smithy.api#http": { + "method": "GET", + "uri": "/GetWorkflowExecution", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetWorkflowExecutionRequest": { + "type": "structure", + "members": { + "workflowExecutionId": { + "target": "com.amazonaws.imagebuilder#WorkflowExecutionId", + "traits": { + "smithy.api#documentation": "Use the unique identifier for a runtime instance of the workflow to get \n\t\t\truntime details.
", + "smithy.api#httpQuery": "workflowExecutionId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#GetWorkflowExecutionResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + } + }, + "workflowBuildVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowBuildVersionArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource \n\t\t\tthat defines the specified runtime instance of the workflow.
" @@ -4659,6 +5081,18 @@ "traits": { "smithy.api#documentation": "Contains settings for vulnerability scans.
" } + }, + "deprecationTime": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The time when deprecation occurs for an image resource. This can be a past or future date.
" + } + }, + "lifecycleExecutionId": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", + "traits": { + "smithy.api#documentation": "Identifies the last runtime instance of the lifecycle policy to take action on the image.
" + } } }, "traits": { @@ -4703,7 +5137,7 @@ "com.amazonaws.imagebuilder#ImageBuilderArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$" + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$" } }, "com.amazonaws.imagebuilder#ImagePackage": { @@ -5424,6 +5858,12 @@ "traits": { "smithy.api#enumValue": "DELETED" } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } } } }, @@ -5507,6 +5947,18 @@ "traits": { "smithy.api#documentation": "The origin of the base image that Image Builder used to build this image.
" } + }, + "deprecationTime": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The time when deprecation occurs for an image resource. This can be a past or future date.
" + } + }, + "lifecycleExecutionId": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", + "traits": { + "smithy.api#documentation": "Identifies the last runtime instance of the lifecycle policy to take action on the image.
" + } } }, "traits": { @@ -5777,7 +6229,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token of the component.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -5799,7 +6251,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "componentBuildVersionArn": { @@ -5921,7 +6373,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token that was used for this request.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } } }, @@ -6412,112 +6864,1284 @@ } } }, - "com.amazonaws.imagebuilder#ListComponentBuildVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest" - }, - "output": { - "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" - }, - { - "target": "com.amazonaws.imagebuilder#ClientException" + "com.amazonaws.imagebuilder#LifecycleExecution": { + "type": "structure", + "members": { + "lifecycleExecutionId": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", + "traits": { + "smithy.api#documentation": "Identifies the lifecycle policy runtime instance.
" + } }, - { - "target": "com.amazonaws.imagebuilder#ForbiddenException" + "lifecyclePolicyArn": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle policy that ran.
" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + "resourcesImpactedSummary": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourcesImpactedSummary", + "traits": { + "smithy.api#documentation": "Contains information about associated resources that are identified for action by \n\t\t\tthe runtime instance of the lifecycle policy.
" + } }, - { - "target": "com.amazonaws.imagebuilder#InvalidRequestException" + "state": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionState", + "traits": { + "smithy.api#documentation": "Runtime state that reports if the policy action ran successfully, \n\t\t\tfailed, or was skipped.
" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceException" + "startTime": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the lifecycle runtime instance started.
" + } }, - { - "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + "endTime": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the lifecycle runtime instance completed.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Returns the list of component build versions for the specified semantic\n\t\t\tversion.
\nThe semantic version has four nodes:
\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.
\nContains metadata from a runtime instance of a lifecycle policy.
" } }, - "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest": { + "com.amazonaws.imagebuilder#LifecycleExecutionId": { + "type": "string", + "traits": { + "smithy.api#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}$" + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionResource": { "type": "structure", "members": { - "componentVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentVersionArn", + "accountId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "The component version Amazon Resource Name (ARN) whose versions you want to\n\t\t\tlist.
", - "smithy.api#required": {} + "smithy.api#documentation": "The account that owns the impacted resource.
" } }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "resourceId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "The maximum items to return in a request.
" + "smithy.api#documentation": "Identifies the impacted resource. The resource ID depends on the type of \n\t\t\tresource, as follows.
\nImage Builder image resources: Amazon Resource Name (ARN)
\nDistributed AMIs: AMI ID
\nContainer images distributed to an ECR repository: image URI or SHA Digest
\nThe runtime state for the lifecycle execution.
" + } + }, + "action": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceAction", + "traits": { + "smithy.api#documentation": "The action to take for the identified resource.
" + } + }, + "region": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region where the lifecycle execution resource is stored.
" + } + }, + "snapshots": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionSnapshotResourceList", + "traits": { + "smithy.api#documentation": "A list of associated resource snapshots for the impacted resource if \n\t\t\tit’s an AMI.
" + } + }, + "imageUris": { + "target": "com.amazonaws.imagebuilder#StringList", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "For an impacted container image, this identifies a list of URIs for associated \n\t\t\tcontainer images distributed to ECR repositories.
" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Contains details for a resource that the runtime instance of the \n\t\t\tlifecycle policy identified for action.
" } }, - "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse": { + "com.amazonaws.imagebuilder#LifecycleExecutionResourceAction": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "The request ID that uniquely identifies this request.
" - } - }, - "componentSummaryList": { - "target": "com.amazonaws.imagebuilder#ComponentSummaryList", + "name": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceActionName", "traits": { - "smithy.api#documentation": "The list of component summaries for the specified semantic version.
" + "smithy.api#documentation": "The name of the resource that was identified for a lifecycle policy action.
" } }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#PaginationToken", + "reason": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The reason why the lifecycle policy action is taken.
" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "The lifecycle policy action that was identified for the impacted resource.
" } }, - "com.amazonaws.imagebuilder#ListComponents": { - "type": "operation", - "input": { - "target": "com.amazonaws.imagebuilder#ListComponentsRequest" + "com.amazonaws.imagebuilder#LifecycleExecutionResourceActionName": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "DEPRECATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATE" + } + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE" + } + } + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionResource" + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionResourceState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceStatus", + "traits": { + "smithy.api#documentation": "The runtime status of the lifecycle action taken for the \n\t\t\timpacted resource.
" + } + }, + "reason": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "Messaging that clarifies the reason for the assigned status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the state of an impacted resource that the runtime instance \n\t\t\tof the lifecycle policy identified for action.
" + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionResourceStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + } + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionResourcesImpactedSummary": { + "type": "structure", + "members": { + "hasImpactedResources": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether an image resource that was identified for a lifecycle action has \n\t\t\tassociated resources that are also impacted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details for an image resource that was identified for a lifecycle action.
" + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionSnapshotResource": { + "type": "structure", + "members": { + "snapshotId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "Identifies the impacted snapshot resource.
" + } + }, + "state": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceState", + "traits": { + "smithy.api#documentation": "The runtime status of the lifecycle action taken for the snapshot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the state of an impacted snapshot resource that the runtime \n\t\t\tinstance of the lifecycle policy identified for action.
" + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionSnapshotResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionSnapshotResource" + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionStatus", + "traits": { + "smithy.api#documentation": "The runtime status of the lifecycle execution.
" + } + }, + "reason": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The reason for the current status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The current state of the runtime instance of the lifecycle policy.
" + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + } + } + }, + "com.amazonaws.imagebuilder#LifecycleExecutionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#LifecycleExecution" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicy": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle policy resource.
" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the lifecycle policy.
" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "Optional description for the lifecycle policy.
" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyStatus", + "traits": { + "smithy.api#documentation": "Indicates whether the lifecycle policy resource is enabled.
" + } + }, + "executionRole": { + "target": "com.amazonaws.imagebuilder#RoleNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the IAM role that Image Builder uses to run the lifecycle policy. \n\t\t\tThis is a custom role that you create.
" + } + }, + "resourceType": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceType", + "traits": { + "smithy.api#documentation": "The type of resources the lifecycle policy targets.
" + } + }, + "policyDetails": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetails", + "traits": { + "smithy.api#documentation": "The configuration details for a lifecycle policy resource.
" + } + }, + "resourceSelection": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelection", + "traits": { + "smithy.api#documentation": "Resource selection criteria used to run the lifecycle policy.
" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when Image Builder created the lifecycle policy resource.
" + } + }, + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when Image Builder updated the lifecycle policy resource.
" + } + }, + "dateLastRun": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for the last time Image Builder ran the lifecycle policy.
" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "To help manage your lifecycle policy resources, you can assign your own \n\t\t\tmetadata to each resource in the form of tags. Each tag consists of a key and \n\t\t\tan optional value, both of which you define.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for a lifecycle policy resource.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):lifecycle-policy/[a-z0-9-_]+$" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetail": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailAction", + "traits": { + "smithy.api#documentation": "Configuration details for the policy action.
", + "smithy.api#required": {} + } + }, + "filter": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilter", + "traits": { + "smithy.api#documentation": "Specifies the resources that the lifecycle policy applies to.
", + "smithy.api#required": {} + } + }, + "exclusionRules": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRules", + "traits": { + "smithy.api#documentation": "Additional rules to specify resources that should be exempt from policy actions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for a lifecycle policy resource.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailAction": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailActionType", + "traits": { + "smithy.api#documentation": "Specifies the lifecycle action to take.
", + "smithy.api#required": {} + } + }, + "includeResources": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailActionIncludeResources", + "traits": { + "smithy.api#documentation": "Specifies the resources that the lifecycle policy applies to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains selection criteria for the lifecycle policy.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailActionIncludeResources": { + "type": "structure", + "members": { + "amis": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the lifecycle action should apply to distributed AMIs.
" + } + }, + "snapshots": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.
" + } + }, + "containers": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the lifecycle action should apply to distributed containers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies how the lifecycle policy should apply actions to selected resources.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailActionType": { + "type": "enum", + "members": { + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "DEPRECATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATE" + } + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE" + } + } + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRules": { + "type": "structure", + "members": { + "tagMap": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "Contains a list of tags that Image Builder uses to skip lifecycle actions for AMIs that have them.
" + } + }, + "amis": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmis", + "traits": { + "smithy.api#documentation": "Lists configuration values that apply to AMIs that Image Builder should exclude \n\t\t\tfrom the lifecycle action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies resources that lifecycle policy actions should not apply to.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmis": { + "type": "structure", + "members": { + "isPublic": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Configures whether public AMIs are excluded from the lifecycle action.
" + } + }, + "regions": { + "target": "com.amazonaws.imagebuilder#StringList", + "traits": { + "smithy.api#documentation": "Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.
" + } + }, + "sharedAccounts": { + "target": "com.amazonaws.imagebuilder#AccountList", + "traits": { + "smithy.api#documentation": "Specifies configuration details for Image Builder to exclude the most recent resources \n\t\t\tfrom lifecycle actions.
" + } + }, + "lastLaunched": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmisLastLaunched", + "traits": { + "smithy.api#documentation": "Configures Amazon Web Services Regions that are excluded from the lifecycle action.
" + } + }, + "tagMap": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "Lists tags that should be excluded from lifecycle actions for the AMIs that have them.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines criteria for AMIs that are excluded from lifecycle actions.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmisLastLaunched": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmisLastLaunchedValue", + "traits": { + "smithy.api#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 \n\t\t\tsince the last instance launched from the AMI. For example: days, weeks, months, or years.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines criteria to exclude AMIs from lifecycle actions based on the last \n\t\t\ttime they were used to launch an instance.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmisLastLaunchedValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 365 + } + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterType", + "traits": { + "smithy.api#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 \n\t\t\t6 might refer to six months or six AMIs.
For count-based filters, this value represents the minimum number of resources \n\t\t\t\tto keep on hand. If you have fewer resources than this number, the resource is \n\t\t\t\texcluded from lifecycle actions.
\nDefines the unit of time that the lifecycle policy uses to determine impacted \n\t\t\tresources. This is required for age-based rules.
" + } + }, + "retainAtLeast": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterRetainAtLeast", + "traits": { + "smithy.api#documentation": "For age-based filters, this is the number of resources to keep on hand after the lifecycle \n\t\t\tDELETE action is applied. Impacted resources are only deleted if you have more than \n\t\t\tthis number of resources. If you have fewer resources than this number, the impacted resource \n\t\t\tis not deleted.
Defines filters that the lifecycle policy uses to determine impacted resource.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterRetainAtLeast": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterType": { + "type": "enum", + "members": { + "AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGE" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + } + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetailFilterValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetail" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelection": { + "type": "structure", + "members": { + "recipes": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelectionRecipes", + "traits": { + "smithy.api#documentation": "A list of recipes that are used as selection criteria for the output \n\t\t\timages that the lifecycle policy applies to.
" + } + }, + "tagMap": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "A list of tags that are used as selection criteria for the resources \n\t\t\tthat the lifecycle policy applies to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Resource selection criteria for the lifecycle policy.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelectionRecipe": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "The name of an Image Builder recipe that the lifecycle policy uses for resource selection.
", + "smithy.api#required": {} + } + }, + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelectionRecipes": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelectionRecipe" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyResourceType": { + "type": "enum", + "members": { + "AMI_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMI_IMAGE" + } + }, + "CONTAINER_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINER_IMAGE" + } + } + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyStatus": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicySummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle policy summary resource.
" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the lifecycle policy.
" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "Optional description for the lifecycle policy.
" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyStatus", + "traits": { + "smithy.api#documentation": "The lifecycle policy resource status.
" + } + }, + "executionRole": { + "target": "com.amazonaws.imagebuilder#RoleNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the IAM role that Image Builder uses to run the lifecycle policy.
" + } + }, + "resourceType": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceType", + "traits": { + "smithy.api#documentation": "The type of resources the lifecycle policy targets.
" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when Image Builder created the lifecycle policy resource.
" + } + }, + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp when Image Builder updated the lifecycle policy resource.
" + } + }, + "dateLastRun": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp for the last time Image Builder ran the lifecycle policy.
" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "To help manage your lifecycle policy resources, you can assign your own \n\t\t\tmetadata to each resource in the form of tags. Each tag consists of a key and \n\t\t\tan optional value, both of which you define.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a summary of lifecycle policy resources.
" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicySummary" + } + }, + "com.amazonaws.imagebuilder#LifecyclePolicyTimeUnit": { + "type": "enum", + "members": { + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAYS" + } + }, + "WEEKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKS" + } + }, + "MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHS" + } + }, + "YEARS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YEARS" + } + } + } + }, + "com.amazonaws.imagebuilder#ListComponentBuildVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the list of component build versions for the specified semantic\n\t\t\tversion.
\nThe semantic version has four nodes:
\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.
\nThe component version Amazon Resource Name (ARN) whose versions you want to\n\t\t\tlist.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#documentation": "The maximum items to return in a request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListComponentBuildVersionsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + } + }, + "componentSummaryList": { + "target": "com.amazonaws.imagebuilder#ComponentSummaryList", + "traits": { + "smithy.api#documentation": "The list of component summaries for the specified semantic version.
" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListComponentsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the list of components that can be filtered by name, or by using the listed\n\t\t\t\tfilters to streamline results. Newly created components can take up to\n\t\t\ttwo minutes to appear in the ListComponents API Results.
The semantic version has four nodes:
\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.
\nFilters results based on the type of owner for the component. By default, this request\n\t\t\treturns a list of components that your account owns. To see results for other types of\n\t\t\towners, you can specify components that Amazon manages, third party components, or\n\t\t\tcomponents that other accounts have shared with you.
" + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "Use the following filters to streamline results:
\n\n description\n
\n name\n
\n platform\n
\n supportedOsVersion\n
\n type\n
\n version\n
Returns the list of components for the specified name.
" + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#documentation": "The maximum items to return in a request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListComponentsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + } + }, + "componentVersionList": { + "target": "com.amazonaws.imagebuilder#ComponentVersionList", + "traits": { + "smithy.api#documentation": "The list of component semantic versions.
\nThe semantic version has four nodes:
The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListContainerRecipes": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListContainerRecipesRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListContainerRecipesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of container recipes.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListContainerRecipes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "containerRecipeSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListContainerRecipesRequest": { + "type": "structure", + "members": { + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", + "traits": { + "smithy.api#documentation": "Returns container recipes belonging to the specified owner, that have been shared with\n\t\t\tyou. You can omit this field to return container recipes belonging to your\n\t\t\taccount.
" + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "Use the following filters to streamline results:
\n\n containerType\n
\n name\n
\n parentImage\n
\n platform\n
The maximum items to return in a request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListContainerRecipesResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + } + }, + "containerRecipeSummaryList": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeSummaryList", + "traits": { + "smithy.api#documentation": "The list of container recipes returned for the request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListDistributionConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of distribution configurations.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListDistributionConfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "distributionConfigurationSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "You can filter on name to streamline results.
The maximum items to return in a request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + } + }, + "distributionConfigurationSummaryList": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList", + "traits": { + "smithy.api#documentation": "The list of distributions.
" + } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#PaginationToken", + "traits": { + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#ListImageBuildVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListComponentsResponse" + "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse" }, "errors": [ { @@ -6543,40 +8167,34 @@ } ], "traits": { - "smithy.api#documentation": "Returns the list of components that can be filtered by name, or by using the listed\n\t\t\t\tfilters to streamline results. Newly created components can take up to\n\t\t\ttwo minutes to appear in the ListComponents API Results.
The semantic version has four nodes:
\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.
\nReturns a list of image build versions.
", "smithy.api#http": { "method": "POST", - "uri": "/ListComponents", + "uri": "/ListImageBuildVersions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "componentVersionList", + "items": "imageSummaryList", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListComponentsRequest": { + "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest": { "type": "structure", "members": { - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", + "imageVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageVersionArn", "traits": { - "smithy.api#documentation": "Filters results based on the type of owner for the component. By default, this request\n\t\t\treturns a list of components that your account owns. To see results for other types of\n\t\t\towners, you can specify components that Amazon manages, third party components, or\n\t\t\tcomponents that other accounts have shared with you.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the image whose build versions you want to\n\t\t\tretrieve.
", + "smithy.api#required": {} } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "Use the following filters to streamline results:
\n\n description\n
\n name\n
\n platform\n
\n supportedOsVersion\n
\n type\n
\n version\n
Returns the list of components for the specified name.
" + "smithy.api#documentation": "Use the following filters to streamline results:
\n\n name\n
\n osVersion\n
\n platform\n
\n type\n
\n version\n
A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -6596,7 +8214,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListComponentsResponse": { + "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse": { "type": "structure", "members": { "requestId": { @@ -6605,16 +8223,16 @@ "smithy.api#documentation": "The request ID that uniquely identifies this request.
" } }, - "componentVersionList": { - "target": "com.amazonaws.imagebuilder#ComponentVersionList", + "imageSummaryList": { + "target": "com.amazonaws.imagebuilder#ImageSummaryList", "traits": { - "smithy.api#documentation": "The list of component semantic versions.
\nThe semantic version has four nodes:
The list of image build versions.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -6622,13 +8240,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListContainerRecipes": { + "com.amazonaws.imagebuilder#ListImagePackages": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListContainerRecipesRequest" + "target": "com.amazonaws.imagebuilder#ListImagePackagesRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListContainerRecipesResponse" + "target": "com.amazonaws.imagebuilder#ListImagePackagesResponse" }, "errors": [ { @@ -6646,6 +8264,9 @@ { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, @@ -6654,33 +8275,28 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of container recipes.
", + "smithy.api#documentation": "List the Packages that are associated with an Image Build Version, as determined by\n\t\t\tAmazon Web Services Systems Manager Inventory at build time.
", "smithy.api#http": { "method": "POST", - "uri": "/ListContainerRecipes", + "uri": "/ListImagePackages", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "containerRecipeSummaryList", + "items": "imagePackageList", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListContainerRecipesRequest": { + "com.amazonaws.imagebuilder#ListImagePackagesRequest": { "type": "structure", "members": { - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", - "traits": { - "smithy.api#documentation": "Returns container recipes belonging to the specified owner, that have been shared with\n\t\t\tyou. You can omit this field to return container recipes belonging to your\n\t\t\taccount.
" - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { - "smithy.api#documentation": "Use the following filters to streamline results:
\n\n containerType\n
\n name\n
\n parentImage\n
\n platform\n
Filter results for the ListImagePackages request by the Image Build Version ARN
", + "smithy.api#required": {} } }, "maxResults": { @@ -6690,9 +8306,9 @@ } }, "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -6700,7 +8316,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListContainerRecipesResponse": { + "com.amazonaws.imagebuilder#ListImagePackagesResponse": { "type": "structure", "members": { "requestId": { @@ -6709,16 +8325,16 @@ "smithy.api#documentation": "The request ID that uniquely identifies this request.
" } }, - "containerRecipeSummaryList": { - "target": "com.amazonaws.imagebuilder#ContainerRecipeSummaryList", + "imagePackageList": { + "target": "com.amazonaws.imagebuilder#ImagePackageList", "traits": { - "smithy.api#documentation": "The list of container recipes returned for the request.
" + "smithy.api#documentation": "The list of Image Packages returned in the response.
" } }, "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -6726,13 +8342,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListDistributionConfigurations": { + "com.amazonaws.imagebuilder#ListImagePipelineImages": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest" + "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse" + "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse" }, "errors": [ { @@ -6750,6 +8366,9 @@ { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, @@ -6758,27 +8377,34 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of distribution configurations.
", + "smithy.api#documentation": "Returns a list of images created by the specified pipeline.
", "smithy.api#http": { "method": "POST", - "uri": "/ListDistributionConfigurations", + "uri": "/ListImagePipelineImages", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "distributionConfigurationSummaryList", + "items": "imageSummaryList", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListDistributionConfigurationsRequest": { + "com.amazonaws.imagebuilder#ListImagePipelineImagesRequest": { "type": "structure", "members": { + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the image pipeline whose images you want to\n\t\t\tview.
", + "smithy.api#required": {} + } + }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "You can filter on name to streamline results.
Use the following filters to streamline results:
\n\n name\n
\n version\n
A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -6798,7 +8424,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListDistributionConfigurationsResponse": { + "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse": { "type": "structure", "members": { "requestId": { @@ -6807,16 +8433,16 @@ "smithy.api#documentation": "The request ID that uniquely identifies this request.
" } }, - "distributionConfigurationSummaryList": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList", + "imageSummaryList": { + "target": "com.amazonaws.imagebuilder#ImageSummaryList", "traits": { - "smithy.api#documentation": "The list of distributions.
" + "smithy.api#documentation": "The list of images built by this pipeline.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -6824,13 +8450,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListImageBuildVersions": { + "com.amazonaws.imagebuilder#ListImagePipelines": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest" + "target": "com.amazonaws.imagebuilder#ListImagePipelinesRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse" + "target": "com.amazonaws.imagebuilder#ListImagePipelinesResponse" }, "errors": [ { @@ -6856,34 +8482,27 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of image build versions.
", + "smithy.api#documentation": "Returns a list of image pipelines.
", "smithy.api#http": { "method": "POST", - "uri": "/ListImageBuildVersions", + "uri": "/ListImagePipelines", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "imageSummaryList", + "items": "imagePipelineList", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListImageBuildVersionsRequest": { + "com.amazonaws.imagebuilder#ListImagePipelinesRequest": { "type": "structure", "members": { - "imageVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the image whose build versions you want to\n\t\t\tretrieve.
", - "smithy.api#required": {} - } - }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "Use the following filters to streamline results:
\n\n name\n
\n osVersion\n
\n platform\n
\n type\n
\n version\n
Use the following filters to streamline results:
\n\n description\n
\n distributionConfigurationArn\n
\n imageRecipeArn\n
\n infrastructureConfigurationArn\n
\n name\n
\n status\n
A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -6903,7 +8522,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse": { + "com.amazonaws.imagebuilder#ListImagePipelinesResponse": { "type": "structure", "members": { "requestId": { @@ -6912,16 +8531,16 @@ "smithy.api#documentation": "The request ID that uniquely identifies this request.
" } }, - "imageSummaryList": { - "target": "com.amazonaws.imagebuilder#ImageSummaryList", + "imagePipelineList": { + "target": "com.amazonaws.imagebuilder#ImagePipelineList", "traits": { - "smithy.api#documentation": "The list of image build versions.
" + "smithy.api#documentation": "The list of image pipelines.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -6929,13 +8548,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListImagePackages": { + "com.amazonaws.imagebuilder#ListImageRecipes": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListImagePackagesRequest" + "target": "com.amazonaws.imagebuilder#ListImageRecipesRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListImagePackagesResponse" + "target": "com.amazonaws.imagebuilder#ListImageRecipesResponse" }, "errors": [ { @@ -6953,9 +8572,6 @@ { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, @@ -6964,28 +8580,33 @@ } ], "traits": { - "smithy.api#documentation": "List the Packages that are associated with an Image Build Version, as determined by\n\t\t\tAmazon Web Services Systems Manager Inventory at build time.
", + "smithy.api#documentation": "Returns a list of image recipes.
", "smithy.api#http": { "method": "POST", - "uri": "/ListImagePackages", + "uri": "/ListImageRecipes", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "imagePackageList", + "items": "imageRecipeSummaryList", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListImagePackagesRequest": { + "com.amazonaws.imagebuilder#ListImageRecipesRequest": { "type": "structure", "members": { - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", "traits": { - "smithy.api#documentation": "Filter results for the ListImagePackages request by the Image Build Version ARN
", - "smithy.api#required": {} + "smithy.api#documentation": "The owner defines which image recipes you want to list. By default, this request will\n\t\t\tonly show image recipes owned by your account. You can use this field to specify if you\n\t\t\twant to view image recipes owned by yourself, by Amazon, or those image recipes that\n\t\t\thave been shared with you by other customers.
" + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "Use the following filters to streamline results:
\n\n name\n
\n parentImage\n
\n platform\n
A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -7005,7 +8626,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListImagePackagesResponse": { + "com.amazonaws.imagebuilder#ListImageRecipesResponse": { "type": "structure", "members": { "requestId": { @@ -7014,16 +8635,16 @@ "smithy.api#documentation": "The request ID that uniquely identifies this request.
" } }, - "imagePackageList": { - "target": "com.amazonaws.imagebuilder#ImagePackageList", + "imageRecipeSummaryList": { + "target": "com.amazonaws.imagebuilder#ImageRecipeSummaryList", "traits": { - "smithy.api#documentation": "The list of Image Packages returned in the response.
" + "smithy.api#documentation": "The list of image pipelines.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -7031,13 +8652,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListImagePipelineImages": { + "com.amazonaws.imagebuilder#ListImageScanFindingAggregations": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesRequest" + "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse" + "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse" }, "errors": [ { @@ -7055,9 +8676,6 @@ { "target": "com.amazonaws.imagebuilder#InvalidRequestException" }, - { - "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" - }, { "target": "com.amazonaws.imagebuilder#ServiceException" }, @@ -7066,46 +8684,29 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of images created by the specified pipeline.
", + "smithy.api#documentation": "Returns a list of image scan aggregations for your account. You can filter by the type\n\t\t\tof key that Image Builder uses to group results. For example, if you want to get a list of\n\t\t\tfindings by severity level for one of your pipelines, you might specify your pipeline\n\t\t\twith the imagePipelineArn filter. If you don't specify a filter, Image Builder\n\t\t\treturns an aggregation for your account.
To streamline results, you can use the following filters in your request:
\n\n accountId\n
\n imageBuildVersionArn\n
\n imagePipelineArn\n
\n vulnerabilityId\n
The Amazon Resource Name (ARN) of the image pipeline whose images you want to\n\t\t\tview.
", - "smithy.api#required": {} - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "Use the following filters to streamline results:
\n\n name\n
\n version\n
The maximum items to return in a request.
" - } + "filter": { + "target": "com.amazonaws.imagebuilder#Filter" }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -7113,25 +8714,31 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse": { + "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + } + }, + "aggregationType": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The aggregation type specifies what type of key is used to group the image scan\n\t\t\tfindings. Image Builder returns results based on the request filter. If you didn't specify a\n\t\t\tfilter in the request, the type defaults to accountId.
\n Aggregation types\n
\naccountId
\nimageBuildVersionArn
\nimagePipelineArn
\nvulnerabilityId
\nEach aggregation includes counts by severity level for medium severity and higher\n\t\t\tlevel findings, plus a total for all of the findings for each key value.
" } }, - "imageSummaryList": { - "target": "com.amazonaws.imagebuilder#ImageSummaryList", + "responses": { + "target": "com.amazonaws.imagebuilder#ImageScanFindingAggregationsList", "traits": { - "smithy.api#documentation": "The list of images built by this pipeline.
" + "smithy.api#documentation": "An array of image scan finding aggregations that match the filter criteria.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -7139,13 +8746,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListImagePipelines": { + "com.amazonaws.imagebuilder#ListImageScanFindings": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListImagePipelinesRequest" + "target": "com.amazonaws.imagebuilder#ListImageScanFindingsRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListImagePipelinesResponse" + "target": "com.amazonaws.imagebuilder#ListImageScanFindingsResponse" }, "errors": [ { @@ -7171,27 +8778,27 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of image pipelines.
", + "smithy.api#documentation": "Returns a list of image scan findings for your account.
", "smithy.api#http": { "method": "POST", - "uri": "/ListImagePipelines", + "uri": "/ListImageScanFindings", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "imagePipelineList", + "items": "findings", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListImagePipelinesRequest": { + "com.amazonaws.imagebuilder#ListImageScanFindingsRequest": { "type": "structure", "members": { "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", + "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilterList", "traits": { - "smithy.api#documentation": "Use the following filters to streamline results:
\n\n description\n
\n distributionConfigurationArn\n
\n imageRecipeArn\n
\n infrastructureConfigurationArn\n
\n name\n
\n status\n
An array of name value pairs that you can use to filter your results. You can use the\n\t\t\tfollowing filters to streamline results:
\n\n imageBuildVersionArn\n
\n imagePipelineArn\n
\n vulnerabilityId\n
\n severity\n
If you don't request a filter, then all findings in your account are listed.
" } }, "maxResults": { @@ -7203,7 +8810,7 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -7211,7 +8818,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListImagePipelinesResponse": { + "com.amazonaws.imagebuilder#ListImageScanFindingsResponse": { "type": "structure", "members": { "requestId": { @@ -7220,16 +8827,16 @@ "smithy.api#documentation": "The request ID that uniquely identifies this request.
" } }, - "imagePipelineList": { - "target": "com.amazonaws.imagebuilder#ImagePipelineList", + "findings": { + "target": "com.amazonaws.imagebuilder#ImageScanFindingsList", "traits": { - "smithy.api#documentation": "The list of image pipelines.
" + "smithy.api#documentation": "The image scan findings for your account that meet your request filter\n\t\t\tcriteria.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -7237,13 +8844,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListImageRecipes": { + "com.amazonaws.imagebuilder#ListImages": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListImageRecipesRequest" + "target": "com.amazonaws.imagebuilder#ListImagesRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListImageRecipesResponse" + "target": "com.amazonaws.imagebuilder#ListImagesResponse" }, "errors": [ { @@ -7269,33 +8876,40 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of image recipes.
", + "smithy.api#documentation": "Returns the list of images that you have access to. Newly created images can take up\n\t\t\tto two minutes to appear in the ListImages API Results.
", "smithy.api#http": { "method": "POST", - "uri": "/ListImageRecipes", + "uri": "/ListImages", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "imageRecipeSummaryList", + "items": "imageVersionList", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListImageRecipesRequest": { + "com.amazonaws.imagebuilder#ListImagesRequest": { "type": "structure", "members": { "owner": { "target": "com.amazonaws.imagebuilder#Ownership", "traits": { - "smithy.api#documentation": "The owner defines which image recipes you want to list. By default, this request will\n\t\t\tonly show image recipes owned by your account. You can use this field to specify if you\n\t\t\twant to view image recipes owned by yourself, by Amazon, or those image recipes that\n\t\t\thave been shared with you by other customers.
" + "smithy.api#documentation": "The owner defines which images you want to list. By default, this request will only\n\t\t\tshow images owned by your account. You can use this field to specify if you want to view\n\t\t\timages owned by yourself, by Amazon, or those images that have been shared with you by\n\t\t\tother customers.
" } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "Use the following filters to streamline results:
\n\n name\n
\n parentImage\n
\n platform\n
Use the following filters to streamline results:
\n\n name\n
\n osVersion\n
\n platform\n
\n type\n
\n version\n
Requests a list of images with a specific recipe name.
" } }, "maxResults": { @@ -7307,7 +8921,13 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" + } + }, + "includeDeprecated": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "Includes deprecated images in the response list.
" } } }, @@ -7315,7 +8935,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListImageRecipesResponse": { + "com.amazonaws.imagebuilder#ListImagesResponse": { "type": "structure", "members": { "requestId": { @@ -7324,16 +8944,16 @@ "smithy.api#documentation": "The request ID that uniquely identifies this request.
" } }, - "imageRecipeSummaryList": { - "target": "com.amazonaws.imagebuilder#ImageRecipeSummaryList", + "imageVersionList": { + "target": "com.amazonaws.imagebuilder#ImageVersionList", "traits": { - "smithy.api#documentation": "The list of image pipelines.
" + "smithy.api#documentation": "The list of image semantic versions.
\nThe semantic version has four nodes:
\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.
\nThe next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -7341,13 +8961,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListImageScanFindingAggregations": { + "com.amazonaws.imagebuilder#ListInfrastructureConfigurations": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsRequest" + "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse" + "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse" }, "errors": [ { @@ -7373,29 +8993,39 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of image scan aggregations for your account. You can filter by the type\n\t\t\tof key that Image Builder uses to group results. For example, if you want to get a list of\n\t\t\tfindings by severity level for one of your pipelines, you might specify your pipeline\n\t\t\twith the imagePipelineArn filter. If you don't specify a filter, Image Builder\n\t\t\treturns an aggregation for your account.
To streamline results, you can use the following filters in your request:
\n\n accountId\n
\n imageBuildVersionArn\n
\n imagePipelineArn\n
\n vulnerabilityId\n
Returns a list of infrastructure configurations.
", "smithy.api#http": { "method": "POST", - "uri": "/ListImageScanFindingAggregations", + "uri": "/ListInfrastructureConfigurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "responses" + "items": "infrastructureConfigurationSummaryList", + "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsRequest": { + "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest": { "type": "structure", "members": { - "filter": { - "target": "com.amazonaws.imagebuilder#Filter" + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "You can filter on name to streamline results.
The maximum items to return in a request.
" + } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -7403,7 +9033,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListImageScanFindingAggregationsResponse": { + "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse": { "type": "structure", "members": { "requestId": { @@ -7412,22 +9042,16 @@ "smithy.api#documentation": "The request ID that uniquely identifies this request.
" } }, - "aggregationType": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "The aggregation type specifies what type of key is used to group the image scan\n\t\t\tfindings. Image Builder returns results based on the request filter. If you didn't specify a\n\t\t\tfilter in the request, the type defaults to accountId.
\n Aggregation types\n
\naccountId
\nimageBuildVersionArn
\nimagePipelineArn
\nvulnerabilityId
\nEach aggregation includes counts by severity level for medium severity and higher\n\t\t\tlevel findings, plus a total for all of the findings for each key value.
" - } - }, - "responses": { - "target": "com.amazonaws.imagebuilder#ImageScanFindingAggregationsList", + "infrastructureConfigurationSummaryList": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationSummaryList", "traits": { - "smithy.api#documentation": "An array of image scan finding aggregations that match the filter criteria.
" + "smithy.api#documentation": "The list of infrastructure configurations.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -7435,13 +9059,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListImageScanFindings": { + "com.amazonaws.imagebuilder#ListLifecycleExecutionResources": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListImageScanFindingsRequest" + "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionResourcesRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListImageScanFindingsResponse" + "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionResourcesResponse" }, "errors": [ { @@ -7467,27 +9091,34 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of image scan findings for your account.
", + "smithy.api#documentation": "List resources that the runtime instance of the image lifecycle identified for lifecycle actions.
", "smithy.api#http": { "method": "POST", - "uri": "/ListImageScanFindings", + "uri": "/ListLifecycleExecutionResources", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "findings", + "items": "resources", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListImageScanFindingsRequest": { + "com.amazonaws.imagebuilder#ListLifecycleExecutionResourcesRequest": { "type": "structure", "members": { - "filters": { - "target": "com.amazonaws.imagebuilder#ImageScanFindingsFilterList", + "lifecycleExecutionId": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { - "smithy.api#documentation": "An array of name value pairs that you can use to filter your results. You can use the\n\t\t\tfollowing filters to streamline results:
\n\n imageBuildVersionArn\n
\n imagePipelineArn\n
\n vulnerabilityId\n
\n severity\n
If you don't request a filter, then all findings in your account are listed.
" + "smithy.api#documentation": "Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.
", + "smithy.api#required": {} + } + }, + "parentResourceId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "You can leave this empty to get a list of Image Builder resources that were identified for lifecycle actions.
\nTo get a list of associated resources that are impacted for an individual resource (the parent), specify \n\t\t\tits Amazon Resource Name (ARN). Associated resources are produced from your image and distributed when you run a build, such as \n\t\t\tAMIs or container images stored in ECR repositories.
" } }, "maxResults": { @@ -7499,7 +9130,7 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -7507,25 +9138,31 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListImageScanFindingsResponse": { + "com.amazonaws.imagebuilder#ListLifecycleExecutionResourcesResponse": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "lifecycleExecutionId": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", "traits": { - "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + "smithy.api#documentation": "Runtime details for the specified runtime instance of the lifecycle policy.
" } }, - "findings": { - "target": "com.amazonaws.imagebuilder#ImageScanFindingsList", + "lifecycleExecutionState": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionState", "traits": { - "smithy.api#documentation": "The image scan findings for your account that meet your request filter\n\t\t\tcriteria.
" + "smithy.api#documentation": "The current state of the lifecycle runtime instance.
" + } + }, + "resources": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionResourceList", + "traits": { + "smithy.api#documentation": "A list of resources that were identified for lifecycle actions.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -7533,13 +9170,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListImages": { + "com.amazonaws.imagebuilder#ListLifecycleExecutions": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListImagesRequest" + "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionsRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListImagesResponse" + "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionsResponse" }, "errors": [ { @@ -7565,42 +9202,23 @@ } ], "traits": { - "smithy.api#documentation": "Returns the list of images that you have access to. Newly created images can take up\n\t\t\tto two minutes to appear in the ListImages API Results.
", + "smithy.api#documentation": "Get the lifecycle runtime history for the specified resource.
", "smithy.api#http": { "method": "POST", - "uri": "/ListImages", + "uri": "/ListLifecycleExecutions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "imageVersionList", + "items": "lifecycleExecutions", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListImagesRequest": { + "com.amazonaws.imagebuilder#ListLifecycleExecutionsRequest": { "type": "structure", "members": { - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", - "traits": { - "smithy.api#documentation": "The owner defines which images you want to list. By default, this request will only\n\t\t\tshow images owned by your account. You can use this field to specify if you want to view\n\t\t\timages owned by yourself, by Amazon, or those images that have been shared with you by\n\t\t\tother customers.
" - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "Use the following filters to streamline results:
\n\n name\n
\n osVersion\n
\n platform\n
\n type\n
\n version\n
Requests a list of images with a specific recipe name.
" - } - }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { @@ -7610,13 +9228,14 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } }, - "includeDeprecated": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", + "resourceArn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { - "smithy.api#documentation": "Includes deprecated images in the response list.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to get a list of lifecycle runtime instances.
", + "smithy.api#required": {} } } }, @@ -7624,25 +9243,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListImagesResponse": { + "com.amazonaws.imagebuilder#ListLifecycleExecutionsResponse": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "lifecycleExecutions": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionsList", "traits": { - "smithy.api#documentation": "The request ID that uniquely identifies this request.
" - } - }, - "imageVersionList": { - "target": "com.amazonaws.imagebuilder#ImageVersionList", - "traits": { - "smithy.api#documentation": "The list of image semantic versions.
\nThe semantic version has four nodes:
\n Filtering: With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.
\nA list of lifecycle runtime instances for the specified resource.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -7650,13 +9263,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.imagebuilder#ListInfrastructureConfigurations": { + "com.amazonaws.imagebuilder#ListLifecyclePolicies": { "type": "operation", "input": { - "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest" + "target": "com.amazonaws.imagebuilder#ListLifecyclePoliciesRequest" }, "output": { - "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse" + "target": "com.amazonaws.imagebuilder#ListLifecyclePoliciesResponse" }, "errors": [ { @@ -7682,27 +9295,27 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of infrastructure configurations.
", + "smithy.api#documentation": "Get a list of lifecycle policies in your Amazon Web Services account.
", "smithy.api#http": { "method": "POST", - "uri": "/ListInfrastructureConfigurations", + "uri": "/ListLifecyclePolicies", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "infrastructureConfigurationSummaryList", + "items": "lifecyclePolicySummaryList", "pageSize": "maxResults" } } }, - "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsRequest": { + "com.amazonaws.imagebuilder#ListLifecyclePoliciesRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "You can filter on name to streamline results.
Streamline results based on one of the following values: Name, \n\t\t\tStatus.
A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } } }, @@ -7722,25 +9335,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse": { + "com.amazonaws.imagebuilder#ListLifecyclePoliciesResponse": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "The request ID that uniquely identifies this request.
" - } - }, - "infrastructureConfigurationSummaryList": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationSummaryList", + "lifecyclePolicySummaryList": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicySummaryList", "traits": { - "smithy.api#documentation": "The list of infrastructure configurations.
" + "smithy.api#documentation": "A list of lifecycle policies in your Amazon Web Services account that meet the criteria \n\t\t\tspecified in the request.
" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -7864,7 +9471,7 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } }, "imageBuildVersionArn": { @@ -7909,7 +9516,7 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -7975,7 +9582,7 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "A token to specify where to start paginating. This is the NextToken \n\tfrom a previously truncated response.
" + "smithy.api#documentation": "A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.
" } }, "workflowExecutionId": { @@ -8032,7 +9639,7 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#PaginationToken", "traits": { - "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service has'ot included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" + "smithy.api#documentation": "The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.
" } } }, @@ -8058,8 +9665,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1, - "max": 10000 + "min": 1 } } }, @@ -8767,17 +10373,100 @@ } }, "traits": { - "smithy.api#documentation": "At least one of the resources referenced by your request does not exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#documentation": "At least one of the resources referenced by your request does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.imagebuilder#ResourcePolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30000 + } + } + }, + "com.amazonaws.imagebuilder#ResourceState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.imagebuilder#ResourceStatus", + "traits": { + "smithy.api#documentation": "Shows the current lifecycle policy action that was applied to an impacted resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The current state of an impacted resource.
" + } + }, + "com.amazonaws.imagebuilder#ResourceStateUpdateExclusionRules": { + "type": "structure", + "members": { + "amis": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetailExclusionRulesAmis" + } + }, + "traits": { + "smithy.api#documentation": "Additional rules to specify resources that should be exempt from ad-hoc lifecycle actions.
" + } + }, + "com.amazonaws.imagebuilder#ResourceStateUpdateIncludeResources": { + "type": "structure", + "members": { + "amis": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the lifecycle action should apply to distributed AMIs
" + } + }, + "snapshots": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.
" + } + }, + "containers": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the lifecycle action should apply to distributed containers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies if the lifecycle policy should apply actions to selected resources.
" } }, - "com.amazonaws.imagebuilder#ResourcePolicyDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30000 + "com.amazonaws.imagebuilder#ResourceStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } } } }, @@ -8805,6 +10494,16 @@ } } }, + "com.amazonaws.imagebuilder#RoleNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, "com.amazonaws.imagebuilder#S3ExportConfiguration": { "type": "structure", "members": { @@ -9034,7 +10733,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -9056,13 +10755,133 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the image that was created by this request.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the image that the request created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.imagebuilder#StartResourceStateUpdate": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#StartResourceStateUpdateRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#StartResourceStateUpdateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Begin asynchronous resource state update for lifecycle changes to the \n\t\t\tspecified image resources.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/StartResourceStateUpdate", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#StartResourceStateUpdateRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the Image Builder resource that is updated. The state update might also \n\t\t\timpact associated resources.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.imagebuilder#ResourceState", + "traits": { + "smithy.api#documentation": "Indicates the lifecycle action to take for this request.
", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.imagebuilder#RoleNameOrArn", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.
" + } + }, + "includeResources": { + "target": "com.amazonaws.imagebuilder#ResourceStateUpdateIncludeResources", + "traits": { + "smithy.api#documentation": "A list of image resources to update state for.
" + } + }, + "exclusionRules": { + "target": "com.amazonaws.imagebuilder#ResourceStateUpdateExclusionRules", + "traits": { + "smithy.api#documentation": "Skip action on the image resource and associated resources if specified \n\t\t\texclusion rules are met.
" + } + }, + "updateAt": { + "target": "com.amazonaws.imagebuilder#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when resources are updated by a lifecycle action.
" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#StartResourceStateUpdateResponse": { + "type": "structure", + "members": { + "lifecycleExecutionId": { + "target": "com.amazonaws.imagebuilder#LifecycleExecutionId", + "traits": { + "smithy.api#documentation": "Identifies the lifecycle runtime instance that started the resource \n\t\t\tstate update.
" + } + }, + "resourceArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "The requested ARN of the Image Builder resource for the asynchronous update.
" } } }, @@ -9366,7 +11185,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token of the distribution configuration.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -9388,7 +11207,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "distributionConfigurationArn": { @@ -9513,7 +11332,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -9541,7 +11360,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "imagePipelineArn": { @@ -9666,7 +11485,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -9700,7 +11519,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The client token that uniquely identifies the request.
" } }, "infrastructureConfigurationArn": { @@ -9714,6 +11533,129 @@ "smithy.api#output": {} } }, + "com.amazonaws.imagebuilder#UpdateLifecyclePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#UpdateLifecyclePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#UpdateLifecyclePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Update the specified lifecycle policy.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/UpdateLifecyclePolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#UpdateLifecyclePolicyRequest": { + "type": "structure", + "members": { + "lifecyclePolicyArn": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the lifecycle policy resource.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "Optional description for the lifecycle policy.
" + } + }, + "status": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyStatus", + "traits": { + "smithy.api#documentation": "Indicates whether the lifecycle policy resource is enabled.
" + } + }, + "executionRole": { + "target": "com.amazonaws.imagebuilder#RoleNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the IAM role that Image Builder should use to update the \n\t\t\tlifecycle policy.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceType", + "traits": { + "smithy.api#documentation": "The type of image resource that the lifecycle policy applies to.
", + "smithy.api#required": {} + } + }, + "policyDetails": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyDetails", + "traits": { + "smithy.api#documentation": "The configuration details for a lifecycle policy resource.
", + "smithy.api#required": {} + } + }, + "resourceSelection": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyResourceSelection", + "traits": { + "smithy.api#documentation": "Selection criteria for resources that the lifecycle policy applies to.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.imagebuilder#UpdateLifecyclePolicyResponse": { + "type": "structure", + "members": { + "lifecyclePolicyArn": { + "target": "com.amazonaws.imagebuilder#LifecyclePolicyArn", + "traits": { + "smithy.api#documentation": "The ARN of the image lifecycle policy resource that was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.imagebuilder#Uri": { "type": "string" }, @@ -10223,6 +12165,9 @@ { "target": "com.amazonaws.imagebuilder#CancelImageCreation" }, + { + "target": "com.amazonaws.imagebuilder#CancelLifecycleExecution" + }, { "target": "com.amazonaws.imagebuilder#CreateComponent" }, @@ -10244,6 +12189,9 @@ { "target": "com.amazonaws.imagebuilder#CreateInfrastructureConfiguration" }, + { + "target": "com.amazonaws.imagebuilder#CreateLifecyclePolicy" + }, { "target": "com.amazonaws.imagebuilder#DeleteComponent" }, @@ -10265,6 +12213,9 @@ { "target": "com.amazonaws.imagebuilder#DeleteInfrastructureConfiguration" }, + { + "target": "com.amazonaws.imagebuilder#DeleteLifecyclePolicy" + }, { "target": "com.amazonaws.imagebuilder#GetComponent" }, @@ -10298,6 +12249,12 @@ { "target": "com.amazonaws.imagebuilder#GetInfrastructureConfiguration" }, + { + "target": "com.amazonaws.imagebuilder#GetLifecycleExecution" + }, + { + "target": "com.amazonaws.imagebuilder#GetLifecyclePolicy" + }, { "target": "com.amazonaws.imagebuilder#GetWorkflowExecution" }, @@ -10349,6 +12306,15 @@ { "target": "com.amazonaws.imagebuilder#ListInfrastructureConfigurations" }, + { + "target": "com.amazonaws.imagebuilder#ListLifecycleExecutionResources" + }, + { + "target": "com.amazonaws.imagebuilder#ListLifecycleExecutions" + }, + { + "target": "com.amazonaws.imagebuilder#ListLifecyclePolicies" + }, { "target": "com.amazonaws.imagebuilder#ListTagsForResource" }, @@ -10373,6 +12339,9 @@ { "target": "com.amazonaws.imagebuilder#StartImagePipelineExecution" }, + { + "target": "com.amazonaws.imagebuilder#StartResourceStateUpdate" + }, { "target": "com.amazonaws.imagebuilder#TagResource" }, @@ -10387,6 +12356,9 @@ }, { "target": "com.amazonaws.imagebuilder#UpdateInfrastructureConfiguration" + }, + { + "target": "com.amazonaws.imagebuilder#UpdateLifecyclePolicy" } ], "traits": { diff --git a/codegen/sdk/aws-models/iot.json b/codegen/sdk/aws-models/iot.json index 3eac824546e..12813081c65 100644 --- a/codegen/sdk/aws-models/iot.json +++ b/codegen/sdk/aws-models/iot.json @@ -2965,7 +2965,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates a Device Defender security profile with a thing group or this account. Each\n thing group or account can have up to five security profiles associated with it.
\nRequires permission to access the AttachSecurityProfile action.
", + "smithy.api#documentation": "Associates a Device Defender security profile with a thing group or this account. Each \n thing group or account can have up to five security profiles associated with it.
\nRequires permission to access the AttachSecurityProfile action.
", "smithy.api#http": { "method": "PUT", "uri": "/security-profiles/{securityProfileName}/targets", @@ -4855,7 +4855,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels a mitigation action task that is in progress. If the task is not in progress, an\n InvalidRequestException occurs.
\nRequires permission to access the CancelAuditMitigationActionsTask action.
", + "smithy.api#documentation": "Cancels a mitigation action task that is in progress. If the task\n is not\n in progress, an InvalidRequestException occurs.
\nRequires permission to access the CancelAuditMitigationActionsTask action.
", "smithy.api#http": { "method": "PUT", "uri": "/audit/mitigationactions/tasks/{taskId}/cancel", @@ -4909,7 +4909,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels an audit that is in progress. The audit can be either scheduled or on demand. If\n the audit isn't in progress, an \"InvalidRequestException\" occurs.
\nRequires permission to access the CancelAuditTask action.
", + "smithy.api#documentation": "Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an \"InvalidRequestException\" occurs.
\nRequires permission to access the CancelAuditTask action.
", "smithy.api#http": { "method": "PUT", "uri": "/audit/tasks/{taskId}/cancel", @@ -4923,7 +4923,7 @@ "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { - "smithy.api#documentation": "The ID of the audit you want to cancel. You can only cancel an audit that is\n \"IN_PROGRESS\".
", + "smithy.api#documentation": "The ID of the audit you want to cancel. You can only cancel an\n audit that is \"IN_PROGRESS\".
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5020,7 +5020,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels a Device Defender ML Detect mitigation action.
\nRequires permission to access the CancelDetectMitigationActionsTask action.
", + "smithy.api#documentation": "\n Cancels a Device Defender ML Detect mitigation action.\n
\nRequires permission to access the CancelDetectMitigationActionsTask action.
", "smithy.api#http": { "method": "PUT", "uri": "/detect/mitigationactions/tasks/{taskId}/cancel", @@ -5034,7 +5034,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "The unique identifier of the task.
", + "smithy.api#documentation": "\n The unique identifier of the task.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6540,7 +6540,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this API to define a Custom Metric published by your devices to Device Defender.
\nRequires permission to access the CreateCustomMetric action.
", + "smithy.api#documentation": "Use this API to define a\n Custom\n Metric\n published by your devices to Device Defender.
\nRequires permission to access the CreateCustomMetric action.
", "smithy.api#http": { "method": "POST", "uri": "/custom-metric/{metricName}", @@ -6575,13 +6575,13 @@ "tags": { "target": "com.amazonaws.iot#TagList", "traits": { - "smithy.api#documentation": "Metadata that can be used to manage the custom metric.
" + "smithy.api#documentation": "\n Metadata that can be used to manage the custom metric.\n
" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each custom metric must have a unique client request token. If you try to create a new\n custom metric that already exists with a different token, an exception occurs. If you omit\n this value, Amazon Web Services SDKs will automatically generate a unique client request.
", + "smithy.api#documentation": "Each custom\n metric must have a unique client request token. If you try to create a new custom metric that\n already exists with a different token,\n an exception\n occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -6597,7 +6597,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "The name of the custom metric to be used in the metric report.
" + "smithy.api#documentation": "\n The name of the custom metric to be used in the metric report.\n
" } }, "metricArn": { @@ -6637,7 +6637,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a dimension that you can use to limit the scope of a metric used in a security\n profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow\n down the scope of the metric only to MQTT topics whose name match the pattern specified in the\n dimension.
Requires permission to access the CreateDimension action.
", + "smithy.api#documentation": "Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. \n For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
Requires permission to access the CreateDimension action.
", "smithy.api#http": { "method": "POST", "uri": "/dimensions/{name}", @@ -6651,7 +6651,7 @@ "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "A unique identifier for the dimension. Choose something that describes the type and value\n to make it easy to remember what it does.
", + "smithy.api#documentation": "A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6666,7 +6666,7 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "Specifies the value or list of values for the dimension. For TOPIC_FILTER\n dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").
Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").
Each dimension must have a unique client request token. If you try to create a new\n dimension with the same token as a dimension that already exists, an exception occurs. If you\n omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
", + "smithy.api#documentation": "Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. \n If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -6701,7 +6701,7 @@ "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created dimension.
" + "smithy.api#documentation": "The Amazon Resource Name\n (ARN)\n of\n the created dimension.
" } } }, @@ -7249,7 +7249,7 @@ "destinationPackageVersions": { "target": "com.amazonaws.iot#DestinationPackageVersions", "traits": { - "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.
\n\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.
" + "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.
\n\n Note:The following Length Constraints relates to a single ARN. \n Up to 25 package version ARNs are allowed.
" } } }, @@ -7389,7 +7389,7 @@ "destinationPackageVersions": { "target": "com.amazonaws.iot#DestinationPackageVersions", "traits": { - "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
\n\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.
" + "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.
\n\n Note:The following Length Constraints relates to a single ARN. \n Up to 25 package version ARNs are allowed.
" } } }, @@ -7527,7 +7527,7 @@ } ], "traits": { - "smithy.api#documentation": "Defines an action that can be applied to audit findings by using\n StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to\n specific check names. For more information, see Mitigation\n actions. Each mitigation action can apply only one type of change.
\nRequires permission to access the CreateMitigationAction action.
", + "smithy.api#documentation": "Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. \n For more information, see Mitigation actions. Each mitigation action can apply only one type of change.
\nRequires permission to access the CreateMitigationAction action.
", "smithy.api#http": { "method": "POST", "uri": "/mitigationactions/actions/{actionName}", @@ -7541,7 +7541,7 @@ "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { - "smithy.api#documentation": "A friendly name for the action. Choose a friendly name that accurately describes the\n action (for example, EnableLoggingAction).
A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).
Creates a scheduled audit that is run at a specified time interval.
\nRequires permission to access the CreateScheduledAudit action.
", + "smithy.api#documentation": "Creates a scheduled audit that is run at a specified \n time interval.
\nRequires permission to access the CreateScheduledAudit action.
", "smithy.api#http": { "method": "POST", "uri": "/audit/scheduledaudits/{scheduledAuditName}", @@ -8654,26 +8654,26 @@ "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "How often the scheduled audit takes place, either DAILY, WEEKLY,\n BIWEEKLY or MONTHLY. The start time of each audit is determined by\n the system.
How often the scheduled audit takes\n place, either\n DAILY,\n WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is\n determined by the system.
The day of the month on which the scheduled audit takes place. This can be \"1\" through\n \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to\n MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many\n days, the audit takes place on the LAST day of the month.
The day of the month on which the scheduled audit takes place.\n This\n can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\"\n parameter is set to MONTHLY. If days\n 29\n to 31 are specified, and the month\n doesn't\n have that many days, the audit takes place on the LAST day of the month.
The day of the week on which the scheduled audit takes place, either SUN,\n MON, TUE, WED, THU, FRI, or\n SAT. This field is required if the frequency parameter is set to\n WEEKLY or BIWEEKLY.
The day of the week on which the scheduled audit takes\n place,\n either\n SUN,\n MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency\n parameter is set to WEEKLY or BIWEEKLY.
Which checks are performed during the scheduled audit. Checks must be enabled for your\n account. (Use DescribeAccountAuditConfiguration to see the list of all checks,\n including those that are enabled or use UpdateAccountAuditConfiguration to select\n which checks are enabled.)
Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)
Specifies the behaviors that, when violated by a device (thing), cause an\n alert.
" + "smithy.api#documentation": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
" } }, "alertTargets": { "target": "com.amazonaws.iot#AlertTargets", "traits": { - "smithy.api#documentation": "Specifies the destinations to which alerts are sent. (Alerts are always sent to the\n console.) Alerts are generated when a device (thing) violates a behavior.
" + "smithy.api#documentation": "Specifies the destinations to which alerts are sent. (Alerts are always sent to the \n console.) Alerts are generated when a device (thing) violates a behavior.
" } }, "additionalMetricsToRetain": { @@ -8776,13 +8776,13 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "\n Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n
\nA list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here. Can be used with custom metrics; cannot be used with dimensions.
\n Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.\n
\nA list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here. Can be used with custom metrics; cannot be used with dimensions.
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
Restores the default settings for Device Defender audits for this account. Any\n configuration data you entered is deleted and all audit checks are reset to disabled.\n \n
\nRequires permission to access the DeleteAccountAuditConfiguration action.
", + "smithy.api#documentation": "Restores the default settings for Device Defender audits for this account. Any\n configuration data you entered is deleted and all audit checks are reset to \n disabled.
\nRequires permission to access the DeleteAccountAuditConfiguration action.
", "smithy.api#http": { "method": "DELETE", "uri": "/audit/configuration", @@ -9948,7 +9948,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Device Defender detect custom metric.
\nRequires permission to access the DeleteCustomMetric action.
\nBefore you can delete a custom metric, you must first remove the custom metric from all\n security profiles it's a part of. The security profile associated with the custom metric can\n be found using the ListSecurityProfiles\n API with metricName set to your custom metric name.
\n Deletes a Device Defender detect custom metric.\n
\nRequires permission to access the DeleteCustomMetric action.
\nBefore you can delete a custom metric, you must first remove the custom metric from all\n security profiles it's a part of.\n The\n security\n profile associated with the custom metric can be found using the ListSecurityProfiles\n API with metricName set to your custom metric name.
The name of the custom metric.
", + "smithy.api#documentation": "\n The name of the custom metric.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11145,7 +11145,7 @@ "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { - "smithy.api#documentation": "The expected version of the security profile. A new version is generated whenever the\n security profile is updated. If you specify a value that is different from the actual version,\n a VersionConflictException is thrown.
The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.
Gets information about the Device Defender audit settings for this account. Settings\n include how audit notifications are sent and which audit checks are enabled or\n disabled.
\nRequires permission to access the DescribeAccountAuditConfiguration action.
", + "smithy.api#documentation": "Gets information about the Device Defender audit settings for this account.\n Settings include how audit notifications are sent and which audit checks are\n enabled or disabled.
\nRequires permission to access the DescribeAccountAuditConfiguration action.
", "smithy.api#http": { "method": "GET", "uri": "/audit/configuration", @@ -11718,13 +11718,13 @@ "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of the role that grants permission to IoT to access information about your\n devices, policies, certificates, and other items as required when performing an audit.
\nOn the first call to UpdateAccountAuditConfiguration, this parameter is\n required.
The ARN of the role that grants permission to IoT to access information\n about your devices, policies, certificates, and other items as required when \n performing an audit.
\nOn the first call to UpdateAccountAuditConfiguration,\n this parameter is required.
Information about the targets to which audit notifications are sent for this\n account.
" + "smithy.api#documentation": "Information about the targets to which audit notifications are sent for \n this account.
" } }, "auditCheckConfigurations": { @@ -11761,7 +11761,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a single audit finding. Properties include the reason for\n noncompliance, the severity of the issue, and the start time when the audit that returned the\n finding.
\nRequires permission to access the DescribeAuditFinding action.
", + "smithy.api#documentation": "Gets information about a single audit finding. Properties include the reason for\n noncompliance, the severity of the issue,\n and the start time\n when the audit that returned the\n finding.
\nRequires permission to access the DescribeAuditFinding action.
", "smithy.api#http": { "method": "GET", "uri": "/audit/findings/{findingId}", @@ -11775,7 +11775,7 @@ "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "A unique identifier for a single audit finding. You can use this identifier to apply\n mitigation actions to the finding.
", + "smithy.api#documentation": "A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11819,7 +11819,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about an audit mitigation task that is used to apply mitigation actions\n to a set of audit findings. Properties include the actions being applied, the audit checks to\n which they're being applied, the task status, and aggregated task statistics.
", + "smithy.api#documentation": "Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.
", "smithy.api#http": { "method": "GET", "uri": "/audit/mitigationactions/tasks/{taskId}", @@ -11867,13 +11867,13 @@ "taskStatistics": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatistics", "traits": { - "smithy.api#documentation": "Aggregate counts of the results when the mitigation tasks were applied to the findings for\n this audit mitigation actions task.
" + "smithy.api#documentation": "Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.
" } }, "target": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "Identifies the findings to which the mitigation actions are applied. This can be by audit\n checks, by audit task, or a set of findings.
" + "smithy.api#documentation": "Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.
" } }, "auditCheckToActionsMapping": { @@ -11885,7 +11885,7 @@ "actionsDefinition": { "target": "com.amazonaws.iot#MitigationActionList", "traits": { - "smithy.api#documentation": "Specifies the mitigation actions and their parameters that are applied as part of this\n task.
" + "smithy.api#documentation": "Specifies the mitigation actions and their parameters that are applied as part of this task.
" } } }, @@ -12029,7 +12029,7 @@ "taskStatus": { "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { - "smithy.api#documentation": "The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or\n \"CANCELED\".
" + "smithy.api#documentation": "The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\",\n \"FAILED\", or \"CANCELED\".
" } }, "taskType": { @@ -12393,7 +12393,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a Device Defender detect custom metric.
\nRequires permission to access the DescribeCustomMetric action.
", + "smithy.api#documentation": "\n Gets information about a Device Defender detect custom metric.\n
\nRequires permission to access the DescribeCustomMetric action.
", "smithy.api#http": { "method": "GET", "uri": "/custom-metric/{metricName}", @@ -12407,7 +12407,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "The name of the custom metric.
", + "smithy.api#documentation": "\n The name of the custom metric.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12423,37 +12423,37 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "The name of the custom metric.
" + "smithy.api#documentation": "\n The name of the custom metric.\n
" } }, "metricArn": { "target": "com.amazonaws.iot#CustomMetricArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the custom metric.
" + "smithy.api#documentation": "\n The Amazon Resource Number (ARN) of the custom metric.\n
" } }, "metricType": { "target": "com.amazonaws.iot#CustomMetricType", "traits": { - "smithy.api#documentation": "The type of the custom metric.
\nThe type number only takes a single metric value as an input, but while\n submitting the metrics value in the DeviceMetrics report, it must be passed as an array with\n a single value.
The type of the custom metric.
\nThe type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.
Field represents a friendly name in the console for the custom metric; doesn't have to be\n unique. Don't use this name as the metric identifier in the device metric report. Can be\n updated.
" + "smithy.api#documentation": "\n Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.\n
" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "The creation date of the custom metric in milliseconds since epoch.
" + "smithy.api#documentation": "\n The creation date of the custom metric in milliseconds since epoch.\n
" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "The time the custom metric was last modified in milliseconds since epoch.
" + "smithy.api#documentation": "\n The time the custom metric was last modified in milliseconds since epoch.\n
" } } }, @@ -12542,7 +12542,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a Device Defender ML Detect mitigation action.
\nRequires permission to access the DescribeDetectMitigationActionsTask action.
", + "smithy.api#documentation": "\n Gets information about a Device Defender ML Detect mitigation action.\n
\nRequires permission to access the DescribeDetectMitigationActionsTask action.
", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/tasks/{taskId}", @@ -12556,7 +12556,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "The unique identifier of the task.
", + "smithy.api#documentation": "\n The unique identifier of the task.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12572,7 +12572,7 @@ "taskSummary": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskSummary", "traits": { - "smithy.api#documentation": "The description of a task.
" + "smithy.api#documentation": "\n The description of a task.\n
" } } }, @@ -12639,7 +12639,7 @@ "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the dimension.
" + "smithy.api#documentation": "The Amazon Resource Name\n (ARN)\n for\n the dimension.
" } }, "type": { @@ -12651,7 +12651,7 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "The value or list of values used to scope the dimension. For example, for topic filters,\n this is the pattern used to match the MQTT topic name.
" + "smithy.api#documentation": "The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.
" } }, "creationDate": { @@ -13387,7 +13387,7 @@ "destinationPackageVersions": { "target": "com.amazonaws.iot#DestinationPackageVersions", "traits": { - "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
\n\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.
" + "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.
\n\n Note:The following Length Constraints relates to a single ARN. \n Up to 25 package version ARNs are allowed.
" } } }, @@ -13582,7 +13582,7 @@ "actionParams": { "target": "com.amazonaws.iot#MitigationActionParams", "traits": { - "smithy.api#documentation": "Parameters that control how the mitigation action is applied, specific to the type of\n mitigation action.
" + "smithy.api#documentation": "Parameters that control how the mitigation action is applied, specific to the type of mitigation action.
" } }, "creationDate": { @@ -13938,25 +13938,25 @@ "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "How often the scheduled audit takes place, either one of DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each\n audit is determined by the system.
How often the scheduled audit takes\n place, either\n one of DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the\n system.
The day of the month on which the scheduled audit takes place. This is will be\n 1 through 31 or LAST. If days\n 29-31 are specified, and the month does not have that many days,\n the audit takes place on the LAST day of the month.
The day of the month on which the scheduled audit takes place.\n This is\n will be 1\n through 31 or LAST. If days\n 29-31\n are specified, and the month does not have that many days, the audit takes place on the LAST\n day of the month.
The day of the week on which the scheduled audit takes place, either one of\n SUN, MON, TUE, WED, THU,\n FRI, or SAT.
The day of the week on which the scheduled audit takes\n place,\n either one of\n SUN, MON, TUE, WED, THU, FRI, or SAT.
Which checks are performed during the scheduled audit. Checks must be enabled for your\n account. (Use DescribeAccountAuditConfiguration to see the list of all checks,\n including those that are enabled or use UpdateAccountAuditConfiguration to select\n which checks are enabled.)
Which checks are performed during the scheduled audit. Checks must be \n enabled for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)
The name of the security profile whose information you want to get.
", + "smithy.api#documentation": "The name of the security profile\n whose information you want to get.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14041,13 +14041,13 @@ "securityProfileDescription": { "target": "com.amazonaws.iot#SecurityProfileDescription", "traits": { - "smithy.api#documentation": "A description of the security profile (associated with the security profile when it was\n created or updated).
" + "smithy.api#documentation": "A description of the security profile (associated with the security profile\n when it was created or updated).
" } }, "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "Specifies the behaviors that, when violated by a device (thing), cause an\n alert.
" + "smithy.api#documentation": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
" } }, "alertTargets": { @@ -14062,20 +14062,20 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "\n Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n
\nA list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here.
\n Please use\n DescribeSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n
\nA list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the profile's behaviors, but\n it is\n also retained for any metric specified here.
A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric specified\n here.
" + "smithy.api#documentation": "A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but\n it is\n also retained for any metric specified here.
" } }, "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The version of the security profile. A new version is generated whenever the security\n profile is updated.
" + "smithy.api#documentation": "The version of the security profile. A new version is generated whenever the\n security profile is updated.
" } }, "creationDate": { @@ -14791,7 +14791,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates a Device Defender security profile from a thing group or from this\n account.
\nRequires permission to access the DetachSecurityProfile action.
", + "smithy.api#documentation": "Disassociates a Device Defender security profile from a thing group or from this account.
\nRequires permission to access the DetachSecurityProfile action.
", "smithy.api#http": { "method": "DELETE", "uri": "/security-profiles/{securityProfileName}/targets", @@ -16470,6 +16470,32 @@ "com.amazonaws.iot#GenericLongValue": { "type": "long" }, + "com.amazonaws.iot#GeoLocationTarget": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iot#TargetFieldName", + "traits": { + "smithy.api#documentation": "The name of the geolocation target field. If the target field is part of a\n named shadow, you must select the named shadow using the namedShadow filter.
The order of the geolocation target field. This field is optional. The\n default value is LatLon.
A geolocation target that you select to index. Each geolocation target contains a\n name and order key-value pair that specifies the geolocation\n target fields.
Returns a Device Defender's ML Detect Security Profile training model's status.
\nRequires permission to access the GetBehaviorModelTrainingSummaries action.
", + "smithy.api#documentation": "\n Returns a Device Defender's ML Detect Security Profile training model's status.\n
\nRequires permission to access the GetBehaviorModelTrainingSummaries action.
", "smithy.api#http": { "method": "GET", "uri": "/behavior-model-training/summaries", @@ -16513,21 +16539,21 @@ "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "The name of the security profile.
", + "smithy.api#documentation": "\n The name of the security profile.\n
", "smithy.api#httpQuery": "securityProfileName" } }, "maxResults": { "target": "com.amazonaws.iot#TinyMaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to return at one time. The default is 10.
", + "smithy.api#documentation": "\n The maximum number of results to return at one time. The default is 10.\n
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "The token for the next set of results.
", + "smithy.api#documentation": "\n The token for the next set of results.\n
", "smithy.api#httpQuery": "nextToken" } } @@ -16542,13 +16568,13 @@ "summaries": { "target": "com.amazonaws.iot#BehaviorModelTrainingSummaries", "traits": { - "smithy.api#documentation": "A list of all ML Detect behaviors and their model status for a given Security Profile.\n
" + "smithy.api#documentation": "\n A list of all ML Detect behaviors and their model status for a given Security Profile.\n
" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": " A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n
The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase \n the limit, see Amazon Web Services IoT Device Management \n Quotas in the Amazon Web Services General Reference.\n
" } + }, + "geoLocations": { + "target": "com.amazonaws.iot#GeoLocationsFilter", + "traits": { + "smithy.api#documentation": "The list of geolocation targets that you select to index. The default maximum number of\n geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device\n 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.\n To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and \n specify your shadow names in filter.
Provides additional selections for named shadows and geolocation data.
\nTo add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to\n be ON and specify your shadow names in namedShadowNames filter.
To add geolocation data to your fleet indexing configuration:
\nIf you store geolocation data in a class/unnamed shadow, set\n thingIndexingMode to be REGISTRY_AND_SHADOW and specify your\n geolocation data in geoLocations filter.
If you store geolocation data in a named shadow, set\n namedShadowIndexingMode to be ON, add the shadow name in\n namedShadowNames filter, and specify your geolocation data in\n geoLocations filter. For more information, see Managing fleet\n indexing.
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
\n\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.
" + "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.
\n\n Note:The following Length Constraints relates to a single ARN. \n Up to 25 package version ARNs are allowed.
" } } }, @@ -19660,14 +19692,14 @@ "behaviorCriteriaType": { "target": "com.amazonaws.iot#BehaviorCriteriaType", "traits": { - "smithy.api#documentation": "The criteria for a behavior.
", + "smithy.api#documentation": "\n The criteria for a behavior.\n
", "smithy.api#httpQuery": "behaviorCriteriaType" } }, "listSuppressedAlerts": { "target": "com.amazonaws.iot#ListSuppressedAlerts", "traits": { - "smithy.api#documentation": "A list of all suppressed alerts.
", + "smithy.api#documentation": "\n A list of all suppressed alerts.\n
", "smithy.api#httpQuery": "listSuppressedAlerts" } }, @@ -19709,7 +19741,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, \n or null if there are no additional results.
Lists the findings (results) of a Device Defender audit or of the audits performed during\n a specified time period. (Findings are retained for 90 days.)
\nRequires permission to access the ListAuditFindings action.
", + "smithy.api#documentation": "Lists the findings (results) of a Device Defender audit or of the audits\n performed during a specified time period. (Findings are retained for 90 days.)
\nRequires permission to access the ListAuditFindings action.
", "smithy.api#http": { "method": "POST", "uri": "/audit/findings", @@ -19861,7 +19893,7 @@ "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { - "smithy.api#documentation": "A filter to limit results to the audit with the specified ID. You must specify either the\n taskId or the startTime and endTime, but not both.
" + "smithy.api#documentation": "A filter to limit results to the audit with the specified ID. You must\n specify either the taskId or the startTime and endTime, but not both.
" } }, "checkName": { @@ -19891,13 +19923,13 @@ "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "A filter to limit results to those found after the specified time. You must specify either\n the startTime and endTime or the taskId, but not both.
" + "smithy.api#documentation": "A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.
" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "A filter to limit results to those found before the specified time. You must specify\n either the startTime and endTime or the taskId, but not both.
" + "smithy.api#documentation": "A filter to limit results to those found before the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.
" } }, "listSuppressedFindings": { @@ -19924,7 +19956,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, or null \n if there are no additional results.
Gets the status of audit mitigation action tasks that were executed.
\nRequires permission to access the ListAuditMitigationActionsExecutions action.
", + "smithy.api#documentation": "Gets the status of audit mitigation action tasks that were\n executed.
\nRequires permission to access the ListAuditMitigationActionsExecutions action.
", "smithy.api#http": { "method": "GET", "uri": "/audit/mitigationactions/executions", @@ -19972,7 +20004,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "Specify this filter to limit results to actions for a specific audit mitigation actions\n task.
", + "smithy.api#documentation": "Specify this filter to limit results to actions for a specific audit mitigation actions task.
", "smithy.api#httpQuery": "taskId", "smithy.api#required": {} } @@ -19987,7 +20019,7 @@ "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "Specify this filter to limit results to those that were applied to a specific audit\n finding.
", + "smithy.api#documentation": "Specify this filter to limit results to those that were applied to a specific audit finding.
", "smithy.api#httpQuery": "findingId", "smithy.api#required": {} } @@ -20017,7 +20049,7 @@ "actionsExecutions": { "target": "com.amazonaws.iot#AuditMitigationActionExecutionMetadataList", "traits": { - "smithy.api#documentation": "A set of task execution results based on the input parameters. Details include the\n mitigation action applied, start time, and task status.
" + "smithy.api#documentation": "A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.
" } }, "nextToken": { @@ -20071,14 +20103,14 @@ "auditTaskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { - "smithy.api#documentation": "Specify this filter to limit results to tasks that were applied to results for a specific\n audit.
", + "smithy.api#documentation": "Specify this filter to limit results to tasks that were applied to results for a specific audit.
", "smithy.api#httpQuery": "auditTaskId" } }, "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "Specify this filter to limit results to tasks that were applied to a specific audit\n finding.
", + "smithy.api#documentation": "Specify this filter to limit results to tasks that were applied to a specific audit finding.
", "smithy.api#httpQuery": "findingId" } }, @@ -20106,7 +20138,7 @@ "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "Specify this filter to limit results to tasks that began on or after a specific date and\n time.
", + "smithy.api#documentation": "Specify this filter to limit results to tasks that began on or after a specific date and time.
", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } @@ -20114,7 +20146,7 @@ "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "Specify this filter to limit results to tasks that were completed or canceled on or before\n a specific date and time.
", + "smithy.api#documentation": "Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.
", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } @@ -20251,7 +20283,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Device Defender audits that have been performed during a given time\n period.
\nRequires permission to access the ListAuditTasks action.
", + "smithy.api#documentation": "Lists the Device Defender audits that have been performed during a given\n time period.
\nRequires permission to access the ListAuditTasks action.
", "smithy.api#http": { "method": "GET", "uri": "/audit/tasks", @@ -20271,7 +20303,7 @@ "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "The beginning of the time period. Audit information is retained for a limited time (90\n days). Requesting a start time prior to what is retained results in an\n \"InvalidRequestException\".
", + "smithy.api#documentation": "The beginning of the time period. Audit information is retained for a \n limited time (90 days). Requesting a start time prior to what is retained \n results in an \"InvalidRequestException\".
", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } @@ -20287,14 +20319,14 @@ "taskType": { "target": "com.amazonaws.iot#AuditTaskType", "traits": { - "smithy.api#documentation": "A filter to limit the output to the specified type of audit: can be one of\n \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".
", + "smithy.api#documentation": "A filter to limit the output to the specified type of audit: can be one of\n \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".
", "smithy.api#httpQuery": "taskType" } }, "taskStatus": { "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { - "smithy.api#documentation": "A filter to limit the output to audits with the specified completion status: can be one of\n \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".
", + "smithy.api#documentation": "A filter to limit the output to audits with the specified completion\n status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".
", "smithy.api#httpQuery": "taskStatus" } }, @@ -20329,7 +20361,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, or null \n if there are no additional results.
Lists your Device Defender detect custom metrics.
\nRequires permission to access the ListCustomMetrics action.
", + "smithy.api#documentation": "\n Lists your Device Defender detect custom metrics.\n
\nRequires permission to access the ListCustomMetrics action.
", "smithy.api#http": { "method": "GET", "uri": "/custom-metrics", @@ -20851,14 +20883,14 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "The token for the next set of results.
", + "smithy.api#documentation": "\n The token for the next set of results.\n
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to return at one time. The default is 25.
", + "smithy.api#documentation": "\n The maximum number of results to return at one time. The default is 25.\n
", "smithy.api#httpQuery": "maxResults" } } @@ -20873,13 +20905,13 @@ "metricNames": { "target": "com.amazonaws.iot#MetricNames", "traits": { - "smithy.api#documentation": "The name of the custom metric.
" + "smithy.api#documentation": "\n The name of the custom metric.\n
" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": " A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
\n A token that can be used to retrieve the next set of results, \n or null if there are no additional results.\n
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
\nRequires permission to access the ListDetectMitigationActionsExecutions action.
", + "smithy.api#documentation": "\n Lists mitigation actions executions for a Device Defender ML Detect Security Profile.\n
\nRequires permission to access the ListDetectMitigationActionsExecutions action.
", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/executions", @@ -20927,49 +20959,49 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "The unique identifier of the task.
", + "smithy.api#documentation": "\n The unique identifier of the task.\n
", "smithy.api#httpQuery": "taskId" } }, "violationId": { "target": "com.amazonaws.iot#ViolationId", "traits": { - "smithy.api#documentation": "The unique identifier of the violation.
", + "smithy.api#documentation": "\n The unique identifier of the violation.\n
", "smithy.api#httpQuery": "violationId" } }, "thingName": { "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { - "smithy.api#documentation": "The name of the thing whose mitigation actions are listed.
", + "smithy.api#documentation": "\n The name of the thing whose mitigation actions are listed.\n
", "smithy.api#httpQuery": "thingName" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "A filter to limit results to those found after the specified time. You must specify\n either the startTime and endTime or the taskId, but not both.
", + "smithy.api#documentation": "\n A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.\n
", "smithy.api#httpQuery": "startTime" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "The end of the time period for which ML Detect mitigation actions executions are\n returned.
", + "smithy.api#documentation": "\n The end of the time period for which ML Detect mitigation actions executions are returned.\n
", "smithy.api#httpQuery": "endTime" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to return at one time. The default is 25.
", + "smithy.api#documentation": "\n The maximum number of results to return at one time. The default is 25.\n
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "The token for the next set of results.
", + "smithy.api#documentation": "\n The token for the next set of results.\n
", "smithy.api#httpQuery": "nextToken" } } @@ -20984,13 +21016,13 @@ "actionsExecutions": { "target": "com.amazonaws.iot#DetectMitigationActionExecutionList", "traits": { - "smithy.api#documentation": "List of actions executions.
" + "smithy.api#documentation": "\n List of actions executions.\n
" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": " A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n
List of Device Defender ML Detect mitigation actions tasks.
\nRequires permission to access the ListDetectMitigationActionsTasks action.
", + "smithy.api#documentation": "\n List of Device Defender ML Detect mitigation actions tasks.\n
\nRequires permission to access the ListDetectMitigationActionsTasks action.
", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/tasks", @@ -21045,14 +21077,14 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "The token for the next set of results.
", + "smithy.api#documentation": "\n The token for the next set of results.\n
", "smithy.api#httpQuery": "nextToken" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "A filter to limit results to those found after the specified time. You must specify\n either the startTime and endTime or the taskId, but not both.
", + "smithy.api#documentation": "\n A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.\n
", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } @@ -21060,7 +21092,7 @@ "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "The end of the time period for which ML Detect mitigation actions tasks are returned.\n
", + "smithy.api#documentation": "\n The end of the time period for which ML Detect mitigation actions tasks are returned.\n
", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } @@ -21076,13 +21108,13 @@ "tasks": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskSummaryList", "traits": { - "smithy.api#documentation": "The collection of ML Detect mitigation tasks that matched the filter criteria.
" + "smithy.api#documentation": "\n The collection of ML Detect mitigation tasks that matched the filter criteria.\n
" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": " A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n
A list of the names of the defined dimensions. Use DescribeDimension to get\n details for a dimension.
A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.
A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, or null if there are no additional results.
Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric,\n or custom metric) by the given thing during the specified time period.
", + "smithy.api#documentation": "Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) \n by the given thing during the specified time period.
", "smithy.api#http": { "method": "GET", "uri": "/metric-values", @@ -22014,7 +22046,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, or null \n if there are no additional results.
Specify a value to limit the result to mitigation actions with a specific action\n type.
", + "smithy.api#documentation": "Specify a value to limit the result to mitigation actions with a specific action type.
", "smithy.api#httpQuery": "actionType" } }, @@ -23109,7 +23141,7 @@ } ], "traits": { - "smithy.api#documentation": "The related resources of an Audit finding. The following resources can be returned from\n calling this API:
\nDEVICE_CERTIFICATE
\nCA_CERTIFICATE
\nIOT_POLICY
\nCOGNITO_IDENTITY_POOL
\nCLIENT_ID
\nACCOUNT_SETTINGS
\nROLE_ALIAS
\nIAM_ROLE
\nISSUER_CERTIFICATE
\nThis API is similar to DescribeAuditFinding's RelatedResources but\n provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device\n certificates check, RelatedResources will not be populated. You must use this API,\n ListRelatedResourcesForAuditFinding, to list the certificates.
\nThe related resources of an Audit finding. \n The following resources can be returned from calling this API:
\nDEVICE_CERTIFICATE
\nCA_CERTIFICATE
\nIOT_POLICY
\nCOGNITO_IDENTITY_POOL
\nCLIENT_ID
\nACCOUNT_SETTINGS
\nROLE_ALIAS
\nIAM_ROLE
\nISSUER_CERTIFICATE
\nThis API is similar to DescribeAuditFinding's RelatedResources \n but provides pagination and is not limited to 10 resources. \n When calling DescribeAuditFinding for the intermediate CA revoked for \n active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.
\nA token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, \n or null if there are no additional results.
A token that can be used to retrieve the next set of results, or null for the\n first API call.
A token that can be used to retrieve the next set of results, \n or null for the first API call.
A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, \n or null if there are no additional results.
Lists the Device Defender security profiles you've created. You can filter security\n profiles by dimension or custom metric.
\nRequires permission to access the ListSecurityProfiles action.
\n\n dimensionName and metricName cannot be used in the same\n request.
Lists the Device Defender security profiles\n you've\n created. You can filter security profiles by dimension or custom metric.
\nRequires permission to access the ListSecurityProfiles action.
\n\n dimensionName and metricName cannot be used in the same request.
The ARN of the target (thing group) whose attached security profiles you want to\n get.
", + "smithy.api#documentation": "The ARN of the target (thing group) whose attached security profiles you want to get.
", "smithy.api#httpQuery": "securityProfileTargetArn", "smithy.api#required": {} } @@ -23463,7 +23495,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, or null if there are no\n additional results.
A filter to limit results to the security profiles that use the defined dimension. Cannot\n be used with metricName\n
A filter to limit results to the security profiles that use the defined dimension.\n Cannot be used with metricName\n
The name of the custom metric. Cannot be used with dimensionName.
The name of the custom metric.\n Cannot be used with dimensionName.
A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, or null if there are no\n additional results.
Lists the targets (thing groups) associated with a given Device Defender security\n profile.
\nRequires permission to access the ListTargetsForSecurityProfile action.
", + "smithy.api#documentation": "Lists the targets (thing groups) associated with a given Device Defender security profile.
\nRequires permission to access the ListTargetsForSecurityProfile action.
", "smithy.api#http": { "method": "GET", "uri": "/security-profiles/{securityProfileName}/targets", @@ -23880,7 +23912,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, or null if there are no\n additional results.
Lists the Device Defender security profile violations discovered during the given time\n period. You can use filters to limit the results to those alerts issued for a particular\n security profile, behavior, or thing (device).
\nRequires permission to access the ListViolationEvents action.
", + "smithy.api#documentation": "Lists the Device Defender security profile violations discovered during the given time period. \n You can use filters to limit the results to those alerts issued for a particular security profile, \n behavior, or thing (device).
\nRequires permission to access the ListViolationEvents action.
", "smithy.api#http": { "method": "GET", "uri": "/violation-events", @@ -25063,21 +25095,21 @@ "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "A filter to limit results to those alerts generated by the specified security\n profile.
", + "smithy.api#documentation": "A filter to limit results to those alerts generated by the specified security profile.
", "smithy.api#httpQuery": "securityProfileName" } }, "behaviorCriteriaType": { "target": "com.amazonaws.iot#BehaviorCriteriaType", "traits": { - "smithy.api#documentation": "The criteria for a behavior.
", + "smithy.api#documentation": "\n The criteria for a behavior.\n
", "smithy.api#httpQuery": "behaviorCriteriaType" } }, "listSuppressedAlerts": { "target": "com.amazonaws.iot#ListSuppressedAlerts", "traits": { - "smithy.api#documentation": "A list of all suppressed alerts.
", + "smithy.api#documentation": "\n A list of all suppressed alerts.\n
", "smithy.api#httpQuery": "listSuppressedAlerts" } }, @@ -25113,13 +25145,13 @@ "violationEvents": { "target": "com.amazonaws.iot#ViolationEvents", "traits": { - "smithy.api#documentation": "The security profile violation alerts issued for this account during the given time\n period, potentially filtered by security profile, behavior violated, or thing (device)\n violating.
" + "smithy.api#documentation": "The security profile violation alerts issued for this account during the given time period, \n potentially filtered by security profile, behavior violated, or thing (device) violating.
" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "A token that can be used to retrieve the next set of results, or null if\n there are no additional results.
A token that can be used to retrieve the next set of results, or null if there are no\n additional results.
The maximum number of results to return at one time. The response might contain fewer results but will never contain more.
" + "smithy.api#documentation": "The maximum number of results to return per page at one time. The response might\n contain fewer results but will never contain more.
" } }, "queryVersion": { @@ -29733,7 +29765,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" + "smithy.api#pattern": "^[$a-zA-Z0-9:_-]+$" } }, "com.amazonaws.iot#SigV4Authorization": { @@ -29939,7 +29971,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "A unique identifier for the task. You can use this identifier to check the status of the\n task or to cancel it.
", + "smithy.api#documentation": "A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -29947,21 +29979,21 @@ "target": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "Specifies the audit findings to which the mitigation actions are applied. You can apply\n them to a type of audit check, to all findings from an audit, or to a specific set of\n findings.
", + "smithy.api#documentation": "Specifies the audit findings to which the mitigation actions are applied. You can apply\n them to a type of audit check, to all findings from an audit, or to a\n specific set of\n findings.
", "smithy.api#required": {} } }, "auditCheckToActionsMapping": { "target": "com.amazonaws.iot#AuditCheckToActionsMapping", "traits": { - "smithy.api#documentation": "For an audit check, specifies which mitigation actions to apply. Those actions must be\n defined in your Amazon Web Services accounts.
", + "smithy.api#documentation": "For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.
", "smithy.api#required": {} } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each audit mitigation task must have a unique client request token. If you try to start a\n new task with the same token as a task that already exists, an exception occurs. If you omit\n this value, a unique client request token is generated automatically.
", + "smithy.api#documentation": "Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -29977,7 +30009,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "The unique identifier for the audit mitigation task. This matches the taskId\n that you specified in the request.
The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.
Starts a Device Defender ML Detect mitigation actions task.
\nRequires permission to access the StartDetectMitigationActionsTask action.
", + "smithy.api#documentation": "\n Starts a Device Defender ML Detect mitigation actions task.\n
\nRequires permission to access the StartDetectMitigationActionsTask action.
", "smithy.api#http": { "method": "PUT", "uri": "/detect/mitigationactions/tasks/{taskId}", @@ -30025,7 +30057,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "The unique identifier of the task.
", + "smithy.api#documentation": "\n The unique identifier of the task.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -30033,39 +30065,39 @@ "target": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "Specifies the ML Detect findings to which the mitigation actions are applied.
", + "smithy.api#documentation": "\n Specifies the ML Detect findings to which the mitigation actions are applied.\n
", "smithy.api#required": {} } }, "actions": { "target": "com.amazonaws.iot#DetectMitigationActionsToExecuteList", "traits": { - "smithy.api#documentation": "The actions to be performed when a device has unexpected behavior.
", + "smithy.api#documentation": "\n The actions to be performed when a device has unexpected behavior.\n
", "smithy.api#required": {} } }, "violationEventOccurrenceRange": { "target": "com.amazonaws.iot#ViolationEventOccurrenceRange", "traits": { - "smithy.api#documentation": "Specifies the time period of which violation events occurred between.
" + "smithy.api#documentation": "\n Specifies the time period of which violation events occurred between.\n
" } }, "includeOnlyActiveViolations": { "target": "com.amazonaws.iot#NullableBoolean", "traits": { - "smithy.api#documentation": "Specifies to list only active violations.
" + "smithy.api#documentation": "\n Specifies to list only active violations.\n
" } }, "includeSuppressedAlerts": { "target": "com.amazonaws.iot#NullableBoolean", "traits": { - "smithy.api#documentation": "Specifies to include suppressed alerts.
" + "smithy.api#documentation": "\n Specifies to include suppressed alerts.\n
" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each mitigation action task must have a unique client request token. If you try to create\n a new task with the same token as a task that already exists, an exception occurs. If you omit\n this value, Amazon Web Services SDKs will automatically generate a unique client request.
", + "smithy.api#documentation": "\n Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.\n
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -30081,7 +30113,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "The unique identifier of the task.
" + "smithy.api#documentation": "\n The unique identifier of the task.\n
" } } }, @@ -30126,7 +30158,7 @@ "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { - "smithy.api#documentation": "Which checks are performed during the audit. The checks you specify must be enabled for\n your account or an exception occurs. Use DescribeAccountAuditConfiguration to see\n the list of all checks, including those that are enabled or\n UpdateAccountAuditConfiguration to select which checks are enabled.
Which checks are performed during the audit. The checks you specify must be enabled \n for your account or an exception occurs. Use DescribeAccountAuditConfiguration \n to see the list of all checks, including those that are enabled or \n UpdateAccountAuditConfiguration to select which checks are enabled.
Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter.\n To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and \n specify your shadow names in filter.
Provides additional selections for named shadows and geolocation data.
\nTo add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to\n be ON and specify your shadow names in namedShadowNames filter.
To add geolocation data to your fleet indexing configuration:
\nIf you store geolocation data in a class/unnamed shadow, set\n thingIndexingMode to be REGISTRY_AND_SHADOW and specify your\n geolocation data in geoLocations filter.
If you store geolocation data in a named shadow, set namedShadowIndexingMode\n to be ON, add the shadow name in namedShadowNames filter, and\n specify your geolocation data in geoLocations filter. For more information, see\n Managing fleet indexing.
Configures or reconfigures the Device Defender audit settings for this account. Settings\n include how audit notifications are sent and which audit checks are enabled or\n disabled.
\nRequires permission to access the UpdateAccountAuditConfiguration action.
", + "smithy.api#documentation": "Configures or reconfigures the Device Defender audit settings for this account.\n Settings include how audit notifications are sent and which audit checks are\n enabled or disabled.
\nRequires permission to access the UpdateAccountAuditConfiguration action.
", "smithy.api#http": { "method": "PATCH", "uri": "/audit/configuration", @@ -32711,7 +32763,7 @@ "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that grants permission to IoT to access\n information about your devices, policies, certificates, and other items as required when\n performing an audit.
" + "smithy.api#documentation": "The Amazon\n Resource Name\n (ARN)\n of the role that grants permission\n to\n IoT to access information about your devices, policies,\n certificates,\n and other items as required when performing an audit.
" } }, "auditNotificationTargetConfigurations": { @@ -32723,7 +32775,7 @@ "auditCheckConfigurations": { "target": "com.amazonaws.iot#AuditCheckConfigurations", "traits": { - "smithy.api#documentation": "Specifies which audit checks are enabled and disabled for this account. Use\n DescribeAccountAuditConfiguration to see the list of all checks, including\n those that are currently enabled.
Some data collection might start immediately when certain checks are enabled. When a check\n is disabled, any data collected so far in relation to the check is deleted.
\nYou cannot disable a check if it's used by any scheduled audit. You must first delete the\n check from the scheduled audit or delete the scheduled audit itself.
\nOn the first call to UpdateAccountAuditConfiguration, this parameter is\n required and must specify at least one enabled check.
Specifies which audit checks are enabled and disabled for this account. Use \n DescribeAccountAuditConfiguration to see the list of all checks, including those \n that are currently enabled.
Some data collection might start immediately when certain checks are enabled. \n When a check is disabled, any data collected so far in relation to the check is deleted.
\nYou\n cannot\n disable a check if\n it's\n used by any scheduled audit. You must first delete the check from the scheduled audit or\n delete the scheduled audit itself.
\nOn the first call to UpdateAccountAuditConfiguration,\n this parameter is required and must specify at least one enabled check.
Updates a Device Defender detect custom metric.
\nRequires permission to access the UpdateCustomMetric action.
", + "smithy.api#documentation": "Updates a\n Device Defender detect custom metric.
\nRequires permission to access the UpdateCustomMetric action.
", "smithy.api#http": { "method": "PATCH", "uri": "/custom-metric/{metricName}", @@ -33196,7 +33248,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "The name of the custom metric. Cannot be updated.
", + "smithy.api#documentation": "The name of the custom metric.\n Cannot be updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -33204,7 +33256,7 @@ "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { - "smithy.api#documentation": "Field represents a friendly name in the console for the custom metric, it doesn't have to\n be unique. Don't use this name as the metric identifier in the device metric report. Can be\n updated.
", + "smithy.api#documentation": "\n Field\n represents a friendly name in the console for the custom metric,\n it\n doesn't have to be unique. Don't use this name as the metric identifier in\n the device metric report.\n Can\n be updated.
", "smithy.api#required": {} } } @@ -33219,37 +33271,37 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "The name of the custom metric.
" + "smithy.api#documentation": "\n The name of the custom metric.\n
" } }, "metricArn": { "target": "com.amazonaws.iot#CustomMetricArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the custom metric.
" + "smithy.api#documentation": "\n The Amazon Resource Number (ARN) of the custom metric.\n
" } }, "metricType": { "target": "com.amazonaws.iot#CustomMetricType", "traits": { - "smithy.api#documentation": "The type of the custom metric.
\nThe type number only takes a single metric value as an input, but while\n submitting the metrics value in the DeviceMetrics report, it must be passed as an array with\n a single value.
The type of the custom metric.
\nThe type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.
A friendly name in the console for the custom metric
" + "smithy.api#documentation": "\n A friendly name in the console for the custom metric\n
" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "The creation date of the custom metric in milliseconds since epoch.
" + "smithy.api#documentation": "\n The creation date of the custom metric in milliseconds since epoch.\n
" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "The time the custom metric was last modified in milliseconds since epoch.
" + "smithy.api#documentation": "\n The time the custom metric was last modified in milliseconds since epoch.\n
" } } }, @@ -33295,7 +33347,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the definition for a dimension. You cannot change the type of a dimension after it\n is created (you can delete it and recreate it).
\nRequires permission to access the UpdateDimension action.
", + "smithy.api#documentation": "Updates the definition for a dimension. You\n cannot\n change the type of a dimension after\n it is created (you can delete it and\n recreate\n it).
\nRequires permission to access the UpdateDimension action.
", "smithy.api#http": { "method": "PATCH", "uri": "/dimensions/{name}", @@ -33309,7 +33361,7 @@ "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "A unique identifier for the dimension. Choose something that describes the type and value\n to make it easy to remember what it does.
", + "smithy.api#documentation": "A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -33317,7 +33369,7 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "Specifies the value or list of values for the dimension. For TOPIC_FILTER\n dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").
Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").
The Amazon Resource Name (ARN)of the created dimension.
" + "smithy.api#documentation": "The Amazon Resource\n Name (ARN)of\n the created dimension.
" } }, "type": { @@ -33350,19 +33402,19 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "The value or list of values used to scope the dimension. For example, for topic filters,\n this is the pattern used to match the MQTT topic name.
" + "smithy.api#documentation": "The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.
" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "The date and time, in milliseconds since epoch, when the dimension was initially\n created.
" + "smithy.api#documentation": "The date and time, in milliseconds since epoch, when the dimension was initially created.
" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "The date and time, in milliseconds since epoch, when the dimension was most recently\n updated.
" + "smithy.api#documentation": "The date and time, in milliseconds since epoch, when the dimension was most recently updated.
" } } }, @@ -33927,7 +33979,7 @@ "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { - "smithy.api#documentation": "The friendly name for the mitigation action. You cannot change the name by using\n UpdateMitigationAction. Instead, you must delete and recreate the mitigation\n action with the new name.
The friendly name for the mitigation action. You cannot change the name by using\n UpdateMitigationAction. Instead, you must delete and\n recreate the\n mitigation action with the new name.
Updates a scheduled audit, including which checks are performed and how often the audit\n takes place.
\nRequires permission to access the UpdateScheduledAudit action.
", + "smithy.api#documentation": "Updates a scheduled audit, including which checks are performed and\n how often the audit takes place.
\nRequires permission to access the UpdateScheduledAudit action.
", "smithy.api#http": { "method": "PATCH", "uri": "/audit/scheduledaudits/{scheduledAuditName}", @@ -34413,25 +34465,25 @@ "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "How often the scheduled audit takes place, either DAILY, WEEKLY,\n BIWEEKLY, or MONTHLY. The start time of each audit is determined\n by the system.
How often the scheduled audit takes\n place,\n either DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the\n system.
The day of the month on which the scheduled audit takes place. This can be 1\n through 31 or LAST. This field is required if the\n frequency parameter is set to MONTHLY. If days 29-31 are\n specified, and the month does not have that many days, the audit takes place on the \"LAST\" day\n of the month.
The day of the month on which the scheduled audit takes place.\n This\n can\n be 1 through 31 or LAST. This field is required if the frequency parameter is set to\n MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit\n takes place on the \"LAST\" day of the month.
The day of the week on which the scheduled audit takes place. This can be one of\n SUN, MON, TUE, WED, THU,\n FRI, or SAT. This field is required if the \"frequency\" parameter\n is set to WEEKLY or BIWEEKLY.
The day of the week on which the scheduled audit takes place.\n This\n can\n be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the\n \"frequency\" parameter is set to WEEKLY or BIWEEKLY.
Which checks are performed during the scheduled audit. Checks must be enabled for your\n account. (Use DescribeAccountAuditConfiguration to see the list of all checks,\n including those that are enabled or use UpdateAccountAuditConfiguration to select\n which checks are enabled.)
Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)
Specifies the behaviors that, when violated by a device (thing), cause an\n alert.
" + "smithy.api#documentation": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
" } }, "alertTargets": { @@ -34530,40 +34582,40 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "\n Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n
\nA list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here. Can be used with custom metrics; cannot be used with dimensions.
\n Please use\n UpdateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n
\nA list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the profile's behaviors, but\n it is\n also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric specified here.\n Can be used with custom metrics; cannot be used with dimensions.
" + "smithy.api#documentation": "A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
" } }, "deleteBehaviors": { "target": "com.amazonaws.iot#DeleteBehaviors", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If true, delete all behaviors defined for this security profile. If any\n behaviors are defined in the current invocation, an exception occurs.
If true, delete all behaviors defined for this security profile. \n If any behaviors are defined in the current invocation, an exception occurs.
If true, delete all alertTargets defined for this security profile. If any\n alertTargets are defined in the current invocation, an exception\n occurs.
If true, delete all alertTargets defined for this security profile. \n If any alertTargets are defined in the current invocation, an exception occurs.
If true, delete all additionalMetricsToRetain defined for this security\n profile. If any additionalMetricsToRetain are defined in the current invocation,\n an exception occurs.
If true, delete all additionalMetricsToRetain defined for this \n security profile. If any additionalMetricsToRetain are defined in the current \n invocation, an exception occurs.
The expected version of the security profile. A new version is generated whenever the\n security profile is updated. If you specify a value that is different from the actual version,\n a VersionConflictException is thrown.
The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.
Specifies the behaviors that, when violated by a device (thing), cause an\n alert.
" + "smithy.api#documentation": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
" } }, "alertTargets": { @@ -34624,13 +34676,13 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "\n Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n
\nA list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the security profile's behaviors, but it is also retained for any\n metric specified here.
\n Please use\n UpdateSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n
\nA list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the security profile's behaviors, but\n it is\n also retained for any metric specified here.
A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric specified here.\n Can be used with custom metrics; cannot be used with dimensions.
" + "smithy.api#documentation": "A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.
" } }, "version": { @@ -35172,7 +35224,7 @@ "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "Specifies the behaviors that, when violated by a device (thing), cause an\n alert.
", + "smithy.api#documentation": "Specifies the behaviors that, when violated by a device (thing), cause an alert.
", "smithy.api#required": {} } } diff --git a/codegen/sdk/aws-models/ivs-realtime.json b/codegen/sdk/aws-models/ivs-realtime.json index e42427b60e6..7383f7ee534 100644 --- a/codegen/sdk/aws-models/ivs-realtime.json +++ b/codegen/sdk/aws-models/ivs-realtime.json @@ -21,18 +21,36 @@ "type": "service", "version": "2020-07-14", "operations": [ + { + "target": "com.amazonaws.ivsrealtime#CreateEncoderConfiguration" + }, { "target": "com.amazonaws.ivsrealtime#CreateParticipantToken" }, { "target": "com.amazonaws.ivsrealtime#CreateStage" }, + { + "target": "com.amazonaws.ivsrealtime#CreateStorageConfiguration" + }, + { + "target": "com.amazonaws.ivsrealtime#DeleteEncoderConfiguration" + }, { "target": "com.amazonaws.ivsrealtime#DeleteStage" }, + { + "target": "com.amazonaws.ivsrealtime#DeleteStorageConfiguration" + }, { "target": "com.amazonaws.ivsrealtime#DisconnectParticipant" }, + { + "target": "com.amazonaws.ivsrealtime#GetComposition" + }, + { + "target": "com.amazonaws.ivsrealtime#GetEncoderConfiguration" + }, { "target": "com.amazonaws.ivsrealtime#GetParticipant" }, @@ -42,6 +60,15 @@ { "target": "com.amazonaws.ivsrealtime#GetStageSession" }, + { + "target": "com.amazonaws.ivsrealtime#GetStorageConfiguration" + }, + { + "target": "com.amazonaws.ivsrealtime#ListCompositions" + }, + { + "target": "com.amazonaws.ivsrealtime#ListEncoderConfigurations" + }, { "target": "com.amazonaws.ivsrealtime#ListParticipantEvents" }, @@ -54,9 +81,18 @@ { "target": "com.amazonaws.ivsrealtime#ListStageSessions" }, + { + "target": "com.amazonaws.ivsrealtime#ListStorageConfigurations" + }, { "target": "com.amazonaws.ivsrealtime#ListTagsForResource" }, + { + "target": "com.amazonaws.ivsrealtime#StartComposition" + }, + { + "target": "com.amazonaws.ivsrealtime#StopComposition" + }, { "target": "com.amazonaws.ivsrealtime#TagResource" }, @@ -98,7 +134,7 @@ "date" ] }, - "smithy.api#documentation": "\n Introduction\n
\nThe Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP \n\t API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, \n\t including errors.\n
\nTerminology:
\nA stage is a virtual space where participants can exchange video in real time.
\nA participant token is a token that authenticates a participant when they join a stage.
\nA participant object represents participants\n (people) in the stage and contains information about them. When a token is created, it\n includes a participant ID; when a participant uses that token to join a stage, the\n participant is associated with that participant ID There is a 1:1 mapping between\n participant tokens and participants.
\n\n Resources\n
\nThe following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
\n\n Stage — A stage is a virtual space where participants can exchange video in real time.
\n\n Tagging\n
\nA tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS Resources for more information, including restrictions that apply to\n tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific\n constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see Access Tags).
\nThe Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Stage.
\nAt most 50 tags can be applied to a resource.
\n\n Stages Endpoints\n
\n\n CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
\n\n CreateStage — Creates a new stage (and optionally participant tokens).
\n\n DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
\n\n DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
\n\n GetParticipant — Gets information about the specified\n participant token.
\n\n GetStage — Gets information for the specified stage.
\n\n GetStageSession — Gets information for the specified stage\n session.
\n\n ListParticipantEvents — Lists events for a specified\n participant that occurred during a specified stage session.
\n\n ListParticipants — Lists all participants in a specified stage\n session.
\n\n ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
\n\n ListStageSessions — Gets all sessions for a specified stage.
\n\n UpdateStage — Updates a stage’s configuration.
\n\n Tags Endpoints\n
\n\n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.
\n\n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\n\n Introduction\n
\nThe Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP \n\t API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, \n\t including errors.\n
\nTerminology:
\nA stage is a virtual space where participants can exchange video in real time.
\nA participant token is a token that authenticates a participant when they join a stage.
\nA participant object represents participants (people) in the stage and\n contains information about them. When a token is created, it includes a participant ID;\n when a participant uses that token to join a stage, the participant is associated with\n that participant ID. There is a 1:1 mapping between participant tokens and\n participants.
\nServer-side composition: The composition process composites participants\n of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).\n Composition endpoints support this process.
\nServer-side composition: A composition controls the look of the outputs,\n including how participants are positioned in the video.
\n\n Resources\n
\nThe following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
\n\n Stage — A stage is a virtual space where participants can exchange video in real time.
\n\n Tagging\n
\nA tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS Resources for more information, including restrictions that apply to\n tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific\n constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see Access Tags).
\nThe Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Stage.
\nAt most 50 tags can be applied to a resource.
\n\n Stages Endpoints\n
\n\n CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
\n\n CreateStage — Creates a new stage (and optionally participant tokens).
\n\n DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
\n\n DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
\n\n GetParticipant — Gets information about the specified\n participant token.
\n\n GetStage — Gets information for the specified stage.
\n\n GetStageSession — Gets information for the specified stage\n session.
\n\n ListParticipantEvents — Lists events for a specified\n participant that occurred during a specified stage session.
\n\n ListParticipants — Lists all participants in a specified stage\n session.
\n\n ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
\n\n ListStageSessions — Gets all sessions for a specified stage.
\n\n UpdateStage — Updates a stage’s configuration.
\n\n Composition Endpoints\n
\n\n GetComposition — Gets information about the specified\n Composition resource.
\n\n ListCompositions — Gets summary information about all\n Compositions in your account, in the AWS region where the API request is processed.
\n\n StartComposition — Starts a Composition from a stage based on\n the configuration provided in the request.
\n\n StopComposition — Stops and deletes a Composition resource.\n Any broadcast from the Composition resource is stopped.
\n\n EncoderConfiguration Endpoints\n
\n\n CreateEncoderConfiguration — Creates an EncoderConfiguration object.
\n\n DeleteEncoderConfiguration — Deletes an EncoderConfiguration\n resource. Ensures that no Compositions are using this template; otherwise, returns an\n error.
\n\n GetEncoderConfiguration — Gets information about the specified\n EncoderConfiguration resource.
\n\n ListEncoderConfigurations — Gets summary information about all\n EncoderConfigurations in your account, in the AWS region where the API request is\n processed.
\n\n StorageConfiguration Endpoints\n
\n\n CreateStorageConfiguration — Creates a new storage configuration, used to enable \n\t\trecording to Amazon S3.
\n\n DeleteStorageConfiguration — Deletes the storage configuration for the specified ARN.
\n\n GetStorageConfiguration — Gets the storage configuration for the specified ARN.
\n\n ListStorageConfigurations — Gets summary information about all storage configurations in your \n\t\taccount, in the AWS region where the API request is processed.
\n\n Tags Endpoints\n
\n\n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.
\n\n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\nARN of the channel to use for broadcasting. The channel and stage resources must be in\n the same AWS account and region. The channel must be offline (not broadcasting).
", + "smithy.api#required": {} + } + }, + "encoderConfigurationArn": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationArn", + "traits": { + "smithy.api#documentation": "ARN of the EncoderConfiguration resource. The encoder configuration\n and stage resources must be in the same AWS account and region.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object specifying a channel as a destination.
" + } + }, + "com.amazonaws.ivsrealtime#Composition": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#CompositionArn", + "traits": { + "smithy.api#documentation": "ARN of the Composition resource.
", + "smithy.api#required": {} + } + }, + "stageArn": { + "target": "com.amazonaws.ivsrealtime#StageArn", + "traits": { + "smithy.api#documentation": "ARN of the stage used as input
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.ivsrealtime#CompositionState", + "traits": { + "smithy.api#documentation": "State of the Composition.
", + "smithy.api#required": {} + } + }, + "layout": { + "target": "com.amazonaws.ivsrealtime#LayoutConfiguration", + "traits": { + "smithy.api#documentation": "Layout object to configure composition parameters.
", + "smithy.api#required": {} + } + }, + "destinations": { + "target": "com.amazonaws.ivsrealtime#DestinationList", + "traits": { + "smithy.api#documentation": "Array of Destination objects. A Composition can contain either one destination \n\t (channel or s3) or two (one channel and one s3).
Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.
UTC time of the Composition start. This is an ISO 8601 timestamp; note that\n this is returned as a string.
" + } + }, + "endTime": { + "target": "com.amazonaws.ivsrealtime#Time", + "traits": { + "smithy.api#documentation": "UTC time of the Composition end. This is an ISO 8601 timestamp; note that\n this is returned as a string.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object specifying a Composition resource.
" + } + }, + "com.amazonaws.ivsrealtime#CompositionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:composition/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.ivsrealtime#CompositionClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.ivsrealtime#CompositionState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.ivsrealtime#CompositionSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#CompositionArn", + "traits": { + "smithy.api#documentation": "ARN of the Composition resource.
", + "smithy.api#required": {} + } + }, + "stageArn": { + "target": "com.amazonaws.ivsrealtime#StageArn", + "traits": { + "smithy.api#documentation": "ARN of the attached stage.
", + "smithy.api#required": {} + } + }, + "destinations": { + "target": "com.amazonaws.ivsrealtime#DestinationSummaryList", + "traits": { + "smithy.api#documentation": "Array of Destination objects.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.ivsrealtime#CompositionState", + "traits": { + "smithy.api#documentation": "State of the Composition resource.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.
UTC time of the Composition start. This is an ISO 8601 timestamp; note that\n this is returned as a string.
" + } + }, + "endTime": { + "target": "com.amazonaws.ivsrealtime#Time", + "traits": { + "smithy.api#documentation": "UTC time of the Composition end. This is an ISO 8601 timestamp; note that\n this is returned as a string.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a Composition.
" + } + }, + "com.amazonaws.ivsrealtime#CompositionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivsrealtime#CompositionSummary" + } + }, "com.amazonaws.ivsrealtime#ConflictException": { "type": "structure", "members": { @@ -782,6 +1036,85 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.ivsrealtime#CreateEncoderConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#CreateEncoderConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#CreateEncoderConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, + { + "target": "com.amazonaws.ivsrealtime#PendingVerification" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an EncoderConfiguration object.
", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateEncoderConfiguration" + } + } + }, + "com.amazonaws.ivsrealtime#CreateEncoderConfigurationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationName", + "traits": { + "smithy.api#documentation": "Optional name to identify the resource.
" + } + }, + "video": { + "target": "com.amazonaws.ivsrealtime#Video", + "traits": { + "smithy.api#documentation": "Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30\n fps.
" + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.
The EncoderConfiguration that was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ivsrealtime#CreateParticipantToken": { "type": "operation", "input": { @@ -828,8 +1161,7 @@ "duration": { "target": "com.amazonaws.ivsrealtime#ParticipantTokenDurationMinutes", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "Duration (in minutes), after which the token expires. Default: 720 (12 hours).
" + "smithy.api#documentation": "Duration (in minutes), after which the token expires. Default: 720 (12 hours).
" } }, "userId": { @@ -933,13 +1265,151 @@ } } }, - "com.amazonaws.ivsrealtime#DeleteStage": { + "com.amazonaws.ivsrealtime#CreateStorageConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.ivsrealtime#DeleteStageRequest" + "target": "com.amazonaws.ivsrealtime#CreateStorageConfigurationRequest" }, "output": { - "target": "com.amazonaws.ivsrealtime#DeleteStageResponse" + "target": "com.amazonaws.ivsrealtime#CreateStorageConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, + { + "target": "com.amazonaws.ivsrealtime#PendingVerification" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new storage configuration, used to enable recording to Amazon S3. \n\t When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. \n\t This will ensure that IVS has sufficient permissions to write content to the provided bucket.
", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateStorageConfiguration" + } + } + }, + "com.amazonaws.ivsrealtime#CreateStorageConfigurationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationName", + "traits": { + "smithy.api#documentation": "Storage configuration name. The value does not need to be unique.
" + } + }, + "s3": { + "target": "com.amazonaws.ivsrealtime#S3StorageConfiguration", + "traits": { + "smithy.api#documentation": "A complex type that contains a storage configuration for where recorded video will be stored.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.
The StorageConfiguration that was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ivsrealtime#DeleteEncoderConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#DeleteEncoderConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#DeleteEncoderConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this\n template; otherwise, returns an error.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteEncoderConfiguration" + } + } + }, + "com.amazonaws.ivsrealtime#DeleteEncoderConfigurationRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationArn", + "traits": { + "smithy.api#documentation": "ARN of the EncoderConfiguration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#DeleteEncoderConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ivsrealtime#DeleteStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#DeleteStageRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#DeleteStageResponse" }, "errors": [ { @@ -978,25 +1448,816 @@ } } }, - "com.amazonaws.ivsrealtime#DeleteStageResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.ivsrealtime#DisconnectParticipant": { + "com.amazonaws.ivsrealtime#DeleteStageResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ivsrealtime#DeleteStorageConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#DeleteStorageConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#DeleteStorageConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the storage configuration for the specified ARN.
\nIf you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). \n\t To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, \n\t then use DeleteStorageConfiguration.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteStorageConfiguration" + } + } + }, + "com.amazonaws.ivsrealtime#DeleteStorageConfigurationRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationArn", + "traits": { + "smithy.api#documentation": "ARN of the storage configuration to be deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#DeleteStorageConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ivsrealtime#Destination": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.ivsrealtime#String", + "traits": { + "smithy.api#documentation": "Unique identifier for this destination, assigned by IVS.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.ivsrealtime#DestinationState", + "traits": { + "smithy.api#documentation": "State of the Composition Destination.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.ivsrealtime#Time", + "traits": { + "smithy.api#documentation": "UTC time of the destination start. This is an ISO 8601 timestamp; note that\n this is returned as a string.
" + } + }, + "endTime": { + "target": "com.amazonaws.ivsrealtime#Time", + "traits": { + "smithy.api#documentation": "UTC time of the destination end. This is an ISO 8601 timestamp; note that this\n is returned as a string.
" + } + }, + "configuration": { + "target": "com.amazonaws.ivsrealtime#DestinationConfiguration", + "traits": { + "smithy.api#documentation": "Configuration used to create this destination.
", + "smithy.api#required": {} + } + }, + "detail": { + "target": "com.amazonaws.ivsrealtime#DestinationDetail", + "traits": { + "smithy.api#documentation": "Optional details regarding the status of the destination.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object specifying the status of a Destination.
" + } + }, + "com.amazonaws.ivsrealtime#DestinationConfiguration": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ivsrealtime#DestinationConfigurationName", + "traits": { + "smithy.api#documentation": "Name that can be specified to help identify the destination.
" + } + }, + "channel": { + "target": "com.amazonaws.ivsrealtime#ChannelDestinationConfiguration", + "traits": { + "smithy.api#documentation": "An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an \n\t s3 must be specified.
An S3 storage configuration to be used for recording video data. Either a channel \n\t or an s3 must be specified.
Complex data type that defines destination-configuration objects.
" + } + }, + "com.amazonaws.ivsrealtime#DestinationConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivsrealtime#DestinationConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.ivsrealtime#DestinationConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.ivsrealtime#DestinationDetail": { + "type": "structure", + "members": { + "s3": { + "target": "com.amazonaws.ivsrealtime#S3Detail", + "traits": { + "smithy.api#documentation": "An S3 detail object to return information about the S3 destination.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Complex data type that defines destination-detail objects.
" + } + }, + "com.amazonaws.ivsrealtime#DestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivsrealtime#Destination" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.ivsrealtime#DestinationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STARTING", + "value": "STARTING" + }, + { + "name": "ACTIVE", + "value": "ACTIVE" + }, + { + "name": "STOPPING", + "value": "STOPPING" + }, + { + "name": "RECONNECTING", + "value": "RECONNECTING" + }, + { + "name": "FAILED", + "value": "FAILED" + }, + { + "name": "STOPPED", + "value": "STOPPED" + } + ] + } + }, + "com.amazonaws.ivsrealtime#DestinationSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.ivsrealtime#String", + "traits": { + "smithy.api#documentation": "Unique identifier for this destination, assigned by IVS.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.ivsrealtime#DestinationState", + "traits": { + "smithy.api#documentation": "State of the Composition Destination.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.ivsrealtime#Time", + "traits": { + "smithy.api#documentation": "UTC time of the destination start. This is an ISO 8601 timestamp; note that\n this is returned as a string.
" + } + }, + "endTime": { + "target": "com.amazonaws.ivsrealtime#Time", + "traits": { + "smithy.api#documentation": "UTC time of the destination end. This is an ISO 8601 timestamp; note that this\n is returned as a string.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a Destination.
" + } + }, + "com.amazonaws.ivsrealtime#DestinationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivsrealtime#DestinationSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.ivsrealtime#DisconnectParticipant": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#DisconnectParticipantRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#DisconnectParticipantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#PendingVerification" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disconnects a specified participant and revokes the participant permanently from a\n specified stage.
", + "smithy.api#http": { + "method": "POST", + "uri": "/DisconnectParticipant" + } + } + }, + "com.amazonaws.ivsrealtime#DisconnectParticipantReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.ivsrealtime#DisconnectParticipantRequest": { + "type": "structure", + "members": { + "stageArn": { + "target": "com.amazonaws.ivsrealtime#StageArn", + "traits": { + "smithy.api#documentation": "ARN of the stage to which the participant is attached.
", + "smithy.api#required": {} + } + }, + "participantId": { + "target": "com.amazonaws.ivsrealtime#ParticipantTokenId", + "traits": { + "smithy.api#documentation": "Identifier of the participant to be disconnected. This is assigned by IVS and returned\n by CreateParticipantToken.
", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.ivsrealtime#DisconnectParticipantReason", + "traits": { + "smithy.api#documentation": "Description of why this participant is being disconnected.
" + } + } + } + }, + "com.amazonaws.ivsrealtime#DisconnectParticipantResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ivsrealtime#EncoderConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationArn", + "traits": { + "smithy.api#documentation": "ARN of the EncoderConfiguration resource.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationName", + "traits": { + "smithy.api#documentation": "Optional name to identify the resource.
" + } + }, + "video": { + "target": "com.amazonaws.ivsrealtime#Video", + "traits": { + "smithy.api#documentation": "Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30\n fps
" + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.
Settings for transcoding.
" + } + }, + "com.amazonaws.ivsrealtime#EncoderConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.ivsrealtime#EncoderConfigurationArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.ivsrealtime#EncoderConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.ivsrealtime#EncoderConfigurationSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationArn", + "traits": { + "smithy.api#documentation": "ARN of the EncoderConfiguration resource.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationName", + "traits": { + "smithy.api#documentation": "Optional name to identify the resource.
" + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.
Summary information about an EncoderConfiguration.
" + } + }, + "com.amazonaws.ivsrealtime#EncoderConfigurationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationSummary" + } + }, + "com.amazonaws.ivsrealtime#Event": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ivsrealtime#EventName", + "traits": { + "smithy.api#documentation": "The name of the event.
" + } + }, + "participantId": { + "target": "com.amazonaws.ivsrealtime#ParticipantId", + "traits": { + "smithy.api#documentation": "Unique identifier for the participant who triggered the event. This is assigned by\n IVS.
" + } + }, + "eventTime": { + "target": "com.amazonaws.ivsrealtime#Time", + "traits": { + "smithy.api#documentation": "ISO 8601 timestamp (returned as a string) for when the event occurred.
" + } + }, + "remoteParticipantId": { + "target": "com.amazonaws.ivsrealtime#ParticipantId", + "traits": { + "smithy.api#documentation": "Unique identifier for the remote participant. For a subscribe event, this is the\n publisher. For a publish or join event, this is null. This is assigned by IVS.
" + } + }, + "errorCode": { + "target": "com.amazonaws.ivsrealtime#EventErrorCode", + "traits": { + "smithy.api#documentation": "If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an\n action that the participant’s token is not allowed to do. For more information about\n participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the\n number of participants who want to publish/subscribe to a stage exceeds the quota; for more\n information, see Service Quotas.\n PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a\n publisher that doesn’t exist.
An occurrence during a stage session.
" + } + }, + "com.amazonaws.ivsrealtime#EventErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INSUFFICIENT_CAPABILITIES", + "name": "INSUFFICIENT_CAPABILITIES" + }, + { + "value": "QUOTA_EXCEEDED", + "name": "QUOTA_EXCEEDED" + }, + { + "value": "PUBLISHER_NOT_FOUND", + "name": "PUBLISHER_NOT_FOUND" + } + ] + } + }, + "com.amazonaws.ivsrealtime#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivsrealtime#Event" + } + }, + "com.amazonaws.ivsrealtime#EventName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "JOINED", + "name": "JOINED" + }, + { + "value": "LEFT", + "name": "LEFT" + }, + { + "value": "PUBLISH_STARTED", + "name": "PUBLISH_STARTED" + }, + { + "value": "PUBLISH_STOPPED", + "name": "PUBLISH_STOPPED" + }, + { + "value": "SUBSCRIBE_STARTED", + "name": "SUBSCRIBE_STARTED" + }, + { + "value": "SUBSCRIBE_STOPPED", + "name": "SUBSCRIBE_STOPPED" + }, + { + "value": "PUBLISH_ERROR", + "name": "PUBLISH_ERROR" + }, + { + "value": "SUBSCRIBE_ERROR", + "name": "SUBSCRIBE_ERROR" + }, + { + "value": "JOIN_ERROR", + "name": "JOIN_ERROR" + } + ] + } + }, + "com.amazonaws.ivsrealtime#Framerate": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 60 + } + } + }, + "com.amazonaws.ivsrealtime#GetComposition": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#GetCompositionRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#GetCompositionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get information about the specified Composition resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetComposition" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivsrealtime#GetCompositionRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#CompositionArn", + "traits": { + "smithy.api#documentation": "ARN of the Composition resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#GetCompositionResponse": { + "type": "structure", + "members": { + "composition": { + "target": "com.amazonaws.ivsrealtime#Composition", + "traits": { + "smithy.api#documentation": "The Composition that was returned.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ivsrealtime#GetEncoderConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#GetEncoderConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#GetEncoderConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified EncoderConfiguration resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetEncoderConfiguration" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivsrealtime#GetEncoderConfigurationRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationArn", + "traits": { + "smithy.api#documentation": "ARN of the EncoderConfiguration resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#GetEncoderConfigurationResponse": { + "type": "structure", + "members": { + "encoderConfiguration": { + "target": "com.amazonaws.ivsrealtime#EncoderConfiguration", + "traits": { + "smithy.api#documentation": "The EncoderConfiguration that was returned.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ivsrealtime#GetParticipant": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#GetParticipantRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#GetParticipantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified participant token.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetParticipant" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivsrealtime#GetParticipantRequest": { + "type": "structure", + "members": { + "stageArn": { + "target": "com.amazonaws.ivsrealtime#StageArn", + "traits": { + "smithy.api#documentation": "Stage ARN.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.ivsrealtime#StageSessionId", + "traits": { + "smithy.api#documentation": "ID of a session within the stage.
", + "smithy.api#required": {} + } + }, + "participantId": { + "target": "com.amazonaws.ivsrealtime#ParticipantId", + "traits": { + "smithy.api#documentation": "Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#GetParticipantResponse": { + "type": "structure", + "members": { + "participant": { + "target": "com.amazonaws.ivsrealtime#Participant", + "traits": { + "smithy.api#documentation": "The participant that is returned.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ivsrealtime#GetStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#GetStageRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#GetStageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information for the specified stage.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetStage" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivsrealtime#GetStageRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#StageArn", + "traits": { + "smithy.api#documentation": "ARN of the stage for which the information is to be retrieved.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivsrealtime#GetStageResponse": { + "type": "structure", + "members": { + "stage": { + "target": "com.amazonaws.ivsrealtime#Stage", + "traits": { + "smithy.api#documentation": "The stage that is returned.
" + } + } + } + }, + "com.amazonaws.ivsrealtime#GetStageSession": { "type": "operation", "input": { - "target": "com.amazonaws.ivsrealtime#DisconnectParticipantRequest" + "target": "com.amazonaws.ivsrealtime#GetStageSessionRequest" }, "output": { - "target": "com.amazonaws.ivsrealtime#DisconnectParticipantResponse" + "target": "com.amazonaws.ivsrealtime#GetStageSessionResponse" }, "errors": [ { "target": "com.amazonaws.ivsrealtime#AccessDeniedException" }, - { - "target": "com.amazonaws.ivsrealtime#PendingVerification" - }, { "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" }, @@ -1005,322 +2266,313 @@ } ], "traits": { - "smithy.api#documentation": "Disconnects a specified participant and revokes the participant permanently from a\n specified stage.
", + "smithy.api#documentation": "Gets information for the specified stage session.
", "smithy.api#http": { "method": "POST", - "uri": "/DisconnectParticipant" - } - } - }, - "com.amazonaws.ivsrealtime#DisconnectParticipantReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } + "uri": "/GetStageSession" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.ivsrealtime#DisconnectParticipantRequest": { + "com.amazonaws.ivsrealtime#GetStageSessionRequest": { "type": "structure", "members": { "stageArn": { "target": "com.amazonaws.ivsrealtime#StageArn", "traits": { - "smithy.api#documentation": "ARN of the stage to which the participant is attached.
", + "smithy.api#documentation": "ARN of the stage for which the information is to be retrieved.
", "smithy.api#required": {} } }, - "participantId": { - "target": "com.amazonaws.ivsrealtime#ParticipantTokenId", + "sessionId": { + "target": "com.amazonaws.ivsrealtime#StageSessionId", "traits": { - "smithy.api#documentation": "Identifier of the participant to be disconnected. This is assigned by IVS and returned\n by CreateParticipantToken.
", + "smithy.api#documentation": "ID of a session within the stage.
", "smithy.api#required": {} } - }, - "reason": { - "target": "com.amazonaws.ivsrealtime#DisconnectParticipantReason", - "traits": { - "smithy.api#documentation": "Description of why this participant is being disconnected.
" - } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.ivsrealtime#DisconnectParticipantResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.ivsrealtime#Event": { + "com.amazonaws.ivsrealtime#GetStageSessionResponse": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.ivsrealtime#EventName", - "traits": { - "smithy.api#documentation": "The name of the event.
" - } - }, - "participantId": { - "target": "com.amazonaws.ivsrealtime#ParticipantId", - "traits": { - "smithy.api#documentation": "Unique identifier for the participant who triggered the event. This is assigned by\n IVS.
" - } - }, - "eventTime": { - "target": "com.amazonaws.ivsrealtime#Time", - "traits": { - "smithy.api#documentation": "ISO 8601 timestamp (returned as a string) for when the event occurred.
" - } - }, - "remoteParticipantId": { - "target": "com.amazonaws.ivsrealtime#ParticipantId", - "traits": { - "smithy.api#documentation": "Unique identifier for the remote participant. For a subscribe event, this is the\n publisher. For a publish or join event, this is null. This is assigned by IVS.
" - } - }, - "errorCode": { - "target": "com.amazonaws.ivsrealtime#EventErrorCode", + "stageSession": { + "target": "com.amazonaws.ivsrealtime#StageSession", "traits": { - "smithy.api#documentation": "If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an\n action that the participant’s token is not allowed to do. For more information about\n participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the\n number of participants who want to publish/subscribe to a stage exceeds the quota; for more\n information, see Service Quotas.\n PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a\n publisher that doesn’t exist.
The stage session that is returned.
" } } }, "traits": { - "smithy.api#documentation": "An occurrence during a stage session.
" - } - }, - "com.amazonaws.ivsrealtime#EventErrorCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INSUFFICIENT_CAPABILITIES", - "name": "INSUFFICIENT_CAPABILITIES" - }, - { - "value": "QUOTA_EXCEEDED", - "name": "QUOTA_EXCEEDED" - }, - { - "value": "PUBLISHER_NOT_FOUND", - "name": "PUBLISHER_NOT_FOUND" - } - ] - } - }, - "com.amazonaws.ivsrealtime#EventList": { - "type": "list", - "member": { - "target": "com.amazonaws.ivsrealtime#Event" - } - }, - "com.amazonaws.ivsrealtime#EventName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JOINED", - "name": "JOINED" - }, - { - "value": "LEFT", - "name": "LEFT" - }, - { - "value": "PUBLISH_STARTED", - "name": "PUBLISH_STARTED" - }, - { - "value": "PUBLISH_STOPPED", - "name": "PUBLISH_STOPPED" - }, - { - "value": "SUBSCRIBE_STARTED", - "name": "SUBSCRIBE_STARTED" - }, - { - "value": "SUBSCRIBE_STOPPED", - "name": "SUBSCRIBE_STOPPED" - }, - { - "value": "PUBLISH_ERROR", - "name": "PUBLISH_ERROR" - }, - { - "value": "SUBSCRIBE_ERROR", - "name": "SUBSCRIBE_ERROR" - }, - { - "value": "JOIN_ERROR", - "name": "JOIN_ERROR" - } - ] + "smithy.api#output": {} } }, - "com.amazonaws.ivsrealtime#GetParticipant": { + "com.amazonaws.ivsrealtime#GetStorageConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.ivsrealtime#GetParticipantRequest" + "target": "com.amazonaws.ivsrealtime#GetStorageConfigurationRequest" }, "output": { - "target": "com.amazonaws.ivsrealtime#GetParticipantResponse" + "target": "com.amazonaws.ivsrealtime#GetStorageConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ivsrealtime#AccessDeniedException" }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, { "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.ivsrealtime#ValidationException" } ], "traits": { - "smithy.api#documentation": "Gets information about the specified participant token.
", + "smithy.api#documentation": "Gets the storage configuration for the specified ARN.
", "smithy.api#http": { "method": "POST", - "uri": "/GetParticipant" + "uri": "/GetStorageConfiguration" }, "smithy.api#readonly": {} } }, - "com.amazonaws.ivsrealtime#GetParticipantRequest": { + "com.amazonaws.ivsrealtime#GetStorageConfigurationRequest": { "type": "structure", "members": { - "stageArn": { - "target": "com.amazonaws.ivsrealtime#StageArn", + "arn": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationArn", "traits": { - "smithy.api#documentation": "Stage ARN.
", + "smithy.api#documentation": "ARN of the storage configuration to be retrieved.
", "smithy.api#required": {} } - }, - "sessionId": { - "target": "com.amazonaws.ivsrealtime#StageSessionId", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#GetStorageConfigurationResponse": { + "type": "structure", + "members": { + "storageConfiguration": { + "target": "com.amazonaws.ivsrealtime#StorageConfiguration", "traits": { - "smithy.api#documentation": "ID of a session within the stage.
", - "smithy.api#required": {} + "smithy.api#documentation": "The StorageConfiguration that was returned.
" } - }, - "participantId": { - "target": "com.amazonaws.ivsrealtime#ParticipantId", + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ivsrealtime#GridConfiguration": { + "type": "structure", + "members": { + "featuredParticipantAttribute": { + "target": "com.amazonaws.ivsrealtime#AttributeKey", "traits": { - "smithy.api#documentation": "Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
", - "smithy.api#required": {} + "smithy.api#documentation": "This attribute name identifies the featured slot. A participant with this attribute set\n to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured\n slot.
Configuration information specific to Grid layout, for server-side composition. See\n \"Layouts\" in Server-Side\n Composition.
" } }, - "com.amazonaws.ivsrealtime#GetParticipantResponse": { + "com.amazonaws.ivsrealtime#Height": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1920 + } + } + }, + "com.amazonaws.ivsrealtime#InternalServerException": { "type": "structure", "members": { - "participant": { - "target": "com.amazonaws.ivsrealtime#Participant", + "exceptionMessage": { + "target": "com.amazonaws.ivsrealtime#errorMessage", "traits": { - "smithy.api#documentation": "The participant that is returned.
" + "smithy.api#documentation": "Unexpected error during processing of request.
" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "", + "smithy.api#error": "server", + "smithy.api#httpError": 500 } }, - "com.amazonaws.ivsrealtime#GetStage": { + "com.amazonaws.ivsrealtime#LayoutConfiguration": { + "type": "structure", + "members": { + "grid": { + "target": "com.amazonaws.ivsrealtime#GridConfiguration", + "traits": { + "smithy.api#documentation": "Configuration related to grid layout. Default: Grid layout.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information of supported layouts for server-side composition.
" + } + }, + "com.amazonaws.ivsrealtime#ListCompositions": { "type": "operation", "input": { - "target": "com.amazonaws.ivsrealtime#GetStageRequest" + "target": "com.amazonaws.ivsrealtime#ListCompositionsRequest" }, "output": { - "target": "com.amazonaws.ivsrealtime#GetStageResponse" + "target": "com.amazonaws.ivsrealtime#ListCompositionsResponse" }, "errors": [ { "target": "com.amazonaws.ivsrealtime#AccessDeniedException" }, { - "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.ivsrealtime#ValidationException" } ], "traits": { - "smithy.api#documentation": "Gets information for the specified stage.
", + "smithy.api#documentation": "Gets summary information about all Compositions in your account, in the AWS region\n where the API request is processed.
", "smithy.api#http": { "method": "POST", - "uri": "/GetStage" + "uri": "/ListCompositions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.ivsrealtime#GetStageRequest": { + "com.amazonaws.ivsrealtime#ListCompositionsRequest": { "type": "structure", "members": { - "arn": { + "filterByStageArn": { "target": "com.amazonaws.ivsrealtime#StageArn", "traits": { - "smithy.api#documentation": "ARN of the stage for which the information is to be retrieved.
", - "smithy.api#required": {} + "smithy.api#documentation": "Filters the Composition list to match the specified Stage ARN.
" + } + }, + "filterByEncoderConfigurationArn": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationArn", + "traits": { + "smithy.api#documentation": "Filters the Composition list to match the specified EncoderConfiguration attached to at\n least one of its output.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ivsrealtime#PaginationToken", + "traits": { + "smithy.api#documentation": "The first Composition to retrieve. This is used for pagination; see the\n nextToken response field.
Maximum number of results to return. Default: 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.ivsrealtime#GetStageResponse": { + "com.amazonaws.ivsrealtime#ListCompositionsResponse": { "type": "structure", "members": { - "stage": { - "target": "com.amazonaws.ivsrealtime#Stage", + "compositions": { + "target": "com.amazonaws.ivsrealtime#CompositionSummaryList", "traits": { - "smithy.api#documentation": "The stage that is returned.
" + "smithy.api#documentation": "List of the matching Compositions (summary information only).
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ivsrealtime#PaginationToken", + "traits": { + "smithy.api#documentation": "If there are more compositions than maxResults, use nextToken\n in the request to get the next set.
Gets information for the specified stage session.
", + "smithy.api#documentation": "Gets summary information about all EncoderConfigurations in your account, in the AWS\n region where the API request is processed.
", "smithy.api#http": { "method": "POST", - "uri": "/GetStageSession" + "uri": "/ListEncoderConfigurations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.ivsrealtime#GetStageSessionRequest": { + "com.amazonaws.ivsrealtime#ListEncoderConfigurationsRequest": { "type": "structure", "members": { - "stageArn": { - "target": "com.amazonaws.ivsrealtime#StageArn", + "nextToken": { + "target": "com.amazonaws.ivsrealtime#PaginationToken", "traits": { - "smithy.api#documentation": "ARN of the stage for which the information is to be retrieved.
", - "smithy.api#required": {} + "smithy.api#documentation": "The first encoder configuration to retrieve. This is used for pagination; see the\n nextToken response field.
ID of a session within the stage.
", - "smithy.api#required": {} + "smithy.api#documentation": "Maximum number of results to return. Default: 100.
" } } }, @@ -1328,34 +2580,25 @@ "smithy.api#input": {} } }, - "com.amazonaws.ivsrealtime#GetStageSessionResponse": { + "com.amazonaws.ivsrealtime#ListEncoderConfigurationsResponse": { "type": "structure", "members": { - "stageSession": { - "target": "com.amazonaws.ivsrealtime#StageSession", + "encoderConfigurations": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationSummaryList", "traits": { - "smithy.api#documentation": "The stage session that is returned.
" + "smithy.api#documentation": "List of the matching EncoderConfigurations (summary information only).
", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ivsrealtime#InternalServerException": { - "type": "structure", - "members": { - "exceptionMessage": { - "target": "com.amazonaws.ivsrealtime#errorMessage", + }, + "nextToken": { + "target": "com.amazonaws.ivsrealtime#PaginationToken", "traits": { - "smithy.api#documentation": "Unexpected error during processing of request.
" + "smithy.api#documentation": "If there are more encoder configurations than maxResults, use\n nextToken in the request to get the next set.
The first participant to retrieve. This is used for pagination; see the\n nextToken response field.
The first participant event to retrieve. This is used for pagination; see the\n nextToken response field.
Maximum number of results to return. Default: 50.
" } } @@ -1443,7 +2685,7 @@ "nextToken": { "target": "com.amazonaws.ivsrealtime#PaginationToken", "traits": { - "smithy.api#documentation": "If there are more rooms than maxResults, use nextToken in the\n request to get the next set.
If there are more events than maxResults, use nextToken in the\n request to get the next set.
Maximum number of results to return. Default: 50.
" } } @@ -1548,7 +2789,7 @@ "nextToken": { "target": "com.amazonaws.ivsrealtime#PaginationToken", "traits": { - "smithy.api#documentation": "If there are more rooms than maxResults, use nextToken in the\n request to get the next set.
If there are more participants than maxResults, use nextToken\n in the request to get the next set.
The first stage to retrieve. This is used for pagination; see the nextToken\n response field.
The first stage session to retrieve. This is used for pagination; see the\n nextToken response field.
Maximum number of results to return. Default: 50.
" } } @@ -1627,7 +2867,7 @@ "nextToken": { "target": "com.amazonaws.ivsrealtime#PaginationToken", "traits": { - "smithy.api#documentation": "If there are more rooms than maxResults, use nextToken in the\n request to get the next set.
If there are more stage sessions than maxResults, use\n nextToken in the request to get the next set.
Maximum number of results to return. Default: 50.
" } } @@ -1699,9 +2938,89 @@ "nextToken": { "target": "com.amazonaws.ivsrealtime#PaginationToken", "traits": { - "smithy.api#documentation": "If there are more rooms than maxResults, use nextToken in the\n request to get the next set.
If there are more stages than maxResults, use nextToken in the\n request to get the next set.
Gets summary information about all storage configurations in your account, \n\t in the AWS region where the API request is processed.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListStorageConfigurations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivsrealtime#ListStorageConfigurationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.ivsrealtime#PaginationToken", + "traits": { + "smithy.api#documentation": "The first storage configuration to retrieve. This is used for pagination; \n\t see the nextToken response field.
Maximum number of storage configurations to return. Default: your service quota or 100, \n\t whichever is smaller.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#ListStorageConfigurationsResponse": { + "type": "structure", + "members": { + "storageConfigurations": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationSummaryList", + "traits": { + "smithy.api#documentation": "List of the matching storage configurations.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ivsrealtime#PaginationToken", + "traits": { + "smithy.api#documentation": "If there are more storage configurations than maxResults, use nextToken\n in the request to get the next set.
Duration (in minutes), after which the participant token expires. Default: 720 (12\n hours).
" } }, @@ -2063,7 +3411,6 @@ "duration": { "target": "com.amazonaws.ivsrealtime#ParticipantTokenDurationMinutes", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "Duration (in minutes), after which the corresponding participant token expires. Default:\n 720 (12 hours).
" } }, @@ -2105,7 +3452,6 @@ "com.amazonaws.ivsrealtime#ParticipantTokenDurationMinutes": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 20160 @@ -2142,52 +3488,145 @@ } } }, - "com.amazonaws.ivsrealtime#PendingVerification": { + "com.amazonaws.ivsrealtime#PendingVerification": { + "type": "structure", + "members": { + "exceptionMessage": { + "target": "com.amazonaws.ivsrealtime#errorMessage", + "traits": { + "smithy.api#documentation": "Your account is pending verification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.ivsrealtime#Published": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.ivsrealtime#RecordingConfiguration": { + "type": "structure", + "members": { + "format": { + "target": "com.amazonaws.ivsrealtime#RecordingConfigurationFormat", + "traits": { + "smithy.api#documentation": "The recording format for storing a recording in Amazon S3.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing a configuration to record a stage stream.
" + } + }, + "com.amazonaws.ivsrealtime#RecordingConfigurationFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HLS", + "name": "HLS" + } + ] + } + }, + "com.amazonaws.ivsrealtime#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.ivsrealtime#ResourceNotFoundException": { + "type": "structure", + "members": { + "exceptionMessage": { + "target": "com.amazonaws.ivsrealtime#errorMessage", + "traits": { + "smithy.api#documentation": "Request references a resource which does not exist.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.ivsrealtime#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9-.]+$" + } + }, + "com.amazonaws.ivsrealtime#S3DestinationConfiguration": { + "type": "structure", + "members": { + "storageConfigurationArn": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationArn", + "traits": { + "smithy.api#documentation": "ARN of the StorageConfiguration where recorded videos will be stored.
", + "smithy.api#required": {} + } + }, + "encoderConfigurationArns": { + "target": "com.amazonaws.ivsrealtime#EncoderConfigurationArnList", + "traits": { + "smithy.api#documentation": "ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources \n\t must be in the same AWS account and region.
", + "smithy.api#required": {} + } + }, + "recordingConfiguration": { + "target": "com.amazonaws.ivsrealtime#RecordingConfiguration", + "traits": { + "smithy.api#documentation": "Array of maps, each of the form string:string (key:value). \n\t This is an optional customer specification, currently used only to specify \n\t the recording format for storing a recording in Amazon S3.
A complex type that describes an S3 location where recorded videos will be stored.
" + } + }, + "com.amazonaws.ivsrealtime#S3Detail": { "type": "structure", "members": { - "exceptionMessage": { - "target": "com.amazonaws.ivsrealtime#errorMessage", + "recordingPrefix": { + "target": "com.amazonaws.ivsrealtime#String", "traits": { - "smithy.api#documentation": "Your account is pending verification.
" + "smithy.api#documentation": "The S3 bucket prefix under which the recording is stored.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.ivsrealtime#Published": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.ivsrealtime#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" + "smithy.api#documentation": "Complex data type that defines S3Detail objects.
" } }, - "com.amazonaws.ivsrealtime#ResourceNotFoundException": { + "com.amazonaws.ivsrealtime#S3StorageConfiguration": { "type": "structure", "members": { - "exceptionMessage": { - "target": "com.amazonaws.ivsrealtime#errorMessage", + "bucketName": { + "target": "com.amazonaws.ivsrealtime#S3BucketName", "traits": { - "smithy.api#documentation": "Request references a resource which does not exist.
" + "smithy.api#documentation": "Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration \n\t and S3 bucket must be in the same region as the Composition.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#documentation": "A complex type that describes an S3 location where recorded videos will be stored.
" } }, "com.amazonaws.ivsrealtime#ServiceQuotaExceededException": { @@ -2366,6 +3805,250 @@ "target": "com.amazonaws.ivsrealtime#StageSummary" } }, + "com.amazonaws.ivsrealtime#StartComposition": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#StartCompositionRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#StartCompositionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, + { + "target": "com.amazonaws.ivsrealtime#PendingVerification" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a Composition from a stage based on the configuration provided in the\n request.
\nA Composition is an ephemeral resource that exists after this endpoint returns\n successfully. Composition stops and the resource is deleted:
\nWhen StopComposition is called.
\nAfter a 1-minute timeout, when all participants are disconnected from the\n stage.
\nAfter a 1-minute timeout, if there are no participants in the stage when\n StartComposition is called.
\nWhen broadcasting to the IVS channel fails and all retries are exhausted.
\nWhen broadcasting is disconnected and all attempts to reconnect are\n exhausted.
\nARN of the stage to be used for compositing.
", + "smithy.api#required": {} + } + }, + "idempotencyToken": { + "target": "com.amazonaws.ivsrealtime#CompositionClientToken", + "traits": { + "smithy.api#documentation": "Idempotency token.
", + "smithy.api#idempotencyToken": {} + } + }, + "layout": { + "target": "com.amazonaws.ivsrealtime#LayoutConfiguration", + "traits": { + "smithy.api#documentation": "Layout object to configure composition parameters.
" + } + }, + "destinations": { + "target": "com.amazonaws.ivsrealtime#DestinationConfigurationList", + "traits": { + "smithy.api#documentation": "Array of destination configuration.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.
The Composition that was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ivsrealtime#StopComposition": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#StopCompositionRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#StopCompositionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#InternalServerException" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops and deletes a Composition resource. Any broadcast from the Composition resource\n is stopped.
", + "smithy.api#http": { + "method": "POST", + "uri": "/StopComposition" + } + } + }, + "com.amazonaws.ivsrealtime#StopCompositionRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#CompositionArn", + "traits": { + "smithy.api#documentation": "ARN of the Composition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#StopCompositionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ivsrealtime#StorageConfiguration": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationArn", + "traits": { + "smithy.api#documentation": "ARN of the storage configuration.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationName", + "traits": { + "smithy.api#documentation": "Name of the storage configuration.
" + } + }, + "s3": { + "target": "com.amazonaws.ivsrealtime#S3StorageConfiguration", + "traits": { + "smithy.api#documentation": "An S3 destination configuration where recorded videos will be stored.
" + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.
A complex type that describes a location where recorded videos will be stored.
" + } + }, + "com.amazonaws.ivsrealtime#StorageConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.ivsrealtime#StorageConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.ivsrealtime#StorageConfigurationSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationArn", + "traits": { + "smithy.api#documentation": "ARN of the storage configuration.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationName", + "traits": { + "smithy.api#documentation": "Name of the storage configuration.
" + } + }, + "s3": { + "target": "com.amazonaws.ivsrealtime#S3StorageConfiguration", + "traits": { + "smithy.api#documentation": "An S3 destination configuration where recorded videos will be stored.
" + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.
Summary information about a storage configuration.
" + } + }, + "com.amazonaws.ivsrealtime#StorageConfigurationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivsrealtime#StorageConfigurationSummary" + } + }, "com.amazonaws.ivsrealtime#String": { "type": "string" }, @@ -2610,6 +4293,47 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.ivsrealtime#Video": { + "type": "structure", + "members": { + "width": { + "target": "com.amazonaws.ivsrealtime#Width", + "traits": { + "smithy.api#documentation": "Video-resolution width. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 1280.
Video-resolution height. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 720.
Video frame rate, in fps. Default: 30.
" + } + }, + "bitrate": { + "target": "com.amazonaws.ivsrealtime#Bitrate", + "traits": { + "smithy.api#documentation": "Bitrate for generated output, in bps. Default: 2500000.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for video.
" + } + }, + "com.amazonaws.ivsrealtime#Width": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1920 + } + } + }, "com.amazonaws.ivsrealtime#errorMessage": { "type": "string" } diff --git a/codegen/sdk/aws-models/kafka.json b/codegen/sdk/aws-models/kafka.json index 5b59e703da0..850282d7a3b 100644 --- a/codegen/sdk/aws-models/kafka.json +++ b/codegen/sdk/aws-models/kafka.json @@ -791,6 +791,13 @@ "smithy.api#documentation": "This controls storage mode for supported storage tiers.
", "smithy.api#jsonName": "storageMode" } + }, + "CustomerActionStatus": { + "target": "com.amazonaws.kafka#CustomerActionStatus", + "traits": { + "smithy.api#documentation": "Determines if there is an action required from the customer.
", + "smithy.api#jsonName": "customerActionStatus" + } } }, "traits": { @@ -2191,6 +2198,32 @@ "smithy.api#output": {} } }, + "com.amazonaws.kafka#CustomerActionStatus": { + "type": "enum", + "members": { + "CRITICAL_ACTION_REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL_ACTION_REQUIRED" + } + }, + "ACTION_RECOMMENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_RECOMMENDED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#documentation": "A type of an action required from the customer.
" + } + }, "com.amazonaws.kafka#DeleteCluster": { "type": "operation", "input": { @@ -6631,6 +6664,13 @@ "smithy.api#documentation": "This controls storage mode for supported storage tiers.
", "smithy.api#jsonName": "storageMode" } + }, + "CustomerActionStatus": { + "target": "com.amazonaws.kafka#CustomerActionStatus", + "traits": { + "smithy.api#documentation": "Determines if there is an action required from the customer.
", + "smithy.api#jsonName": "customerActionStatus" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/lambda.json b/codegen/sdk/aws-models/lambda.json index 2617244e400..981d7acab4a 100644 --- a/codegen/sdk/aws-models/lambda.json +++ b/codegen/sdk/aws-models/lambda.json @@ -1998,6 +1998,47 @@ "smithy.api#documentation": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
" } }, + "com.amazonaws.lambda#ApplicationLogLevel": { + "type": "enum", + "members": { + "Trace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRACE" + } + }, + "Debug": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } + }, + "Info": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "Warn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN" + } + }, + "Error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "Fatal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FATAL" + } + } + } + }, "com.amazonaws.lambda#Architecture": { "type": "enum", "members": { @@ -2811,7 +2852,7 @@ "EphemeralStorage": { "target": "com.amazonaws.lambda#EphemeralStorage", "traits": { - "smithy.api#documentation": "The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n 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\n number between 512 and 10,240 MB.
The function's SnapStart setting.
" } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#LoggingConfig", + "traits": { + "smithy.api#documentation": "The function's Amazon CloudWatch Logs configuration settings.
" + } } }, "traits": { @@ -3855,7 +3902,7 @@ } }, "traits": { - "smithy.api#documentation": "The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n 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\n 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\n 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\n whole number between 512 and 10,240 MB.
The ARN of the runtime and any errors that occured.
" } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#LoggingConfig", + "traits": { + "smithy.api#documentation": "The function's Amazon CloudWatch Logs configuration settings.
" + } } }, "traits": { @@ -6490,7 +6543,7 @@ ], "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "For asynchronous function invocation, use Invoke.
\nInvokes a function asynchronously.
\nIf you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not \n propagated to the function, even if X-Ray active tracing is turned on.
\nFor asynchronous function invocation, use Invoke.
\nInvokes a function asynchronously.
", "smithy.api#http": { "method": "POST", "uri": "/2014-11-13/functions/{FunctionName}/invoke-async", @@ -8356,6 +8409,33 @@ "smithy.api#pattern": "^/mnt/[a-zA-Z0-9-_.]+$" } }, + "com.amazonaws.lambda#LogFormat": { + "type": "enum", + "members": { + "Json": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "Text": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Text" + } + } + } + }, + "com.amazonaws.lambda#LogGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, "com.amazonaws.lambda#LogType": { "type": "enum", "members": { @@ -8373,6 +8453,38 @@ } } }, + "com.amazonaws.lambda#LoggingConfig": { + "type": "structure", + "members": { + "LogFormat": { + "target": "com.amazonaws.lambda#LogFormat", + "traits": { + "smithy.api#documentation": "The format in which Lambda sends your function's application and system logs to CloudWatch. Select between \n plain text and structured JSON.
" + } + }, + "ApplicationLogLevel": { + "target": "com.amazonaws.lambda#ApplicationLogLevel", + "traits": { + "smithy.api#documentation": "Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the \n selected level and lower.
" + } + }, + "SystemLogLevel": { + "target": "com.amazonaws.lambda#SystemLogLevel", + "traits": { + "smithy.api#documentation": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the \n selected level and lower.
" + } + }, + "LogGroup": { + "target": "com.amazonaws.lambda#LogGroup", + "traits": { + "smithy.api#documentation": "The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default \n log group named /aws/lambda/. 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.
" + } + }, "com.amazonaws.lambda#Long": { "type": "long", "traits": { @@ -9970,6 +10082,12 @@ "traits": { "smithy.api#enumValue": "python3.12" } + }, + "java21": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "java21" + } } } }, @@ -10590,6 +10708,29 @@ } } }, + "com.amazonaws.lambda#SystemLogLevel": { + "type": "enum", + "members": { + "Debug": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } + }, + "Info": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "Warn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN" + } + } + } + }, "com.amazonaws.lambda#TagKey": { "type": "string" }, @@ -11490,7 +11631,7 @@ "EphemeralStorage": { "target": "com.amazonaws.lambda#EphemeralStorage", "traits": { - "smithy.api#documentation": "The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n 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\n number between 512 and 10,240 MB.
The function's SnapStart setting.
" } + }, + "LoggingConfig": { + "target": "com.amazonaws.lambda#LoggingConfig", + "traits": { + "smithy.api#documentation": "The function's Amazon CloudWatch Logs configuration settings.
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/macie.json b/codegen/sdk/aws-models/macie.json deleted file mode 100644 index a5704d4672b..00000000000 --- a/codegen/sdk/aws-models/macie.json +++ /dev/null @@ -1,1481 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.macie#AWSAccountId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.macie#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.macie#ExceptionMessage" - }, - "resourceType": { - "target": "com.amazonaws.macie#ResourceType" - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) You do not have required permissions to access the requested resource.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.macie#AssociateMemberAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.macie#AssociateMemberAccountRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.macie#InternalException" - }, - { - "target": "com.amazonaws.macie#InvalidInputException" - }, - { - "target": "com.amazonaws.macie#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "(Discontinued) Associates a specified Amazon Web Services account with Amazon Macie Classic as a member\n account.
" - } - }, - "com.amazonaws.macie#AssociateMemberAccountRequest": { - "type": "structure", - "members": { - "memberAccountId": { - "target": "com.amazonaws.macie#AWSAccountId", - "traits": { - "smithy.api#documentation": "(Discontinued) The ID of the Amazon Web Services account that you want to associate with Amazon Macie\n Classic as a member account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.macie#AssociateS3Resources": { - "type": "operation", - "input": { - "target": "com.amazonaws.macie#AssociateS3ResourcesRequest" - }, - "output": { - "target": "com.amazonaws.macie#AssociateS3ResourcesResult" - }, - "errors": [ - { - "target": "com.amazonaws.macie#AccessDeniedException" - }, - { - "target": "com.amazonaws.macie#InternalException" - }, - { - "target": "com.amazonaws.macie#InvalidInputException" - }, - { - "target": "com.amazonaws.macie#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "(Discontinued) Associates specified S3 resources with Amazon Macie Classic for\n monitoring and data classification. If memberAccountId isn't specified, the action associates\n specified S3 resources with Macie Classic for the current Macie Classic administrator account.\n If memberAccountId is specified, the action associates specified S3 resources with Macie\n Classic for the specified member account.
(Discontinued) The ID of the Amazon Macie Classic member account whose resources you\n want to associate with Macie Classic.
" - } - }, - "s3Resources": { - "target": "com.amazonaws.macie#S3ResourcesClassification", - "traits": { - "smithy.api#documentation": "(Discontinued) The S3 resources that you want to associate with Amazon Macie Classic\n for monitoring and data classification.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.macie#AssociateS3ResourcesResult": { - "type": "structure", - "members": { - "failedS3Resources": { - "target": "com.amazonaws.macie#FailedS3Resources", - "traits": { - "smithy.api#documentation": "(Discontinued) S3 resources that couldn't be associated with Amazon Macie Classic. An\n error code and an error message are provided for each failed item.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.macie#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.macie#ClassificationType": { - "type": "structure", - "members": { - "oneTime": { - "target": "com.amazonaws.macie#S3OneTimeClassificationType", - "traits": { - "smithy.api#documentation": "(Discontinued) A one-time classification of all of the existing objects in a specified\n S3 bucket.
", - "smithy.api#required": {} - } - }, - "continuous": { - "target": "com.amazonaws.macie#S3ContinuousClassificationType", - "traits": { - "smithy.api#documentation": "(Discontinued) A continuous classification of the objects that are added to a specified\n S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is\n successfully associated with Macie Classic.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) The classification type that Amazon Macie Classic applies to the\n associated S3 resources.
" - } - }, - "com.amazonaws.macie#ClassificationTypeUpdate": { - "type": "structure", - "members": { - "oneTime": { - "target": "com.amazonaws.macie#S3OneTimeClassificationType", - "traits": { - "smithy.api#documentation": "(Discontinued) A one-time classification of all of the existing objects in a specified\n S3 bucket.
" - } - }, - "continuous": { - "target": "com.amazonaws.macie#S3ContinuousClassificationType", - "traits": { - "smithy.api#documentation": "(Discontinued) A continuous classification of the objects that are added to a specified\n S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is\n successfully associated with Macie Classic.
" - } - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) The classification type that Amazon Macie Classic applies to the\n associated S3 resources. At least one of the classification types (oneTime or continuous) must\n be specified.
(Discontinued) Removes the specified member account from Amazon Macie\n Classic.
" - } - }, - "com.amazonaws.macie#DisassociateMemberAccountRequest": { - "type": "structure", - "members": { - "memberAccountId": { - "target": "com.amazonaws.macie#AWSAccountId", - "traits": { - "smithy.api#documentation": "(Discontinued) The ID of the member account that you want to remove from Amazon Macie\n Classic.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.macie#DisassociateS3Resources": { - "type": "operation", - "input": { - "target": "com.amazonaws.macie#DisassociateS3ResourcesRequest" - }, - "output": { - "target": "com.amazonaws.macie#DisassociateS3ResourcesResult" - }, - "errors": [ - { - "target": "com.amazonaws.macie#AccessDeniedException" - }, - { - "target": "com.amazonaws.macie#InternalException" - }, - { - "target": "com.amazonaws.macie#InvalidInputException" - } - ], - "traits": { - "smithy.api#documentation": "(Discontinued) Removes specified S3 resources from being monitored by Amazon Macie\n Classic. If memberAccountId isn't specified, the action removes specified S3 resources from\n Macie Classic for the current Macie Classic administrator account. If memberAccountId is\n specified, the action removes specified S3 resources from Macie Classic for the specified\n member account.
(Discontinued) The ID of the Amazon Macie Classic member account whose resources you\n want to remove from being monitored by Macie Classic.
" - } - }, - "associatedS3Resources": { - "target": "com.amazonaws.macie#S3Resources", - "traits": { - "smithy.api#documentation": "(Discontinued) The S3 resources (buckets or prefixes) that you want to remove from\n being monitored and classified by Amazon Macie Classic.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.macie#DisassociateS3ResourcesResult": { - "type": "structure", - "members": { - "failedS3Resources": { - "target": "com.amazonaws.macie#FailedS3Resources", - "traits": { - "smithy.api#documentation": "(Discontinued) S3 resources that couldn't be removed from being monitored and\n classified by Amazon Macie Classic. An error code and an error message are provided for each\n failed item.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.macie#ErrorCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "Error code for the exception", - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.macie#ExceptionMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - } - } - }, - "com.amazonaws.macie#FailedS3Resource": { - "type": "structure", - "members": { - "failedItem": { - "target": "com.amazonaws.macie#S3Resource", - "traits": { - "smithy.api#documentation": "(Discontinued) The failed S3 resources.
" - } - }, - "errorCode": { - "target": "com.amazonaws.macie#ErrorCode", - "traits": { - "smithy.api#documentation": "(Discontinued) The status code of a failed item.
" - } - }, - "errorMessage": { - "target": "com.amazonaws.macie#ExceptionMessage", - "traits": { - "smithy.api#documentation": "(Discontinued) The error message of a failed item.
" - } - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) Includes details about the failed S3 resources.
" - } - }, - "com.amazonaws.macie#FailedS3Resources": { - "type": "list", - "member": { - "target": "com.amazonaws.macie#FailedS3Resource" - } - }, - "com.amazonaws.macie#FieldName": { - "type": "string", - "traits": { - "smithy.api#documentation": "Field that has invalid input", - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.macie#InternalException": { - "type": "structure", - "members": { - "errorCode": { - "target": "com.amazonaws.macie#ErrorCode" - }, - "message": { - "target": "com.amazonaws.macie#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) Internal server error.
", - "smithy.api#error": "server" - } - }, - "com.amazonaws.macie#InvalidInputException": { - "type": "structure", - "members": { - "errorCode": { - "target": "com.amazonaws.macie#ErrorCode" - }, - "message": { - "target": "com.amazonaws.macie#ExceptionMessage" - }, - "fieldName": { - "target": "com.amazonaws.macie#FieldName" - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) The request was rejected because an invalid or out-of-range value was supplied for an\n input parameter.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.macie#LimitExceededException": { - "type": "structure", - "members": { - "errorCode": { - "target": "com.amazonaws.macie#ErrorCode" - }, - "message": { - "target": "com.amazonaws.macie#ExceptionMessage" - }, - "resourceType": { - "target": "com.amazonaws.macie#ResourceType" - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) The request was rejected because it attempted to create resources beyond the current\n Amazon Web Services account quotas. The error code describes the quota exceeded.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.macie#ListMemberAccounts": { - "type": "operation", - "input": { - "target": "com.amazonaws.macie#ListMemberAccountsRequest" - }, - "output": { - "target": "com.amazonaws.macie#ListMemberAccountsResult" - }, - "errors": [ - { - "target": "com.amazonaws.macie#InternalException" - }, - { - "target": "com.amazonaws.macie#InvalidInputException" - } - ], - "traits": { - "smithy.api#documentation": "(Discontinued) Lists all Amazon Macie Classic member accounts for the current Macie\n Classic administrator account.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.macie#ListMemberAccountsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.macie#NextToken", - "traits": { - "smithy.api#documentation": "(Discontinued) Use this parameter when paginating results. Set the value of this\n parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the\n action fill nextToken in the request with the value of nextToken from the previous response to\n continue listing data.
(Discontinued) Use this parameter to indicate the maximum number of items that you want\n in the response. The default value is 250.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.macie#ListMemberAccountsResult": { - "type": "structure", - "members": { - "memberAccounts": { - "target": "com.amazonaws.macie#MemberAccounts", - "traits": { - "smithy.api#documentation": "(Discontinued) A list of the Amazon Macie Classic member accounts returned by the\n action. The current Macie Classic administrator account is also included in this\n list.
" - } - }, - "nextToken": { - "target": "com.amazonaws.macie#NextToken", - "traits": { - "smithy.api#documentation": "(Discontinued) When a response is generated, if there is more data to be listed, this\n parameter is present in the response and contains the value to use for the nextToken parameter\n in a subsequent pagination request. If there is no more data to be listed, this parameter is\n set to null.
(Discontinued) Lists all the S3 resources associated with Amazon Macie Classic. If\n memberAccountId isn't specified, the action lists the S3 resources associated with Macie\n Classic for the current Macie Classic administrator account. If memberAccountId is specified,\n the action lists the S3 resources associated with Macie Classic for the specified member\n account.
(Discontinued) The Amazon Macie Classic member account ID whose associated S3 resources\n you want to list.
" - } - }, - "nextToken": { - "target": "com.amazonaws.macie#NextToken", - "traits": { - "smithy.api#documentation": "(Discontinued) Use this parameter when paginating results. Set its value to null on\n your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken\n in the request with the value of nextToken from the previous response to continue listing\n data.
(Discontinued) Use this parameter to indicate the maximum number of items that you want\n in the response. The default value is 250.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.macie#ListS3ResourcesResult": { - "type": "structure", - "members": { - "s3Resources": { - "target": "com.amazonaws.macie#S3ResourcesClassification", - "traits": { - "smithy.api#documentation": "(Discontinued) A list of the associated S3 resources returned by the action.
" - } - }, - "nextToken": { - "target": "com.amazonaws.macie#NextToken", - "traits": { - "smithy.api#documentation": "(Discontinued) When a response is generated, if there is more data to be listed, this\n parameter is present in the response and contains the value to use for the nextToken parameter\n in a subsequent pagination request. If there is no more data to be listed, this parameter is\n set to null.
Amazon Macie Classic has been discontinued and is no longer available.
\nA new Amazon Macie is now available with significant design improvements and additional\n features, at a lower price and in most Amazon Web Services Regions. We encourage you to take advantage of the\n new and improved features, and benefit from the reduced cost. To learn about features and pricing for the new Macie, see Amazon Macie. To learn how to use the new Macie, see the Amazon Macie User\n Guide.
", - "smithy.api#title": "Amazon Macie", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://macie-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://macie-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://macie.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://macie.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://macie-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://macie.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://macie-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://macie.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://macie-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://macie.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://macie.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.macie#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "max": 250 - } - } - }, - "com.amazonaws.macie#MemberAccount": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.macie#AWSAccountId", - "traits": { - "smithy.api#documentation": "(Discontinued) The Amazon Web Services account ID of the Amazon Macie Classic member account.
" - } - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) Contains information about the Amazon Macie Classic member\n account.
" - } - }, - "com.amazonaws.macie#MemberAccounts": { - "type": "list", - "member": { - "target": "com.amazonaws.macie#MemberAccount" - } - }, - "com.amazonaws.macie#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.macie#Prefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - } - } - }, - "com.amazonaws.macie#ResourceType": { - "type": "string", - "traits": { - "smithy.api#documentation": "Resource type that caused the exception", - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.macie#S3ContinuousClassificationType": { - "type": "enum", - "members": { - "FULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FULL" - } - } - } - }, - "com.amazonaws.macie#S3OneTimeClassificationType": { - "type": "enum", - "members": { - "FULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FULL" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.macie#S3Resource": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.macie#BucketName", - "traits": { - "smithy.api#documentation": "(Discontinued) The name of the S3 bucket.
", - "smithy.api#required": {} - } - }, - "prefix": { - "target": "com.amazonaws.macie#Prefix", - "traits": { - "smithy.api#documentation": "(Discontinued) The prefix of the S3 bucket.
" - } - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) Contains information about the S3 resource. This data type is used as a\n request parameter in the DisassociateS3Resources action and can be used as a response\n parameter in the AssociateS3Resources and UpdateS3Resources actions.
(Discontinued) The name of the S3 bucket that you want to associate with Amazon Macie\n Classic.
", - "smithy.api#required": {} - } - }, - "prefix": { - "target": "com.amazonaws.macie#Prefix", - "traits": { - "smithy.api#documentation": "(Discontinued) The prefix of the S3 bucket that you want to associate with Amazon Macie\n Classic.
" - } - }, - "classificationType": { - "target": "com.amazonaws.macie#ClassificationType", - "traits": { - "smithy.api#documentation": "(Discontinued) The classification type that you want to specify for the resource\n associated with Amazon Macie Classic.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) The S3 resources that you want to associate with Amazon Macie Classic\n for monitoring and data classification. This data type is used as a request parameter in the\n AssociateS3Resources action and a response parameter in the ListS3Resources action.
(Discontinued) The name of the S3 bucket whose classification types you want to\n update.
", - "smithy.api#required": {} - } - }, - "prefix": { - "target": "com.amazonaws.macie#Prefix", - "traits": { - "smithy.api#documentation": "(Discontinued) The prefix of the S3 bucket whose classification types you want to\n update.
" - } - }, - "classificationTypeUpdate": { - "target": "com.amazonaws.macie#ClassificationTypeUpdate", - "traits": { - "smithy.api#documentation": "(Discontinued) The classification type that you want to update for the resource\n associated with Amazon Macie Classic.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "(Discontinued) The S3 resources whose classification types you want to update. This\n data type is used as a request parameter in the UpdateS3Resources action.
(Discontinued) Updates the classification types for the specified S3 resources. If\n memberAccountId isn't specified, the action updates the classification types of the S3\n resources associated with Amazon Macie Classic for the current Macie Classic administrator\n account. If memberAccountId is specified, the action updates the classification types of the\n S3 resources associated with Macie Classic for the specified member account.
(Discontinued) The Amazon Web Services account ID of the Amazon Macie Classic member account whose S3\n resources' classification types you want to update.
" - } - }, - "s3ResourcesUpdate": { - "target": "com.amazonaws.macie#S3ResourcesClassificationUpdate", - "traits": { - "smithy.api#documentation": "(Discontinued) The S3 resources whose classification types you want to\n update.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.macie#UpdateS3ResourcesResult": { - "type": "structure", - "members": { - "failedS3Resources": { - "target": "com.amazonaws.macie#FailedS3Resources", - "traits": { - "smithy.api#documentation": "(Discontinued) The S3 resources whose classification types can't be updated. An error\n code and an error message are provided for each failed item.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - } - } -} diff --git a/codegen/sdk/aws-models/macie2.json b/codegen/sdk/aws-models/macie2.json index 0d36b3a94e6..608cfe6e5fc 100644 --- a/codegen/sdk/aws-models/macie2.json +++ b/codegen/sdk/aws-models/macie2.json @@ -1774,7 +1774,7 @@ "managedDataIdentifierSelector": { "target": "com.amazonaws.macie2#ManagedDataIdentifierSelector", "traits": { - "smithy.api#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.
", + "smithy.api#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.
", "smithy.api#jsonName": "managedDataIdentifierSelector" } }, @@ -3485,7 +3485,7 @@ "target": "com.amazonaws.macie2#__stringMin1Max128", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An occurrence of the specified type of sensitive data. Each occurrence can contain 1-128 characters.
", + "smithy.api#documentation": "An occurrence of the specified type of sensitive data. Each occurrence contains 1-128 characters.
", "smithy.api#jsonName": "value", "smithy.api#required": {} } @@ -5773,7 +5773,7 @@ "updatedAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#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.
", + "smithy.api#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.
", "smithy.api#jsonName": "updatedAt" } } @@ -6105,9 +6105,16 @@ "configuration": { "target": "com.amazonaws.macie2#RevealConfiguration", "traits": { - "smithy.api#documentation": "The current configuration settings and the status of the configuration for the account.
", + "smithy.api#documentation": "The KMS key that's used to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.
", "smithy.api#jsonName": "configuration" } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.macie2#RetrievalConfiguration", + "traits": { + "smithy.api#documentation": "The access method and settings that are used to retrieve the sensitive data.
", + "smithy.api#jsonName": "retrievalConfiguration" + } } }, "traits": { @@ -6238,7 +6245,7 @@ "reasons": { "target": "com.amazonaws.macie2#__listOfUnavailabilityReasonCode", "traits": { - "smithy.api#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.
", + "smithy.api#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.
", "smithy.api#jsonName": "reasons" } } @@ -6362,7 +6369,7 @@ "includes": { "target": "com.amazonaws.macie2#SensitivityInspectionTemplateIncludes", "traits": { - "smithy.api#documentation": "The allow lists, custom data identifiers, and managed data identifiers that are included (used) when analyzing data.
", + "smithy.api#documentation": "The allow lists, custom data identifiers, and managed data identifiers that are explicitly included (used) when analyzing data.
", "smithy.api#jsonName": "includes" } }, @@ -10491,7 +10498,7 @@ "jsonPath": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#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.
", + "smithy.api#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.
", "smithy.api#jsonName": "jsonPath" } }, @@ -10704,7 +10711,7 @@ "totalItemsSkipped": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#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.
", + "smithy.api#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.
", "smithy.api#jsonName": "totalItemsSkipped" } }, @@ -10756,13 +10763,64 @@ "smithy.api#documentation": "Provides information about the resources that a finding applies to.
" } }, + "com.amazonaws.macie2#RetrievalConfiguration": { + "type": "structure", + "members": { + "externalId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#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.
", + "smithy.api#jsonName": "externalId" + } + }, + "retrievalMode": { + "target": "com.amazonaws.macie2#RetrievalMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#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.
", + "smithy.api#jsonName": "retrievalMode", + "smithy.api#required": {} + } + }, + "roleName": { + "target": "com.amazonaws.macie2#__stringMin1Max64PatternW", + "traits": { + "smithy.api#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.
", + "smithy.api#jsonName": "roleName" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the access method and settings that are used to retrieve occurrences of sensitive data reported by findings.
" + } + }, + "com.amazonaws.macie2#RetrievalMode": { + "type": "enum", + "members": { + "CALLER_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALLER_CREDENTIALS" + } + }, + "ASSUME_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSUME_ROLE" + } + } + }, + "traits": { + "smithy.api#documentation": "The access method to use when retrieving occurrences of sensitive data reported by findings. Valid values are:
" + } + }, "com.amazonaws.macie2#RevealConfiguration": { "type": "structure", "members": { "kmsKeyId": { "target": "com.amazonaws.macie2#__stringMin1Max2048", "traits": { - "smithy.api#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.
", + "smithy.api#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.
", "smithy.api#jsonName": "kmsKeyId" } }, @@ -10777,7 +10835,7 @@ } }, "traits": { - "smithy.api#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.
" + "smithy.api#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.
" } }, "com.amazonaws.macie2#RevealRequestStatus": { @@ -11067,7 +11125,7 @@ "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#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.
", + "smithy.api#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.
", "smithy.api#jsonName": "kmsKeyArn", "smithy.api#required": {} } @@ -12170,7 +12228,7 @@ "comparator": { "target": "com.amazonaws.macie2#JobComparator", "traits": { - "smithy.api#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.
", + "smithy.api#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.
", "smithy.api#jsonName": "values" } } @@ -12699,6 +12757,42 @@ "traits": { "smithy.api#enumValue": "OBJECT_UNAVAILABLE" } + }, + "ACCOUNT_NOT_IN_ORGANIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_NOT_IN_ORGANIZATION" + } + }, + "MISSING_GET_MEMBER_PERMISSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_GET_MEMBER_PERMISSION" + } + }, + "ROLE_TOO_PERMISSIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLE_TOO_PERMISSIVE" + } + }, + "MEMBER_ROLE_TOO_PERMISSIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEMBER_ROLE_TOO_PERMISSIVE" + } + }, + "INVALID_RESULT_SIGNATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_RESULT_SIGNATURE" + } + }, + "RESULT_NOT_SIGNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESULT_NOT_SIGNED" + } } }, "traits": { @@ -12723,7 +12817,7 @@ "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of error that occurred and prevented Amazon Macie from retrieving occurrences of sensitive data reported by 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.
The type of error that occurred and prevented Amazon Macie from retrieving occurrences of sensitive data reported by 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.
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.
", + "smithy.api#jsonName": "roleName" + } + } + }, + "traits": { + "smithy.api#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.
" + } + }, "com.amazonaws.macie2#UpdateRevealConfiguration": { "type": "operation", "input": { @@ -13601,10 +13719,17 @@ "target": "com.amazonaws.macie2#RevealConfiguration", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The new configuration settings and the status of the configuration for the account.
", + "smithy.api#documentation": "The KMS key to use to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.
", "smithy.api#jsonName": "configuration", "smithy.api#required": {} } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.macie2#UpdateRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "The access method and settings to use to retrieve the sensitive data.
", + "smithy.api#jsonName": "retrievalConfiguration" + } } }, "traits": { @@ -13617,9 +13742,16 @@ "configuration": { "target": "com.amazonaws.macie2#RevealConfiguration", "traits": { - "smithy.api#documentation": "The new configuration settings and the status of the configuration for the account.
", + "smithy.api#documentation": "The KMS key to use to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.
", "smithy.api#jsonName": "configuration" } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.macie2#RetrievalConfiguration", + "traits": { + "smithy.api#documentation": "The access method and settings to use to retrieve the sensitive data.
", + "smithy.api#jsonName": "retrievalConfiguration" + } } }, "traits": { @@ -13688,7 +13820,7 @@ "includes": { "target": "com.amazonaws.macie2#SensitivityInspectionTemplateIncludes", "traits": { - "smithy.api#documentation": "The allow lists, custom data identifiers, and managed data identifiers to include (use) when analyzing data.
", + "smithy.api#documentation": "The allow lists, custom data identifiers, and managed data identifiers to explicitly include (use) when analyzing data.
", "smithy.api#jsonName": "includes" } } @@ -14483,6 +14615,16 @@ "smithy.api#pattern": "^[\\s\\S]+$" } }, + "com.amazonaws.macie2#__stringMin1Max64PatternW": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w+=,.@-]*$" + } + }, "com.amazonaws.macie2#__stringMin22Max22PatternAZ0922": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/mediapackage.json b/codegen/sdk/aws-models/mediapackage.json index 3d03bdbe7d6..f960d3bee5e 100644 --- a/codegen/sdk/aws-models/mediapackage.json +++ b/codegen/sdk/aws-models/mediapackage.json @@ -1054,7 +1054,7 @@ "ManifestLayout": { "target": "com.amazonaws.mediapackage#ManifestLayout", "traits": { - "smithy.api#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.", + "smithy.api#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.", "smithy.api#jsonName": "manifestLayout" } }, @@ -2517,6 +2517,12 @@ "traits": { "smithy.api#enumValue": "COMPACT" } + }, + "DRM_TOP_LEVEL_COMPACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRM_TOP_LEVEL_COMPACT" + } } } }, diff --git a/codegen/sdk/aws-models/mwaa.json b/codegen/sdk/aws-models/mwaa.json index 887a86a5d5c..e0fddfdfa75 100644 --- a/codegen/sdk/aws-models/mwaa.json +++ b/codegen/sdk/aws-models/mwaa.json @@ -897,6 +897,16 @@ } } }, + "com.amazonaws.mwaa#CeleryExecutorQueue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1224 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)?:sqs:[a-z0-9\\-]+:\\d{12}:[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, "com.amazonaws.mwaa#CloudWatchLogGroupArn": { "type": "string", "traits": { @@ -1114,7 +1124,7 @@ "AirflowVersion": { "target": "com.amazonaws.mwaa#AirflowVersion", "traits": { - "smithy.api#documentation": "The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version.\n For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
\nValid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2.
The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version.\n For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
\nValid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2\n
The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.
" + "smithy.api#documentation": "Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
" } }, "MinWorkers": { @@ -1152,6 +1162,12 @@ "traits": { "smithy.api#documentation": "The number of Apache Airflow schedulers to run in your environment. Valid values:
\nv2 - Accepts between 2 to 5. Defaults to 2.
\nv1 - Accepts 1.
\nDefines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in\n your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value to CUSTOMER.\n In a shared VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If you do not take action to\n create the endpoints within 72 hours, the status will change to CREATE_FAILED. You can delete the failed environment and create a new one.
The status of the Amazon MWAA environment. Valid values:
\n\n CREATING - Indicates the request to create the environment is in progress.
\n CREATING_SNAPSHOT - Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS\n database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade\n an environment fails.
\n CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.
\n AVAILABLE - Indicates the request was successful and the environment is ready to use.
\n UPDATING - Indicates the request to update the environment is in progress.
\n ROLLING_BACK - Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.
\n DELETING - Indicates the request to delete the environment is in progress.
\n DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.
\n UNAVAILABLE - Indicates the request failed, but the environment was unable to rollback and is not in a stable state.
\n UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
" + "smithy.api#documentation": "The status of the Amazon MWAA environment.
\nValid values:
\n\n CREATING - Indicates the request to create the environment is in progress.
\n CREATING_SNAPSHOT - Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS\n database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade\n an environment fails.
\n CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.
\n AVAILABLE - Indicates the request was successful and the environment is ready to use.
\n PENDING - Indicates the request was successful, but the process to create the environment is paused until you create the required\n VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.
\n UPDATING - Indicates the request to update the environment is in progress.
\n ROLLING_BACK - Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.
\n DELETING - Indicates the request to delete the environment is in progress.
\n DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.
\n UNAVAILABLE - Indicates the request failed, but the environment was unable to rollback and is not in a stable state.
\n UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
" } }, "Arn": { @@ -1478,7 +1509,7 @@ "WebserverAccessMode": { "target": "com.amazonaws.mwaa#WebserverAccessMode", "traits": { - "smithy.api#documentation": "The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.
" + "smithy.api#documentation": "The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
" } }, "MinWorkers": { @@ -1492,6 +1523,30 @@ "traits": { "smithy.api#documentation": "The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
" } + }, + "WebserverVpcEndpointService": { + "target": "com.amazonaws.mwaa#VpcEndpointServiceName", + "traits": { + "smithy.api#documentation": "The VPC endpoint for the environment's web server.
" + } + }, + "DatabaseVpcEndpointService": { + "target": "com.amazonaws.mwaa#VpcEndpointServiceName", + "traits": { + "smithy.api#documentation": "The VPC endpoint for the environment's Amazon RDS database.
" + } + }, + "CeleryExecutorQueue": { + "target": "com.amazonaws.mwaa#CeleryExecutorQueue", + "traits": { + "smithy.api#documentation": "The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor\n to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
" + } + }, + "EndpointManagement": { + "target": "com.amazonaws.mwaa#EndpointManagement", + "traits": { + "smithy.api#documentation": "Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in\n your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
Associates the specified origination identity with a pool.
\nIf the origination identity is a phone number and is already associated with another\n pool, an Error is returned. A sender ID can be associated with multiple pools.
\nIf the origination identity configuration doesn't match the pool's configuration, an\n Error is returned.
" + "smithy.api#documentation": "Associates the specified origination identity with a pool.
\nIf the origination identity is a phone number and is already associated with another\n pool, an error is returned. A sender ID can be associated with multiple pools.
\nIf the origination identity configuration doesn't match the pool's configuration, an\n error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentityRequest": { @@ -209,6 +225,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentityResult": { @@ -244,6 +263,62 @@ "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#AttachmentBody": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1572864 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPLOAD_IN_PROGRESS", + "name": "UPLOAD_IN_PROGRESS" + }, + { + "value": "UPLOAD_COMPLETE", + "name": "UPLOAD_COMPLETE" + }, + { + "value": "UPLOAD_FAILED", + "name": "UPLOAD_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#AttachmentUploadErrorReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#AttachmentUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.pinpointsmsvoicev2#ClientToken": { @@ -453,6 +528,10 @@ "type": "string", "traits": { "smithy.api#enum": [ + { + "value": "CREATE_REGISTRATION_VERSION_NOT_ALLOWED", + "name": "CREATE_REGISTRATION_VERSION_NOT_ALLOWED" + }, { "value": "DELETION_PROTECTION_ENABLED", "name": "DELETION_PROTECTION_ENABLED" @@ -465,6 +544,18 @@ "value": "DESTINATION_PHONE_NUMBER_OPTED_OUT", "name": "DESTINATION_PHONE_NUMBER_OPTED_OUT" }, + { + "value": "DISASSOCIATE_REGISTRATION_NOT_ALLOWED", + "name": "DISASSOCIATE_REGISTRATION_NOT_ALLOWED" + }, + { + "value": "DISCARD_REGISTRATION_VERSION_NOT_ALLOWED", + "name": "DISCARD_REGISTRATION_VERSION_NOT_ALLOWED" + }, + { + "value": "EDIT_REGISTRATION_FIELD_VALUES_NOT_ALLOWED", + "name": "EDIT_REGISTRATION_FIELD_VALUES_NOT_ALLOWED" + }, { "value": "EVENT_DESTINATION_MISMATCH", "name": "EVENT_DESTINATION_MISMATCH" @@ -478,8 +569,8 @@ "name": "LAST_PHONE_NUMBER" }, { - "value": "SELF_MANAGED_OPT_OUTS_MISMATCH", - "name": "SELF_MANAGED_OPT_OUTS_MISMATCH" + "value": "NUMBER_CAPABILITIES_MISMATCH", + "name": "NUMBER_CAPABILITIES_MISMATCH" }, { "value": "MESSAGE_TYPE_MISMATCH", @@ -497,6 +588,10 @@ "value": "PHONE_NUMBER_ASSOCIATED_TO_POOL", "name": "PHONE_NUMBER_ASSOCIATED_TO_POOL" }, + { + "value": "PHONE_NUMBER_ASSOCIATED_TO_REGISTRATION", + "name": "PHONE_NUMBER_ASSOCIATED_TO_REGISTRATION" + }, { "value": "PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL", "name": "PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL" @@ -505,6 +600,18 @@ "value": "PHONE_NUMBER_NOT_IN_REGISTRATION_REGION", "name": "PHONE_NUMBER_NOT_IN_REGISTRATION_REGION" }, + { + "value": "REGISTRATION_ALREADY_SUBMITTED", + "name": "REGISTRATION_ALREADY_SUBMITTED" + }, + { + "value": "REGISTRATION_NOT_COMPLETE", + "name": "REGISTRATION_NOT_COMPLETE" + }, + { + "value": "SENDER_ID_ASSOCIATED_TO_POOL", + "name": "SENDER_ID_ASSOCIATED_TO_POOL" + }, { "value": "RESOURCE_ALREADY_EXISTS", "name": "RESOURCE_ALREADY_EXISTS" @@ -525,9 +632,25 @@ "value": "RESOURCE_NOT_EMPTY", "name": "RESOURCE_NOT_EMPTY" }, + { + "value": "SELF_MANAGED_OPT_OUTS_MISMATCH", + "name": "SELF_MANAGED_OPT_OUTS_MISMATCH" + }, + { + "value": "SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED", + "name": "SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED" + }, { "value": "TWO_WAY_CONFIG_MISMATCH", "name": "TWO_WAY_CONFIG_MISMATCH" + }, + { + "value": "VERIFICATION_CODE_EXPIRED", + "name": "VERIFICATION_CODE_EXPIRED" + }, + { + "value": "VERIFICATION_ALREADY_COMPLETE", + "name": "VERIFICATION_ALREADY_COMPLETE" } ] } @@ -563,7 +686,7 @@ "min": 1, "max": 800 }, - "smithy.api#pattern": "^\\S+$" + "smithy.api#pattern": "^(?!\\s)^[\\s\\S]+(?Creates a new configuration set. After you create the configuration set, you can add\n one or more event destinations to it.\nA configuration set is a set of rules that you apply to the SMS and voice messages\n that you send.
\nWhen you send a message, you can optionally specify a single configuration set.
" + "smithy.api#documentation": "Creates a new configuration set. After you create the configuration set, you can add\n one or more event destinations to it.
\nA configuration set is a set of rules that you apply to the SMS and voice messages\n that you send.
\nWhen you send a message, you can optionally specify a single configuration set.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSetRequest": { @@ -621,6 +744,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSetResult": { @@ -650,6 +776,9 @@ "smithy.api#documentation": "The time when the configuration set was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreateEventDestination": { @@ -684,7 +813,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new event destination in a configuration set.
\nAn event destination is a location where you send message events. The event options\n are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example,\n when a message is delivered successfully, you can send information about that event to\n an event destination, or send notifications to endpoints that are subscribed to an\n Amazon SNS topic.
\nEach configuration set can contain between 0 and 5 event destinations. Each event\n destination can contain a reference to a single destination, such as a CloudWatch\n or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Creates a new event destination in a configuration set.
\nAn event destination is a location where you send message events. The event options\n are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example,\n when a message is delivered successfully, you can send information about that event to\n an event destination, or send notifications to endpoints that are subscribed to an\n Amazon SNS topic.
\nEach configuration set can contain between 0 and 5 event destinations. Each event\n destination can contain a reference to a single destination, such as a CloudWatch\n or Kinesis Data Firehose destination.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateEventDestinationRequest": { @@ -707,7 +836,7 @@ "MatchingEventTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", "traits": { - "smithy.api#documentation": "An array of event types that determine which events to log. If \"ALL\" is used, then\n Amazon Pinpoint logs every event type.
", + "smithy.api#documentation": "An array of event types that determine which events to log. If \"ALL\" is used, then\n Amazon Pinpoint logs every event type.
\nThe TEXT_SENT event type is not supported.
The details of the destination where events are logged.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreateOptOutList": { @@ -790,7 +925,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new opt-out list.
\nIf the opt-out list name already exists, an Error is returned.
\nAn opt-out list is a list of phone numbers that are opted out, meaning you can't send\n SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for\n the phone number is added to the opt-out list. In addition to STOP, your recipients can\n use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported\n opt-out keywords, see \n SMS opt out in the Amazon Pinpoint User\n Guide.
" + "smithy.api#documentation": "Creates a new opt-out list.
\nIf the opt-out list name already exists, an error is returned.
\nAn opt-out list is a list of phone numbers that are opted out, meaning you can't send\n SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for\n the phone number is added to the opt-out list. In addition to STOP, your recipients can\n use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported\n opt-out keywords, see \n SMS opt out in the Amazon Pinpoint User\n Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateOptOutListRequest": { @@ -816,6 +951,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreateOptOutListResult": { @@ -845,6 +983,9 @@ "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreatePool": { @@ -879,7 +1020,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new pool and associates the specified origination identity to the pool. A\n pool can include one or more phone numbers and SenderIds that are associated with your\n Amazon Web Services account.
\nThe new pool inherits its configuration from the specified origination identity. This\n includes keywords, message type, opt-out list, two-way configuration, and self-managed\n opt-out configuration. Deletion protection isn't inherited from the origination identity\n and defaults to false.
\nIf the origination identity is a phone number and is already associated with another\n pool, an Error is returned. A sender ID can be associated with multiple pools.
" + "smithy.api#documentation": "Creates a new pool and associates the specified origination identity to the pool. A\n pool can include one or more phone numbers and SenderIds that are associated with your\n Amazon Web Services account.
\nThe new pool inherits its configuration from the specified origination identity. This\n includes keywords, message type, opt-out list, two-way configuration, and self-managed\n opt-out configuration. Deletion protection isn't inherited from the origination identity\n and defaults to false.
\nIf the origination identity is a phone number and is already associated with another\n pool, an error is returned. A sender ID can be associated with multiple pools.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreatePoolRequest": { @@ -925,6 +1066,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreatePoolResult": { @@ -945,7 +1089,7 @@ "Status": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", "traits": { - "smithy.api#documentation": "The current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nThe current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nThe Amazon Resource Name (ARN) of the two way channel.
" } }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, "SelfManagedOptOutsEnabled": { "target": "smithy.api#PrimitiveBoolean", "traits": { @@ -1006,25 +1156,31 @@ "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistration": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" @@ -1034,80 +1190,33 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing configuration set.
\nA configuration set is a set of rules that you apply to voice and SMS messages that\n you send. In a configuration set, you can specify a destination for specific types of\n events related to voice and SMS messages.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetRequest": { - "type": "structure", - "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", - "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set ARN that you want to\n delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted configuration set.
" - } - }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", - "traits": { - "smithy.api#documentation": "The name of the deleted configuration set.
" - } - }, - "EventDestinations": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationList", - "traits": { - "smithy.api#documentation": "An array of any EventDestination objects that were associated with the deleted\n configuration set.
" - } - }, - "DefaultMessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The default message type of the configuration set that was deleted.
" - } - }, - "DefaultSenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", - "traits": { - "smithy.api#documentation": "The default Sender ID of the configuration set that was deleted.
" - } - }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the deleted configuration set was created in UNIX epoch time format.
" - } - } + "smithy.api#documentation": "Creates a new registration based on the RegistrationType field.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageType": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociation": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociationResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1116,61 +1225,113 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing default message type on a configuration set.
\nA message type is a type of messages that you plan to send. If you send\n account-related messages or time-sensitive messages such as one-time passcodes, choose\n Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" + "smithy.api#documentation": "Associate the registration with an origination identity such as a phone number or sender ID.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociationRequest": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default message type from. The ConfigurationSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeResult": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociationResult": { "type": "structure", "members": { - "ConfigurationSetArn": { + "RegistrationArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the configuration set.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The current message type for the configuration set.
" + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The registration type or origination identity type.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number associated with the registration in E.164 format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderId": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachment": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachmentRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachmentResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" @@ -1180,208 +1341,181 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing default sender ID on a configuration set.
\nA default sender ID is the identity that appears on recipients' devices when they\n receive SMS messages. Support for sender ID capabilities varies by country or\n region.
" + "smithy.api#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.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachmentRequest": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "AttachmentBody": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentBody", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn\n can be found using the DescribeConfigurationSets action.
", - "smithy.api#required": {} + "smithy.api#documentation": "The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", + }, + "AttachmentUrl": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentUrl", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + "smithy.api#documentation": "A URL to the required registration file. For example, you can provide the S3 object URL.
" } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", "traits": { - "smithy.api#documentation": "The name of the configuration set.
" + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the registration attachment.
" } }, - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "The current sender ID for the configuration set.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationResult" }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Deletes an existing event destination.
\nAn event destination is a location where you send response information about the\n messages that you send. For example, when a message is delivered successfully, you can\n send information about that event to an Amazon CloudWatch destination, or send\n notifications to endpoints that are subscribed to an Amazon SNS topic.
" + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachmentResult": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "RegistrationAttachmentArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set's Amazon Resource Name\n (ARN) to remove the event destination from. The ConfigurateSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration attachment.
", "smithy.api#required": {} } }, - "EventDestinationName": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", + "RegistrationAttachmentId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the event destination to delete.
", + "smithy.api#documentation": "The unique identifier for the registration attachment.
", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", + }, + "AttachmentStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + "smithy.api#documentation": "The status of the registration attachment.
\n\n UPLOAD_IN_PROGRESS The attachment is being uploaded.
\n UPLOAD_COMPLETE The attachment has been uploaded.
\n UPLOAD_FAILED The attachment failed to uploaded.
\n DELETED The attachment has been deleted..
The name of the configuration set the event destination was deleted from.
" + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the registration attachment.
" } }, - "EventDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The event destination object that was deleted.
" + "smithy.api#documentation": "The time when the registration attachment was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest" }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Deletes an existing keyword from an origination phone number or pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nKeywords \"HELP\" and \"STOP\" can't be deleted or modified.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationRequest": { "type": "structure", "members": { - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.
", + "smithy.api#documentation": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", "smithy.api#required": {} } }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", "traits": { - "smithy.api#documentation": "The keyword to delete.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the registration.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordResult": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationResult": { "type": "structure", "members": { - "OriginationIdentityArn": { + "RegistrationArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "OriginationIdentity": { + "RegistrationId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The keyword that was deleted.
" + "smithy.api#documentation": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} } }, - "KeywordMessage": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "RegistrationStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus", "traits": { - "smithy.api#documentation": "The message that was associated with the deleted keyword.
" + "smithy.api#documentation": "The status of the registration.
\n\n CREATED: Your registration is created but not submitted.
\n SUBMITTED: Your registration has been submitted and is awaiting review.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n PROVISIONING: Your registration has been approved and your origination identity is being created.
\n COMPLETE: Your registration has been approved and and your origination identity has been created.
\n REQUIRES_UPDATES: You must fix your registration and resubmit it.
\n CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
\n DELETED: The registration has been deleted.
The action that was associated with the deleted keyword.
" + "smithy.api#documentation": "The current version number of the registration.
", + "smithy.api#required": {} + } + }, + "AdditionalAttributes": { + "target": "com.amazonaws.pinpointsmsvoicev2#StringMap", + "traits": { + "smithy.api#documentation": "Metadata about a given registration which is specific to that registration type.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the registration.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersion": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersionRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersionResult" }, "errors": [ { @@ -1396,6 +1530,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1404,51 +1541,74 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are\n deleted.
\nIf the specified opt-out list name doesn't exist or is in-use by an origination phone\n number or pool, an Error is returned.
" + "smithy.api#documentation": "Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersionRequest": { "type": "structure", "members": { - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", + "smithy.api#documentation": "The unique identifier for the registration.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersionResult": { "type": "structure", "members": { - "OptOutListArn": { + "RegistrationArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList that was removed.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the OptOutList that was removed.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", "traits": { - "smithy.api#documentation": "The time when the OptOutList was created, in UNIX epoch time format.
" + "smithy.api#documentation": "The new version number of the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationVersionStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the registration.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n 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.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber": { + "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumber": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumberRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumberResult" }, "errors": [ { @@ -1461,7 +1621,7 @@ "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" @@ -1471,79 +1631,98 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing opted out destination phone number from the specified opt-out\n list.
\nEach destination phone number can only be deleted once every 30 days.
\nIf the specified destination phone number doesn't exist or if the opt-out list doesn't\n exist, an Error is returned.
" + "smithy.api#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\n numbers.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumberRequest": { "type": "structure", "members": { - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn to remove the phone number from.
", + "smithy.api#documentation": "The verified destination phone number, in E.164 format.
", "smithy.api#required": {} } }, - "OptedOutNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", "traits": { - "smithy.api#documentation": "The phone number, in E.164 format, to remove from the OptOutList.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the destination number.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumberResult": { "type": "structure", "members": { - "OptOutListArn": { + "VerifiedDestinationNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The OptOutListArn that the phone number was removed from.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
", + "smithy.api#required": {} } }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "VerifiedDestinationNumberId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The OptOutListName that the phone number was removed from.
" + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", + "smithy.api#required": {} } }, - "OptedOutNumber": { + "DestinationPhoneNumber": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "The phone number that was removed from the OptOutList.
" + "smithy.api#documentation": "The verified destination phone number, in E.164 format.
", + "smithy.api#required": {} } }, - "OptedOutTimestamp": { - "target": "smithy.api#Timestamp", + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationStatus", "traits": { - "smithy.api#documentation": "The time that the number was removed at, in UNIX epoch time format.
" + "smithy.api#documentation": "The status of the verified destination phone number.
\n\n PENDING: The phone number hasn't been verified yet.
\n VERIFIED: The phone number is verified and can receive messages.
This is true if it was the end user who requested their phone number be removed.\n
" + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the destination number.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the verified phone number was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeletePool": { + "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeletePoolRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeletePoolResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -1558,96 +1737,75 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing pool. Deleting a pool disassociates all origination identities\n from that pool.
\nIf the pool status isn't active or if deletion protection is enabled, an Error is\n returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
" + "smithy.api#documentation": "Deletes an existing configuration set.
\nA configuration set is a set of rules that you apply to voice and SMS messages that\n you send. In a configuration set, you can specify a destination for specific types of\n events related to voice and SMS messages.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeletePoolRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetRequest": { "type": "structure", "members": { - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
", + "smithy.api#documentation": "The name of the configuration set or the configuration set ARN that you want to\n delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeletePoolResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetResult": { "type": "structure", "members": { - "PoolArn": { + "ConfigurationSetArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool that was deleted.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted configuration set.
" } }, - "PoolId": { - "target": "smithy.api#String", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The PoolId of the pool that was deleted.
" + "smithy.api#documentation": "The name of the deleted configuration set.
" } }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", + "EventDestinations": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationList", "traits": { - "smithy.api#documentation": "The current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nAn array of any EventDestination objects that were associated with the deleted\n configuration set.
" } }, - "MessageType": { + "DefaultMessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The message type that was associated with the deleted pool.
" - } - }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the TwoWayChannel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { - "smithy.api#documentation": "The name of the OptOutList that was associated with the deleted pool.
" + "smithy.api#documentation": "The default message type of the configuration set that was deleted.
" } }, - "SharedRoutesEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "DefaultSenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" + "smithy.api#documentation": "The default Sender ID of the configuration set that was deleted.
" } }, "CreatedTimestamp": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" + "smithy.api#documentation": "The time that the deleted configuration set was created in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageType": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeResult" }, "errors": [ { @@ -1656,6 +1814,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1664,82 +1825,57 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an account-level monthly spending limit override for sending text messages.\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Amazon Pinpoint quotas \n in the Amazon Pinpoint Developer Guide.
Deletes an existing default message type on a configuration set.
\nA message type is a type of messages that you plan to send. If you send\n account-related messages or time-sensitive messages such as one-time passcodes, choose\n Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeRequest": { "type": "structure", "members": { - "MonthlyLimit": { - "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The current monthly limit, in US dollars.
" + "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default message type from. The ConfigurationSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#required": {} } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverride": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverrideRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverrideResult" }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Deletes an account level monthly spend limit override for sending voice messages.\n Deleting a spend limit override sets the EnforcedLimit equal to the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spending limits (quotas) see Amazon Pinpoint quotas\n in the Amazon Pinpoint Developer Guide.
The current monthly limit, in US dollars.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "traits": { + "smithy.api#documentation": "The name of the configuration set.
" + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The current message type for the configuration set.
" } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeliveryStreamArn": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributes": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderId": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdResult" }, "errors": [ { @@ -1748,6 +1884,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1756,53 +1895,57 @@ } ], "traits": { - "smithy.api#documentation": "Describes attributes of your Amazon Web Services account. The supported account\n attributes include account tier, which indicates whether your account is in the sandbox\n or production environment. When you're ready to move your account out of the sandbox,\n create an Amazon Web Services Support case for a service limit increase request.
\nNew Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox\n protects both Amazon Web Services end recipients and SMS or voice recipients from fraud\n and abuse.
", - "smithy.api#paginated": { - "items": "AccountAttributes" - } + "smithy.api#documentation": "Deletes an existing default sender ID on a configuration set.
\nA default sender ID is the identity that appears on recipients' devices when they\n receive SMS messages. Support for sender ID capabilities varies by country or\n region.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", - "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn\n can be found using the DescribeConfigurationSets action.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdResult": { "type": "structure", "members": { - "AccountAttributes": { - "target": "com.amazonaws.pinpointsmsvoicev2#AccountAttributeList", + "ConfigurationSetArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of AccountAttributes objects.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The name of the configuration set.
" + } + }, + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The current sender ID for the configuration set.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimits": { + "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestination": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationResult" }, "errors": [ { @@ -1811,6 +1954,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1819,58 +1965,72 @@ } ], "traits": { - "smithy.api#documentation": "Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your\n account. The description for a quota includes the quota name, current usage toward that\n quota, and the quota's maximum value.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on\n the maximum number of configuration sets, opt-out lists, phone numbers, and pools that\n you can create in a given Region. For more information see \n Amazon Pinpoint quotas in the Amazon Pinpoint Developer\n Guide.
", - "smithy.api#paginated": { - "items": "AccountLimits" - } + "smithy.api#documentation": "Deletes an existing event destination.
\nAn event destination is a location where you send response information about the\n messages that you send. For example, when a message is delivered successfully, you can\n send information about that event to an Amazon CloudWatch destination, or send\n notifications to endpoints that are subscribed to an Amazon SNS topic.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The name of the configuration set or the configuration set's Amazon Resource Name\n (ARN) to remove the event destination from. The ConfigurateSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "EventDestinationName": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The name of the event destination to delete.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationResult": { "type": "structure", "members": { - "AccountLimits": { - "target": "com.amazonaws.pinpointsmsvoicev2#AccountLimitList", + "ConfigurationSetArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of AccountLimit objects that show the current spend limits.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The name of the configuration set the event destination was deleted from.
" + } + }, + "EventDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination", + "traits": { + "smithy.api#documentation": "The event destination object that was deleted.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSets": { + "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -1885,70 +2045,84 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified configuration sets or all in your account.
\nIf you specify configuration set names, the output includes information for only the\n specified configuration sets. If you specify filters, the output includes information\n for only those configuration sets that meet the filter criteria. If you don't specify\n configuration set names or filters, the output includes information for all\n configuration sets.
\nIf you specify a configuration set name that isn't valid, an error is returned.
", - "smithy.api#paginated": { - "items": "ConfigurationSets" - } + "smithy.api#documentation": "Deletes an existing keyword from an origination phone number or pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nKeywords \"HELP\" and \"STOP\" can't be deleted or modified.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest": { "type": "structure", "members": { - "ConfigurationSetNames": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameList", + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "An array of strings. Each element can be either a ConfigurationSetName or\n ConfigurationSetArn.
" + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.
", + "smithy.api#required": {} } }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetFilterList", + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", "traits": { - "smithy.api#documentation": "An array of filters to apply to the results that are returned.
" + "smithy.api#documentation": "The keyword to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordResult": { + "type": "structure", + "members": { + "OriginationIdentityArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "OriginationIdentity": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The keyword that was deleted.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsResult": { - "type": "structure", - "members": { - "ConfigurationSets": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetInformationList", + }, + "KeywordMessage": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", "traits": { - "smithy.api#documentation": "An array of ConfigurationSets objects.
" + "smithy.api#documentation": "The message that was associated with the deleted keyword.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "KeywordAction": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The action that was associated with the deleted keyword.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeKeywords": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -1963,89 +2137,65 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified keywords or all keywords on your origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "Keywords" - } + "smithy.api#documentation": "Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are\n deleted.
\nIf the specified opt-out list name doesn't exist or is in-use by an origination phone\n number or pool, an error is returned.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest": { "type": "structure", "members": { - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", + "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", "smithy.api#required": {} } - }, - "Keywords": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordList", - "traits": { - "smithy.api#documentation": "An array of keywords to search for.
" - } - }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilterList", - "traits": { - "smithy.api#documentation": "An array of keyword filters to filter the results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", - "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" - } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult": { "type": "structure", "members": { - "OriginationIdentityArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
" - } - }, - "OriginationIdentity": { + "OptOutListArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList that was removed.
" } }, - "Keywords": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordInformationList", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "An array of KeywordInformation objects that contain the results.
" + "smithy.api#documentation": "The name of the OptOutList that was removed.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The time when the OptOutList was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutLists": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2060,64 +2210,85 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified opt-out list or all opt-out lists in your account.
\nIf you specify opt-out list names, the output includes information for only the\n specified opt-out lists. Opt-out lists include only those that meet the filter criteria.\n If you don't specify opt-out list names or filters, the output includes information for\n all opt-out lists.
\nIf you specify an opt-out list name that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "OptOutLists" - } + "smithy.api#documentation": "Deletes an existing opted out destination phone number from the specified opt-out\n list.
\nEach destination phone number can only be deleted once every 30 days.
\nIf the specified destination phone number doesn't exist or if the opt-out list doesn't\n exist, an error is returned.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberRequest": { "type": "structure", "members": { - "OptOutListNames": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList", - "traits": { - "smithy.api#documentation": "The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The OptOutListName or OptOutListArn to remove the phone number from.
", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The phone number, in E.164 format, to remove from the OptOutList.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberResult": { "type": "structure", "members": { - "OptOutLists": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListInformationList", + "OptOutListArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of OptOutListInformation objects that contain the details for the requested\n OptOutLists.
" + "smithy.api#documentation": "The OptOutListArn that the phone number was removed from.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The OptOutListName that the phone number was removed from.
" + } + }, + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that was removed from the OptOutList.
" + } + }, + "OptedOutTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the number was removed at, in UNIX epoch time format.
" + } + }, + "EndUserOptedOut": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if it was the end user who requested their phone number be removed.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbers": { + "com.amazonaws.pinpointsmsvoicev2#DeletePool": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeletePoolRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeletePoolResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2132,89 +2303,116 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified opted out destination numbers or all opted out destination\n numbers in an opt-out list.
\nIf you specify opted out numbers, the output includes information for only the\n specified opted out numbers. If you specify filters, the output includes information for\n only those opted out numbers that meet the filter criteria. If you don't specify opted\n out numbers or filters, the output includes information for all opted out destination\n numbers in your opt-out list.
\nIf you specify an opted out number that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "OptedOutNumbers" - } + "smithy.api#documentation": "Deletes an existing pool. Deleting a pool disassociates all origination identities\n from that pool.
\nIf the pool status isn't active or if deletion protection is enabled, an error is\n returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeletePoolRequest": { "type": "structure", "members": { - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "PoolId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", + "smithy.api#documentation": "The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
", "smithy.api#required": {} } - }, - "OptedOutNumbers": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberList", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeletePoolResult": { + "type": "structure", + "members": { + "PoolArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of phone numbers to search for in the OptOutList.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool that was deleted.
" } }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterList", + "PoolId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of OptedOutFilter objects to filter the results on.
" + "smithy.api#documentation": "The PoolId of the pool that was deleted.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nThe maximum number of results to return per each request.
" + "smithy.api#documentation": "The message type that was associated with the deleted pool.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersResult": { - "type": "structure", - "members": { - "OptOutListArn": { - "target": "smithy.api#String", + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList.
" + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the TwoWayChannel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "The name of the OptOutList.
" + "smithy.api#documentation": "The name of the OptOutList that was associated with the deleted pool.
" } }, - "OptedOutNumbers": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformationList", + "SharedRoutesEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "An array of OptedOutNumbersInformation objects that provide information about the\n requested OptedOutNumbers.
" + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbers": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistration": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2229,70 +2427,24 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified origination phone number, or all the phone numbers in your\n account.
\nIf you specify phone number IDs, the output includes information for only the\n specified phone numbers. If you specify filters, the output includes information for\n only those phone numbers that meet the filter criteria. If you don't specify phone\n number IDs or filters, the output includes information for all phone numbers.
\nIf you specify a phone number ID that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "PhoneNumbers" - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersRequest": { - "type": "structure", - "members": { - "PhoneNumberIds": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList", - "traits": { - "smithy.api#documentation": "The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.
" - } - }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterList", - "traits": { - "smithy.api#documentation": "An array of PhoneNumberFilter objects to filter the results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", - "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersResult": { - "type": "structure", - "members": { - "PhoneNumbers": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformationList", - "traits": { - "smithy.api#documentation": "An array of PhoneNumberInformation objects that contain the details for the requested\n phone numbers.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", - "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" - } - } + "smithy.api#documentation": "Permanently delete an existing registration from your account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribePools": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachment": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePoolsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachmentRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePoolsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachmentResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2307,70 +2459,81 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the specified pools or all pools associated with your Amazon Web Services\n account.
\nIf you specify pool IDs, the output includes information for only the specified pools.\n If you specify filters, the output includes information for only those pools that meet\n the filter criteria. If you don't specify pool IDs or filters, the output includes\n information for all pools.
\nIf you specify a pool ID that isn't valid, an Error is returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
", - "smithy.api#paginated": { - "items": "Pools" - } + "smithy.api#documentation": "Permanently delete the specified registration attachment.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribePoolsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachmentRequest": { "type": "structure", "members": { - "PoolIds": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdList", + "RegistrationAttachmentId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.
" + "smithy.api#documentation": "The unique identifier for the registration attachment.
", + "smithy.api#required": {} } - }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilterList", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachmentResult": { + "type": "structure", + "members": { + "RegistrationAttachmentArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of PoolFilter objects to filter the results.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration attachment.
", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "RegistrationAttachmentId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The unique identifier for the registration attachment.
", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "AttachmentStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The status of the registration attachment.
\n\n UPLOAD_IN_PROGRESS The attachment is being uploaded.
\n UPLOAD_COMPLETE The attachment has been uploaded.
\n UPLOAD_FAILED The attachment failed to uploaded.
\n DELETED The attachment has been deleted..
An array of PoolInformation objects that contain the details for the requested pools.
" + "smithy.api#documentation": "The error message if the upload failed.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The time when the registration attachment was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIds": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValue": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValueRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValueResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2385,167 +2548,222 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
\nIf you specify SenderIds, the output includes information for only the specified\n SenderIds. If you specify filters, the output includes information for only those\n SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the\n output includes information for all SenderIds.
\nf you specify a sender ID that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "SenderIds" - } + "smithy.api#documentation": "Delete the value in a registration form field.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValueRequest": { "type": "structure", "members": { - "SenderIds": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdList", - "traits": { - "smithy.api#documentation": "An array of SenderIdAndCountry objects to search for.
" - } - }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterList", - "traits": { - "smithy.api#documentation": "An array of SenderIdFilter objects to filter the results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValueResult": { "type": "structure", "members": { - "SenderIds": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdInformationList", + "RegistrationArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of SernderIdInformation objects that contain the details for the requested\n SenderIds.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimits": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages.
\nWhen you establish an Amazon Web Services account, the account has initial monthly\n spend limit in a given Region. For more information on increasing your monthly spend\n limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
", - "smithy.api#paginated": { - "items": "SpendLimits" - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "SelectChoices": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "An array of values for the form field.
" } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "TextValue": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValue", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The text data for a free form field.
" + } + }, + "RegistrationAttachmentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationRequest": { "type": "structure", "members": { - "SpendLimits": { - "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimitList", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "An array of SpendLimit objects that contain the details for the requested spend\n limits.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "RegistrationStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus", + "traits": { + "smithy.api#documentation": "The status of the registration.
\n\n CREATED: Your registration is created but not submitted.
\n SUBMITTED: Your registration has been submitted and is awaiting review.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n PROVISIONING: Your registration has been approved and your origination identity is being created.
\n COMPLETE: Your registration has been approved and and your origination identity has been created.
\n REQUIRES_UPDATES: You must fix your registration and resubmit it.
\n CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
\n DELETED: The registration has been deleted.
The current version number of the registration.
", + "smithy.api#required": {} + } + }, + "ApprovedVersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration that was approved.
" + } + }, + "LatestDeniedVersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The latest version number of the registration that was denied.
" + } + }, + "AdditionalAttributes": { + "target": "com.amazonaws.pinpointsmsvoicev2#StringMap", + "traits": { + "smithy.api#documentation": "Metadata about a given registration which is specific to that registration type.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterKey": { - "type": "string", + "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], "traits": { - "smithy.api#enum": [ - { - "value": "IN_TEMPLATE_ID", - "name": "IN_TEMPLATE_ID" - }, - { - "value": "IN_ENTITY_ID", - "name": "IN_ENTITY_ID" - } - ] + "smithy.api#documentation": "Deletes an account-level monthly spending limit override for sending text messages.\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Amazon Pinpoint quotas \n in the Amazon Pinpoint Developer Guide.
The current monthly limit, in US dollars.
" + } + } }, "traits": { - "smithy.api#length": { - "max": 10 - } + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity": { + "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumber": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumberRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumberResult" }, "errors": [ { @@ -2568,478 +2786,346 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified origination identity from an existing pool.
\nIf the origination identity isn't associated with the specified pool, an Error is\n returned.
" + "smithy.api#documentation": "Delete a verified destination phone number.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumberRequest": { "type": "structure", "members": { - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", - "traits": { - "smithy.api#documentation": "The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.
", - "smithy.api#required": {} - } - }, - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", - "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.
", - "smithy.api#required": {} - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "VerifiedDestinationNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", "smithy.api#required": {} } - }, - "ClientToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", - "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", - "smithy.api#idempotencyToken": {} - } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumberResult": { "type": "structure", "members": { - "PoolArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool.
" - } - }, - "PoolId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PoolId of the pool no longer associated with the origination identity.
" - } - }, - "OriginationIdentityArn": { + "VerifiedDestinationNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberArn or SenderIdArn of the origination identity.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
", + "smithy.api#required": {} } }, - "OriginationIdentity": { + "VerifiedDestinationNumberId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberId or SenderId of the origination identity.
" - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#EventDestination": { - "type": "structure", - "members": { - "EventDestinationName": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", - "traits": { - "smithy.api#documentation": "The name of the EventDestination.
", + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", "smithy.api#required": {} } }, - "Enabled": { - "target": "smithy.api#Boolean", + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "When set to true events will be logged.
", + "smithy.api#documentation": "The verified destination phone number, in E.164 format.
", "smithy.api#required": {} } }, - "MatchingEventTypes": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "An array of event types that determine which events to log.
", + "smithy.api#documentation": "The time when the destination phone number was created, in UNIX epoch time format.
", "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverrideRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverrideResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "CloudWatchLogsDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#CloudWatchLogsDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination that sends logging\n events to Amazon CloudWatch logs.
" - } + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - "KinesisFirehoseDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon\n Kinesis Data Firehose.
" - } + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, - "SnsDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an account level monthly spend limit override for sending voice messages.\n Deleting a spend limit override sets the EnforcedLimit equal to the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spending limits (quotas) see Amazon Pinpoint quotas\n in the Amazon Pinpoint Developer Guide.
An object that contains information about an event destination that sends logging\n events to Amazon SNS.
" + "smithy.api#documentation": "The current monthly limit, in US dollars.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about an event destination.
\nEvent destinations are associated with configuration sets, which enable you to publish\n message sending events to\n Amazon\n CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#EventDestinationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#EventDestinationName": { + "com.amazonaws.pinpointsmsvoicev2#DeliveryStreamArn": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 64 + "min": 20, + "max": 2048 }, - "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + "smithy.api#pattern": "^arn:\\S+$" } }, - "com.amazonaws.pinpointsmsvoicev2#EventType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALL", - "name": "ALL" - }, - { - "value": "TEXT_ALL", - "name": "TEXT_ALL" - }, - { - "value": "TEXT_SENT", - "name": "TEXT_SENT" - }, - { - "value": "TEXT_PENDING", - "name": "TEXT_PENDING" - }, - { - "value": "TEXT_QUEUED", - "name": "TEXT_QUEUED" - }, - { - "value": "TEXT_SUCCESSFUL", - "name": "TEXT_SUCCESSFUL" - }, - { - "value": "TEXT_DELIVERED", - "name": "TEXT_DELIVERED" - }, - { - "value": "TEXT_INVALID", - "name": "TEXT_INVALID" - }, - { - "value": "TEXT_INVALID_MESSAGE", - "name": "TEXT_INVALID_MESSAGE" - }, - { - "value": "TEXT_UNREACHABLE", - "name": "TEXT_UNREACHABLE" - }, - { - "value": "TEXT_CARRIER_UNREACHABLE", - "name": "TEXT_CARRIER_UNREACHABLE" - }, - { - "value": "TEXT_BLOCKED", - "name": "TEXT_BLOCKED" - }, - { - "value": "TEXT_CARRIER_BLOCKED", - "name": "TEXT_CARRIER_BLOCKED" - }, - { - "value": "TEXT_SPAM", - "name": "TEXT_SPAM" - }, - { - "value": "TEXT_UNKNOWN", - "name": "TEXT_UNKNOWN" - }, - { - "value": "TEXT_TTL_EXPIRED", - "name": "TEXT_TTL_EXPIRED" - }, - { - "value": "VOICE_ALL", - "name": "VOICE_ALL" - }, - { - "value": "VOICE_INITIATED", - "name": "VOICE_INITIATED" - }, - { - "value": "VOICE_RINGING", - "name": "VOICE_RINGING" - }, - { - "value": "VOICE_ANSWERED", - "name": "VOICE_ANSWERED" - }, - { - "value": "VOICE_COMPLETED", - "name": "VOICE_COMPLETED" - }, - { - "value": "VOICE_BUSY", - "name": "VOICE_BUSY" - }, - { - "value": "VOICE_NO_ANSWER", - "name": "VOICE_NO_ANSWER" - }, - { - "value": "VOICE_FAILED", - "name": "VOICE_FAILED" - }, - { - "value": "VOICE_TTL_EXPIRED", - "name": "VOICE_TTL_EXPIRED" - } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#EventTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventType" + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesRequest" }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#FilterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[A-Za-z0-9_-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#FilterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValue" + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesResult" }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } - } - }, - "com.amazonaws.pinpointsmsvoicev2#IamRoleArn": { - "type": "string", + ], "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" + "smithy.api#documentation": "Describes attributes of your Amazon Web Services account. The supported account\n attributes include account tier, which indicates whether your account is in the sandbox\n or production environment. When you're ready to move your account out of the sandbox,\n create an Amazon Web Services Support case for a service limit increase request.
\nNew Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox\n protects both Amazon Web Services end recipients and SMS or voice recipients from fraud\n and abuse.
", + "smithy.api#paginated": { + "items": "AccountAttributes" + } } }, - "com.amazonaws.pinpointsmsvoicev2#InternalServerException": { + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesRequest": { "type": "structure", "members": { - "Message": { - "target": "smithy.api#String" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - "RequestId": { - "target": "smithy.api#String", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "The unique identifier of the request.
" + "smithy.api#documentation": "The maximum number of results to return per each request.
" } } }, "traits": { - "smithy.api#documentation": "The API encountered an unexpected error and couldn't complete the request. You might\n be able to successfully issue the request again in the future.
", - "smithy.api#error": "server", - "smithy.api#retryable": {} - } - }, - "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - }, - "smithy.api#pattern": "^[A-Z]{2}$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#Keyword": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - }, - "smithy.api#pattern": "^[ \\S]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#KeywordAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTOMATIC_RESPONSE", - "name": "AUTOMATIC_RESPONSE" - }, - { - "value": "OPT_OUT", - "name": "OPT_OUT" - }, - { - "value": "OPT_IN", - "name": "OPT_IN" - } - ] + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordFilter": { + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesResult": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilterName", + "AccountAttributes": { + "target": "com.amazonaws.pinpointsmsvoicev2#AccountAttributeList", "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of AccountAttributes objects.
" } }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "An array values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#documentation": "The information for keywords that meet a specified criteria.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilter" + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimits": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsRequest" }, - "traits": { - "smithy.api#length": { - "max": 20 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#KeywordFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "keyword-action", - "name": "KEYWORD_ACTION" - } - ] + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your\n account. The description for a quota includes the quota name, current usage toward that\n quota, and the quota's maximum value.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on\n the maximum number of configuration sets, opt-out lists, phone numbers, and pools that\n you can create in a given Region. For more information see \n Amazon Pinpoint quotas in the Amazon Pinpoint Developer\n Guide.
", + "smithy.api#paginated": { + "items": "AccountLimits" + } } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordInformation": { + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsRequest": { "type": "structure", "members": { - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The keyword as a string.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } }, - "KeywordMessage": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "A custom message that can be used with the keyword.
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsResult": { + "type": "structure", + "members": { + "AccountLimits": { + "target": "com.amazonaws.pinpointsmsvoicev2#AccountLimitList", + "traits": { + "smithy.api#documentation": "An array of AccountLimit objects that show the current spend limits.
" } }, - "KeywordAction": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The action to perform for the keyword.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#documentation": "The information for all keywords in a pool.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#KeywordInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordInformation" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword" + "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsResult" }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "max": 5 + "smithy.api#documentation": "Describes the specified configuration sets or all in your account.
\nIf you specify configuration set names, the output includes information for only the\n specified configuration sets. If you specify filters, the output includes information\n for only those configuration sets that meet the filter criteria. If you don't specify\n configuration set names or filters, the output includes information for all\n configuration sets.
\nIf you specify a configuration set name that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "ConfigurationSets" } } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1600 + "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsRequest": { + "type": "structure", + "members": { + "ConfigurationSetNames": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameList", + "traits": { + "smithy.api#documentation": "An array of strings. Each element can be either a ConfigurationSetName or\n ConfigurationSetArn.
" + } }, - "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetFilterList", + "traits": { + "smithy.api#documentation": "An array of filters to apply to the results that are returned.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination": { + "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsResult": { "type": "structure", "members": { - "IamRoleArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "ConfigurationSets": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetInformationList", "traits": { - "smithy.api#documentation": "The ARN of an Amazon Identity and Access Management (IAM) role that is able to write\n event data to an Amazon Firehose destination.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of ConfigurationSets objects.
" } }, - "DeliveryStreamArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeliveryStreamArn", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the delivery stream.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#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\n destination.
\nEvent destinations, such as Kinesis Data Firehose, are associated with configuration\n sets, which enable you to publish message sending events.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities": { + "com.amazonaws.pinpointsmsvoicev2#DescribeKeywords": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsResult" }, "errors": [ { @@ -3059,26 +3145,32 @@ } ], "traits": { - "smithy.api#documentation": "Lists all associated origination identities in your pool.
\nIf you specify filters, the output includes information for only those origination\n identities that meet the filter criteria.
", + "smithy.api#documentation": "Describes the specified keywords or all keywords on your origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
", "smithy.api#paginated": { - "items": "OriginationIdentities" + "items": "Keywords" } } }, - "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesRequest": { + "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsRequest": { "type": "structure", "members": { - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.
", + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", "smithy.api#required": {} } }, + "Keywords": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordList", + "traits": { + "smithy.api#documentation": "An array of keywords to search for.
" + } + }, "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterList", + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilterList", "traits": { - "smithy.api#documentation": "An array of PoolOriginationIdentitiesFilter objects to filter the results..
" + "smithy.api#documentation": "An array of keyword filters to filter the results.
" } }, "NextToken": { @@ -3093,27 +3185,30 @@ "smithy.api#documentation": "The maximum number of results to return per each request.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesResult": { + "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsResult": { "type": "structure", "members": { - "PoolArn": { + "OriginationIdentityArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pool.
" + "smithy.api#documentation": "The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
" } }, - "PoolId": { + "OriginationIdentity": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique PoolId of the pool.
" + "smithy.api#documentation": "The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
" } }, - "OriginationIdentities": { - "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadataList", + "Keywords": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordInformationList", "traits": { - "smithy.api#documentation": "An array of any OriginationIdentityMetadata objects.
" + "smithy.api#documentation": "An array of KeywordInformation objects that contain the results.
" } }, "NextToken": { @@ -3122,15 +3217,18 @@ "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ListTagsForResource": { + "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutLists": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsResult" }, "errors": [ { @@ -3150,849 +3248,3182 @@ } ], "traits": { - "smithy.api#documentation": "List all tags associated with a resource.
" + "smithy.api#documentation": "Describes the specified opt-out list or all opt-out lists in your account.
\nIf you specify opt-out list names, the output includes information for only the\n specified opt-out lists. Opt-out lists include only those that meet the filter criteria.\n If you don't specify opt-out list names or filters, the output includes information for\n all opt-out lists.
\nIf you specify an opt-out list name that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "OptOutLists" + } } }, - "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceRequest": { + "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "OptOutListNames": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to query for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceResult": { + "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsResult": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "OptOutLists": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListInformationList", "traits": { - "smithy.api#documentation": "The ARN of the resource.
" + "smithy.api#documentation": "An array of OptOutListInformation objects that contain the details for the requested\n OptOutLists.
" } }, - "Tags": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#LogGroupArn": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#MaxPrice": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 8 + "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "smithy.api#pattern": "^[0-9]{0,2}\\.[0-9]{1,5}$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } - } - }, - "com.amazonaws.pinpointsmsvoicev2#MessageType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRANSACTIONAL", - "name": "TRANSACTIONAL" - }, - { - "value": "PROMOTIONAL", - "name": "PROMOTIONAL" - } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#MessageTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType" - } - }, - "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit": { - "type": "long", + ], "traits": { - "smithy.api#range": { - "min": 0, - "max": 1000000000 + "smithy.api#documentation": "Describes the specified opted out destination numbers or all opted out destination\n numbers in an opt-out list.
\nIf you specify opted out numbers, the output includes information for only the\n specified opted out numbers. If you specify filters, the output includes information for\n only those opted out numbers that meet the filter criteria. If you don't specify opted\n out numbers or filters, the output includes information for all opted out destination\n numbers in your opt-out list.
\nIf you specify an opted out number that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "OptedOutNumbers" } } }, - "com.amazonaws.pinpointsmsvoicev2#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 + "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersRequest": { + "type": "structure", + "members": { + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", + "smithy.api#required": {} + } }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#NonEmptyTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#NumberCapability": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SMS", - "name": "SMS" - }, - { - "value": "VOICE", - "name": "VOICE" + "OptedOutNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberList", + "traits": { + "smithy.api#documentation": "An array of phone numbers to search for in the OptOutList.
" } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapability" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#NumberStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "ASSOCIATING", - "name": "ASSOCIATING" - }, - { - "value": "DISASSOCIATING", - "name": "DISASSOCIATING" - }, - { - "value": "DELETED", - "name": "DELETED" + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterList", + "traits": { + "smithy.api#documentation": "An array of OptedOutFilter objects to filter the results on.
" } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#NumberType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SHORT_CODE", - "name": "SHORT_CODE" - }, - { - "value": "LONG_CODE", - "name": "LONG_CODE" - }, - { - "value": "TOLL_FREE", - "name": "TOLL_FREE" - }, - { - "value": "TEN_DLC", - "name": "TEN_DLC" + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } - ] + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListInformation": { + "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersResult": { "type": "structure", "members": { "OptOutListArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList.
" } }, "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "The name of the OptOutList.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the OptOutList.
" } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "OptedOutNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformationList", "traits": { - "smithy.api#documentation": "The time when the OutOutList was created, in UNIX epoch time format.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of OptedOutNumbersInformation objects that provide information about the\n requested OptedOutNumbers.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#documentation": "The information for all OptOutList in an Amazon Web Services account.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListInformation" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 + "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the specified origination phone number, or all the phone numbers in your\n account.
\nIf you specify phone number IDs, the output includes information for only the\n specified phone numbers. If you specify filters, the output includes information for\n only those phone numbers that meet the filter criteria. If you don't specify phone\n number IDs or filters, the output includes information for all phone numbers.
\nIf you specify a phone number ID that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "PhoneNumbers" + } } }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn" - }, - "traits": { - "smithy.api#length": { - "max": 5 + "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersRequest": { + "type": "structure", + "members": { + "PhoneNumberIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList", + "traits": { + "smithy.api#documentation": "The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.
" + } + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterList", + "traits": { + "smithy.api#documentation": "An array of PhoneNumberFilter objects to filter the results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutFilter": { + "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersResult": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterName", + "PhoneNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformationList", "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of PhoneNumberInformation objects that contain the details for the requested\n phone numbers.
" } }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "An array of values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#documentation": "The information for opted out numbers that meet a specified criteria.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilter" + "com.amazonaws.pinpointsmsvoicev2#DescribePools": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePoolsRequest" }, - "traits": { - "smithy.api#length": { - "max": 20 + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePoolsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } - } - }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterName": { - "type": "string", + ], "traits": { - "smithy.api#enum": [ - { - "value": "end-user-opted-out", - "name": "END_USER_OPTED_OUT" - } - ] + "smithy.api#documentation": "Retrieves the specified pools or all pools associated with your Amazon Web Services\n account.
\nIf you specify pool IDs, the output includes information for only the specified pools.\n If you specify filters, the output includes information for only those pools that meet\n the filter criteria. If you don't specify pool IDs or filters, the output includes\n information for all pools.
\nIf you specify a pool ID that isn't valid, an error is returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
", + "smithy.api#paginated": { + "items": "Pools" + } } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformation": { + "com.amazonaws.pinpointsmsvoicev2#DescribePoolsRequest": { "type": "structure", "members": { - "OptedOutNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "PoolIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdList", "traits": { - "smithy.api#documentation": "The phone number that is opted out.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.
" } }, - "OptedOutTimestamp": { - "target": "smithy.api#Timestamp", + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilterList", "traits": { - "smithy.api#documentation": "The time that the op tout occurred, in UNIX epoch time format.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of PoolFilter objects to filter the results.
" } }, - "EndUserOptedOut": { - "target": "smithy.api#PrimitiveBoolean", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "This is set to true if it was the end recipient that opted out.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" } } }, "traits": { - "smithy.api#documentation": "The information for an opted out number in an Amazon Web Services account.
" + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformation" + "com.amazonaws.pinpointsmsvoicev2#DescribePoolsResult": { + "type": "structure", + "members": { + "Pools": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolInformationList", + "traits": { + "smithy.api#documentation": "An array of PoolInformation objects that contain the details for the requested pools.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber" + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachments": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachmentsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachmentsResult" }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "max": 5 + "smithy.api#documentation": "Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
", + "smithy.api#paginated": { + "items": "RegistrationAttachments" } } }, - "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata": { + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachmentsRequest": { "type": "structure", "members": { - "OriginationIdentityArn": { - "target": "smithy.api#String", + "RegistrationAttachmentIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the origination identity.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.
" } }, - "OriginationIdentity": { - "target": "smithy.api#String", + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilterList", "traits": { - "smithy.api#documentation": "The unique identifier of the origination identity.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of RegistrationAttachmentFilter objects to filter the results.
" } }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of results to return per each request.
" } } }, "traits": { - "smithy.api#documentation": "The metadata for an origination identity associated with a pool.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadataList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumber": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - }, - "smithy.api#pattern": "^\\+?[1-9][0-9]{1,18}$" + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilter": { + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachmentsResult": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterName", + "RegistrationAttachments": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentsInformationList", "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#documentation": "An array of RegistrationAttachments objects that contain the details for the requested registration attachments.
", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "An array values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } } }, "traits": { - "smithy.api#documentation": "The information for a phone number that meets a specified criteria.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilter" + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitionsRequest" }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "max": 20 + "smithy.api#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.
", + "smithy.api#paginated": { + "items": "RegistrationFieldDefinitions" } } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "status", - "name": "STATUS" - }, - { - "value": "iso-country-code", - "name": "ISO_COUNTRY_CODE" - }, - { - "value": "message-type", - "name": "MESSAGE_TYPE" - }, - { - "value": "number-capability", - "name": "NUMBER_CAPABILITY" - }, - { - "value": "number-type", - "name": "NUMBER_TYPE" - }, - { - "value": "two-way-enabled", - "name": "TWO_WAY_ENABLED" - }, - { - "value": "self-managed-opt-outs-enabled", - "name": "SELF_MANAGED_OPT_OUTS_ENABLED" - }, - { - "value": "opt-out-list-name", - "name": "OPT_OUT_LIST_NAME" - }, - { - "value": "deletion-protection-enabled", - "name": "DELETION_PROTECTION_ENABLED" + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitionsRequest": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} } - ] + }, + "SectionPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath", + "traits": { + "smithy.api#documentation": "The path to the section of the registration.
" + } + }, + "FieldPaths": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPathList", + "traits": { + "smithy.api#documentation": "An array of paths to the registration form field.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn" + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitionsResult": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "RegistrationFieldDefinitions": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDefinitionList", + "traits": { + "smithy.api#documentation": "An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } }, "traits": { - "smithy.api#length": { - "max": 5 - } + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValues": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValuesRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValuesResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registration field values.
", + "smithy.api#paginated": { + "items": "RegistrationFieldValues" + } } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformation": { + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValuesRequest": { "type": "structure", "members": { - "PhoneNumberArn": { - "target": "smithy.api#String", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the phone number.
", + "smithy.api#documentation": "The unique identifier for the registration.
", "smithy.api#required": {} } }, - "PhoneNumberId": { - "target": "smithy.api#String", + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", "traits": { - "smithy.api#documentation": "The unique identifier for the phone number.
" + "smithy.api#documentation": "The version number of the registration.
" } }, - "PhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "SectionPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath", "traits": { - "smithy.api#documentation": "The phone number in E.164 format.
", - "smithy.api#required": {} + "smithy.api#documentation": "The path to the section of the registration.
" } }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "FieldPaths": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPathList", "traits": { - "smithy.api#documentation": "The current status of the phone number.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of paths to the registration form field.
" } }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of results to return per each request.
" } - }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValuesResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", "smithy.api#required": {} } }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The type of phone number.
", + "smithy.api#documentation": "The unique identifier for the registration.
", "smithy.api#required": {} } }, - "MonthlyLeasingPrice": { - "target": "smithy.api#String", + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", "traits": { - "smithy.api#documentation": "The price, in US dollars, to lease the phone number.
", + "smithy.api#documentation": "The current version of the registration.
", "smithy.api#required": {} } }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "RegistrationFieldValues": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldValueInformationList", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients using the TwoWayChannelArn.
", + "smithy.api#documentation": "An array of RegistrationFieldValues objects that contain the values for the requested registration.
", "smithy.api#required": {} } }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
", + "smithy.api#paginated": { + "items": "RegistrationSectionDefinitions" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitionsRequest": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out request. For more information see Self-managed opt-outs\n
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", "smithy.api#required": {} } }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "SectionPaths": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPathList", "traits": { - "smithy.api#documentation": "The name of the OptOutList associated with the phone number.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of paths for the registration form section.
" } }, - "DeletionProtectionEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true the phone number can't be deleted.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } }, - "PoolId": { - "target": "smithy.api#String", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "The unique identifier of the pool associated with the phone number.
" + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitionsResult": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "RegistrationSectionDefinitions": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDefinitionList", "traits": { - "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
", + "smithy.api#documentation": "An array of RegistrationSectionDefinition objects.
", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } } }, "traits": { - "smithy.api#documentation": "The information for a phone number in an Amazon Web Services account.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformation" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PinpointSMSVoiceV2": { - "type": "service", - "version": "2022-03-31", - "operations": [ + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitionsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentity" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSet" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#CreateEventDestination" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#CreateOptOutList" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
", + "smithy.api#paginated": { + "items": "RegistrationTypeDefinitions" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitionsRequest": { + "type": "structure", + "members": { + "RegistrationTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeList", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#CreatePool" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilterList", + "traits": { + "smithy.api#documentation": "An array of RegistrationFilter objects to filter the results.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageType" + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitionsResult": { + "type": "structure", + "members": { + "RegistrationTypeDefinitions": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDefinitionList", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersionsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersionsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderId" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestination" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword" + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registration version.
", + "smithy.api#paginated": { + "items": "RegistrationVersions" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersionsRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeletePool" + "VersionNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumberList", + "traits": { + "smithy.api#documentation": "An array of registration version numbers.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilterList", + "traits": { + "smithy.api#documentation": "An array of RegistrationVersionFilter objects to filter the results.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverride" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributes" + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersionsResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimits" + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSets" + "RegistrationVersions": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionInformationList", + "traits": { + "smithy.api#documentation": "An array of RegistrationVersions objects.
", + "smithy.api#required": {} + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywords" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbers" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutLists" + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbers" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePools" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registrations.
", + "smithy.api#paginated": { + "items": "Registrations" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationsRequest": { + "type": "structure", + "members": { + "RegistrationIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdList", + "traits": { + "smithy.api#documentation": "An array of unique identifiers for each registration.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIds" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFilterList", + "traits": { + "smithy.api#documentation": "An array of RegistrationFilter objects to filter the results.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimits" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationsResult": { + "type": "structure", + "members": { + "Registrations": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationInformationList", + "traits": { + "smithy.api#documentation": "An array of RegistrationInformation objects.
", + "smithy.api#required": {} + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIds": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResource" + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#PutKeyword" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumber" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
\nIf you specify SenderIds, the output includes information for only the specified\n SenderIds. If you specify filters, the output includes information for only those\n SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the\n output includes information for all SenderIds.
\nf you specify a sender ID that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "SenderIds" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsRequest": { + "type": "structure", + "members": { + "SenderIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdList", + "traits": { + "smithy.api#documentation": "An array of SenderIdAndCountry objects to search for.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterList", + "traits": { + "smithy.api#documentation": "An array of SenderIdFilter objects to filter the results.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumber" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessage" + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsResult": { + "type": "structure", + "members": { + "SenderIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdInformationList", + "traits": { + "smithy.api#documentation": "An array of SernderIdInformation objects that contain the details for the requested\n SenderIds.
" + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimits": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages.
\nWhen you establish an Amazon Web Services account, the account has initial monthly\n spend limit in a given Region. For more information on increasing your monthly spend\n limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
", + "smithy.api#paginated": { + "items": "SpendLimits" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverride" + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsResult": { + "type": "structure", + "members": { + "SpendLimits": { + "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimitList", + "traits": { + "smithy.api#documentation": "An array of SpendLimit objects that contain the details for the requested spend\n limits.
" + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbersRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbersResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#TagResource" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#UntagResource" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestination" + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumber" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePool" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } ], "traits": { - "aws.api#service": { - "sdkId": "Pinpoint SMS Voice V2", - "endpointPrefix": "sms-voice", - "arnNamespace": "sms-voice" + "smithy.api#documentation": "Retrieves the specified verified destiona numbers.
", + "smithy.api#paginated": { + "items": "VerifiedDestinationNumbers" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbersRequest": { + "type": "structure", + "members": { + "VerifiedDestinationNumberIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdList", + "traits": { + "smithy.api#documentation": "An array of VerifiedDestinationNumberid to retreive.
" + } }, - "aws.auth#sigv4": { - "name": "sms-voice" + "DestinationPhoneNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationPhoneNumberList", + "traits": { + "smithy.api#documentation": "An array of verified destination phone number, in E.164 format.
" + } }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.\n This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.
\nAmazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The Amazon Pinpoint SMS and\n Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels and supplements the resources provided by the Amazon Pinpoint\n API.
\nIf you're new to Amazon Pinpoint, it's also helpful to review the \n Amazon Pinpoint Developer Guide. The Amazon Pinpoint\n Developer Guide provides tutorials, code samples, and procedures that\n demonstrate how to use Amazon Pinpoint features programmatically and how to integrate\n Amazon Pinpoint functionality into mobile apps and other types of applications.\n The guide also provides key information, such as Amazon Pinpoint integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilterList", + "traits": { + "smithy.api#documentation": "An array of VerifiedDestinationNumberFilter objects to filter the results.
" + } }, - "smithy.api#title": "Amazon Pinpoint SMS Voice V2", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbersResult": { + "type": "structure", + "members": { + "VerifiedDestinationNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberInformationList", + "traits": { + "smithy.api#documentation": "An array of VerifiedDestinationNumberInformation objects
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_TEMPLATE_ID", + "name": "IN_TEMPLATE_ID" }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + { + "value": "IN_ENTITY_ID", + "name": "IN_ENTITY_ID" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterKey" + }, + "value": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterValue" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DestinationPhoneNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specified origination identity from an existing pool.
\nIf the origination identity isn't associated with the specified pool, an error is\n returned.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.
", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", + "traits": { + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityResult": { + "type": "structure", + "members": { + "PoolArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool.
" + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PoolId of the pool no longer associated with the origination identity.
" + } + }, + "OriginationIdentityArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberArn or SenderIdArn of the origination identity.
" + } + }, + "OriginationIdentity": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberId or SenderId of the origination identity.
" + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Discard the current version of the registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationVersionStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the registration version.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n 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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventDestination": { + "type": "structure", + "members": { + "EventDestinationName": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", + "traits": { + "smithy.api#documentation": "The name of the EventDestination.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "When set to true events will be logged.
", + "smithy.api#required": {} + } + }, + "MatchingEventTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", + "traits": { + "smithy.api#documentation": "An array of event types that determine which events to log.
\nThe TEXT_SENT event type is not supported.
An object that contains information about an event destination that sends logging\n events to Amazon CloudWatch logs.
" + } + }, + "KinesisFirehoseDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", + "traits": { + "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon\n Kinesis Data Firehose.
" + } + }, + "SnsDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", + "traits": { + "smithy.api#documentation": "An object that contains information about an event destination that sends logging\n events to Amazon SNS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an event destination.
\nEvent destinations are associated with configuration sets, which enable you to publish\n message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventDestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination" + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventDestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "TEXT_ALL", + "name": "TEXT_ALL" + }, + { + "value": "TEXT_SENT", + "name": "TEXT_SENT" + }, + { + "value": "TEXT_PENDING", + "name": "TEXT_PENDING" + }, + { + "value": "TEXT_QUEUED", + "name": "TEXT_QUEUED" + }, + { + "value": "TEXT_SUCCESSFUL", + "name": "TEXT_SUCCESSFUL" + }, + { + "value": "TEXT_DELIVERED", + "name": "TEXT_DELIVERED" + }, + { + "value": "TEXT_INVALID", + "name": "TEXT_INVALID" + }, + { + "value": "TEXT_INVALID_MESSAGE", + "name": "TEXT_INVALID_MESSAGE" + }, + { + "value": "TEXT_UNREACHABLE", + "name": "TEXT_UNREACHABLE" + }, + { + "value": "TEXT_CARRIER_UNREACHABLE", + "name": "TEXT_CARRIER_UNREACHABLE" + }, + { + "value": "TEXT_BLOCKED", + "name": "TEXT_BLOCKED" + }, + { + "value": "TEXT_CARRIER_BLOCKED", + "name": "TEXT_CARRIER_BLOCKED" + }, + { + "value": "TEXT_SPAM", + "name": "TEXT_SPAM" + }, + { + "value": "TEXT_UNKNOWN", + "name": "TEXT_UNKNOWN" + }, + { + "value": "TEXT_TTL_EXPIRED", + "name": "TEXT_TTL_EXPIRED" + }, + { + "value": "VOICE_ALL", + "name": "VOICE_ALL" + }, + { + "value": "VOICE_INITIATED", + "name": "VOICE_INITIATED" + }, + { + "value": "VOICE_RINGING", + "name": "VOICE_RINGING" + }, + { + "value": "VOICE_ANSWERED", + "name": "VOICE_ANSWERED" + }, + { + "value": "VOICE_COMPLETED", + "name": "VOICE_COMPLETED" + }, + { + "value": "VOICE_BUSY", + "name": "VOICE_BUSY" + }, + { + "value": "VOICE_NO_ANSWER", + "name": "VOICE_NO_ANSWER" + }, + { + "value": "VOICE_FAILED", + "name": "VOICE_FAILED" + }, + { + "value": "VOICE_TTL_EXPIRED", + "name": "VOICE_TTL_EXPIRED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#FieldPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9_\\.]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#FieldPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#FieldRequirement": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REQUIRED", + "name": "REQUIRED" + }, + { + "value": "CONDITIONAL", + "name": "CONDITIONAL" + }, + { + "value": "OPTIONAL", + "name": "OPTIONAL" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#FieldType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SELECT", + "name": "SELECT" + }, + { + "value": "TEXT", + "name": "TEXT" + }, + { + "value": "ATTACHMENT", + "name": "ATTACHMENT" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#FilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\.:A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + }, + "RequestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The API encountered an unexpected error and couldn't complete the request. You might\n be able to successfully issue the request again in the future.
", + "smithy.api#error": "server", + "smithy.api#retryable": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[A-Z]{2}$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#Keyword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[ \\S]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AUTOMATIC_RESPONSE", + "name": "AUTOMATIC_RESPONSE" + }, + { + "value": "OPT_OUT", + "name": "OPT_OUT" + }, + { + "value": "OPT_IN", + "name": "OPT_IN" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for keywords that meet a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "keyword-action", + "name": "KEYWORD_ACTION" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordInformation": { + "type": "structure", + "members": { + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "traits": { + "smithy.api#documentation": "The keyword as a string.
", + "smithy.api#required": {} + } + }, + "KeywordMessage": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "traits": { + "smithy.api#documentation": "A custom message that can be used with the keyword.
", + "smithy.api#required": {} + } + }, + "KeywordAction": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "traits": { + "smithy.api#documentation": "The action to perform for the keyword.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for all keywords in a pool.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination": { + "type": "structure", + "members": { + "IamRoleArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of an Amazon Identity and Access Management (IAM) role that is able to write\n event data to an Amazon Firehose destination.
", + "smithy.api#required": {} + } + }, + "DeliveryStreamArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeliveryStreamArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the delivery stream.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#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\n destination.
\nEvent destinations, such as Kinesis Data Firehose, are associated with configuration\n sets, which enable you to publish message sending events.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#LanguageCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DE_DE", + "name": "DE_DE" + }, + { + "value": "EN_GB", + "name": "EN_GB" + }, + { + "value": "EN_US", + "name": "EN_US" + }, + { + "value": "ES_419", + "name": "ES_419" + }, + { + "value": "ES_ES", + "name": "ES_ES" + }, + { + "value": "FR_CA", + "name": "FR_CA" + }, + { + "value": "FR_FR", + "name": "FR_FR" + }, + { + "value": "IT_IT", + "name": "IT_IT" + }, + { + "value": "JA_JP", + "name": "JA_JP" + }, + { + "value": "KO_KR", + "name": "KO_KR" + }, + { + "value": "PT_BR", + "name": "PT_BR" + }, + { + "value": "ZH_CN", + "name": "ZH_CN" + }, + { + "value": "ZH_TW", + "name": "ZH_TW" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all associated origination identities in your pool.
\nIf you specify filters, the output includes information for only those origination\n identities that meet the filter criteria.
", + "smithy.api#paginated": { + "items": "OriginationIdentities" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterList", + "traits": { + "smithy.api#documentation": "An array of PoolOriginationIdentitiesFilter objects to filter the results..
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesResult": { + "type": "structure", + "members": { + "PoolArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pool.
" + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique PoolId of the pool.
" + } + }, + "OriginationIdentities": { + "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadataList", + "traits": { + "smithy.api#documentation": "An array of any OriginationIdentityMetadata objects.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retreive all of the origination identies that are associated with a registration.
", + "smithy.api#paginated": { + "items": "RegistrationAssociations" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociationsRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilterList", + "traits": { + "smithy.api#documentation": "An array of RegistrationAssociationFilter to apply to the results that are returned.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociationsResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "RegistrationAssociations": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationMetadataList", + "traits": { + "smithy.api#documentation": "An array of RegistrationAssociationMetadata objects.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List all tags associated with a resource.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to query for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#LogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#MaxPrice": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 8 + }, + "smithy.api#pattern": "^[0-9]{0,2}\\.[0-9]{1,5}$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#MessageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TRANSACTIONAL", + "name": "TRANSACTIONAL" + }, + { + "value": "PROMOTIONAL", + "name": "PROMOTIONAL" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#MessageTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType" + }, + "traits": { + "smithy.api#length": { + "max": 2 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000000000 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#NonEmptyTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#NumberCapability": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SMS", + "name": "SMS" + }, + { + "value": "VOICE", + "name": "VOICE" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapability" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#NumberStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "ASSOCIATING", + "name": "ASSOCIATING" + }, + { + "value": "DISASSOCIATING", + "name": "DISASSOCIATING" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#NumberType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SHORT_CODE", + "name": "SHORT_CODE" + }, + { + "value": "LONG_CODE", + "name": "LONG_CODE" + }, + { + "value": "TOLL_FREE", + "name": "TOLL_FREE" + }, + { + "value": "TEN_DLC", + "name": "TEN_DLC" + }, + { + "value": "SIMULATOR", + "name": "SIMULATOR" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListInformation": { + "type": "structure", + "members": { + "OptOutListArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList.
", + "smithy.api#required": {} + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the OutOutList was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for all OptOutList in an Amazon Web Services account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for opted out numbers that meet a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "end-user-opted-out", + "name": "END_USER_OPTED_OUT" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformation": { + "type": "structure", + "members": { + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that is opted out.
", + "smithy.api#required": {} + } + }, + "OptedOutTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the op tout occurred, in UNIX epoch time format.
", + "smithy.api#required": {} + } + }, + "EndUserOptedOut": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is set to true if it was the end recipient that opted out.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for an opted out number in an Amazon Web Services account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata": { + "type": "structure", + "members": { + "OriginationIdentityArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the origination identity.
", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the origination identity.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", + "smithy.api#required": {} + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number in E.164 format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata for an origination identity associated with a pool.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^\\+?[1-9][0-9]{1,18}$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for a phone number that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "status", + "name": "STATUS" + }, + { + "value": "iso-country-code", + "name": "ISO_COUNTRY_CODE" + }, + { + "value": "message-type", + "name": "MESSAGE_TYPE" + }, + { + "value": "number-capability", + "name": "NUMBER_CAPABILITY" + }, + { + "value": "number-type", + "name": "NUMBER_TYPE" + }, + { + "value": "two-way-enabled", + "name": "TWO_WAY_ENABLED" + }, + { + "value": "self-managed-opt-outs-enabled", + "name": "SELF_MANAGED_OPT_OUTS_ENABLED" + }, + { + "value": "opt-out-list-name", + "name": "OPT_OUT_LIST_NAME" + }, + { + "value": "deletion-protection-enabled", + "name": "DELETION_PROTECTION_ENABLED" + }, + { + "value": "two-way-channel-arn", + "name": "TWO_WAY_CHANNEL_ARN" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformation": { + "type": "structure", + "members": { + "PhoneNumberArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the phone number.
", + "smithy.api#required": {} + } + }, + "PhoneNumberId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the phone number.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number in E.164 format.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "traits": { + "smithy.api#documentation": "The current status of the phone number.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", + "smithy.api#required": {} + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", + "traits": { + "smithy.api#documentation": "The type of phone number.
", + "smithy.api#required": {} + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The price, in US dollars, to lease the phone number.
", + "smithy.api#required": {} + } + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients using the TwoWayChannelArn.
", + "smithy.api#required": {} + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out request. For more information see Self-managed opt-outs\n
", + "smithy.api#required": {} + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList associated with the phone number.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true the phone number can't be deleted.
", + "smithy.api#required": {} + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the pool associated with the phone number.
" + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for a phone number, in E.164 format, in an Amazon Web Services account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PinpointSMSVoiceV2": { + "type": "service", + "version": "2022-03-31", + "operations": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentity" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSet" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateEventDestination" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateOptOutList" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreatePool" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistration" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociation" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachment" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersion" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageType" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestination" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeletePool" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistration" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachment" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValue" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverride" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributes" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimits" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSets" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywords" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbers" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutLists" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbers" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePools" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachments" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitions" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValues" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrations" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitions" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitions" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersions" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIds" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimits" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbers" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociations" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResource" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#PutKeyword" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValue" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCode" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessage" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverride" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersion" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#TagResource" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UntagResource" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestination" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePool" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumber" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Pinpoint SMS Voice V2", + "endpointPrefix": "sms-voice", + "arnNamespace": "sms-voice" + }, + "aws.auth#sigv4": { + "name": "sms-voice" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.\n This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.
\nAmazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The Amazon Pinpoint SMS and\n Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels and supplements the resources provided by the Amazon Pinpoint\n API.
\nIf you're new to Amazon Pinpoint, it's also helpful to review the \n Amazon Pinpoint Developer Guide. The Amazon Pinpoint\n Developer Guide provides tutorials, code samples, and procedures that\n demonstrate how to use Amazon Pinpoint features programmatically and how to integrate\n Amazon Pinpoint functionality into mobile apps and other types of applications.\n The guide also provides key information, such as Amazon Pinpoint integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.
\n\n Regional availability\n
\nThe Amazon Pinpoint SMS and Voice, version 2 API Reference is\n available in several Amazon Web Services Regions and it provides an endpoint for each of\n these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see Amazon Web Services Service Endpoints and Amazon Pinpoint\n endpoints and quotas in the Amazon Web Services General Reference. To\n learn more about Amazon Web Services Regions, see Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.
\nIn each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These\n Availability Zones enable us to provide very high levels of availability and redundancy,\n while also minimizing latency. To learn more about the number of Availability Zones that\n are available in each Region, see Amazon Web Services\n Global Infrastructure.\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.api#title": "Amazon Pinpoint SMS Voice V2", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" }, true ] @@ -4703,11 +7134,2879 @@ } } }, - "com.amazonaws.pinpointsmsvoicev2#PoolFilter": { + "com.amazonaws.pinpointsmsvoicev2#PoolFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for a pool that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "status", + "name": "STATUS" + }, + { + "value": "message-type", + "name": "MESSAGE_TYPE" + }, + { + "value": "two-way-enabled", + "name": "TWO_WAY_ENABLED" + }, + { + "value": "self-managed-opt-outs-enabled", + "name": "SELF_MANAGED_OPT_OUTS_ENABLED" + }, + { + "value": "opt-out-list-name", + "name": "OPT_OUT_LIST_NAME" + }, + { + "value": "shared-routes-enabled", + "name": "SHARED_ROUTES_ENABLED" + }, + { + "value": "deletion-protection-enabled", + "name": "DELETION_PROTECTION_ENABLED" + }, + { + "value": "two-way-channel-arn", + "name": "TWO_WAY_CHANNEL_ARN" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolInformation": { + "type": "structure", + "members": { + "PoolArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pool.
", + "smithy.api#required": {} + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the pool.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", + "traits": { + "smithy.api#documentation": "The current status of the pool.
", + "smithy.api#required": {} + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true you can receive incoming text messages from your end recipients using\n the TwoWayChannelArn.
", + "smithy.api#required": {} + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to false, an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out requests. For more information see Self-managed opt-outs\n
", + "smithy.api#required": {} + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList associated with the pool.
", + "smithy.api#required": {} + } + }, + "SharedRoutesEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Allows you to enable shared routes on your pool.
\nBy default, this is set to False. If you set this value to\n True, your messages are sent using phone numbers or sender IDs\n (depending on the country) that are shared with other Amazon Pinpoint users. In some\n countries, such as the United States, senders aren't allowed to use shared routes and\n must use a dedicated phone number or short code.
When set to true the pool can't be deleted.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for a pool in an Amazon Web Services account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about origination identities associated with a pool that meets a specified\n criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "iso-country-code", + "name": "ISO_COUNTRY_CODE" + }, + { + "value": "number-capability", + "name": "NUMBER_CAPABILITY" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutKeyword": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutKeywordResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a keyword configuration on an origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest": { + "type": "structure", + "members": { + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", + "traits": { + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", + "smithy.api#required": {} + } + }, + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "traits": { + "smithy.api#documentation": "The new keyword to add.
", + "smithy.api#required": {} + } + }, + "KeywordMessage": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "traits": { + "smithy.api#documentation": "The message associated with the keyword.
", + "smithy.api#required": {} + } + }, + "KeywordAction": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "traits": { + "smithy.api#documentation": "The action to perform for the new keyword when it is received.
\nAUTOMATIC_RESPONSE: A message is sent to the recipient.
\nOPT_OUT: Keeps the recipient from receiving future messages.
\nOPT_IN: The recipient wants to receive future messages.
\nThe PhoneNumberArn or PoolArn that the keyword was associated with.
" + } + }, + "OriginationIdentity": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" + } + }, + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "traits": { + "smithy.api#documentation": "The keyword that was added.
" + } + }, + "KeywordMessage": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "traits": { + "smithy.api#documentation": "The message associated with the keyword.
" + } + }, + "KeywordAction": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "traits": { + "smithy.api#documentation": "The action to perform when the keyword is used.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an opted out destination phone number in the opt-out list.
\nIf the destination phone number isn't valid or if the specified opt-out list doesn't\n exist, an error is returned.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberRequest": { + "type": "structure", + "members": { + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The OptOutListName or OptOutListArn to add the phone number to.
", + "smithy.api#required": {} + } + }, + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number to add to the OptOutList in E.164 format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberResult": { + "type": "structure", + "members": { + "OptOutListArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The OptOutListArn that the phone number was removed from.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The OptOutListName that the phone number was removed from.
" + } + }, + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that was added to the OptOutList.
" + } + }, + "OptedOutTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the phone number was added to the OptOutList, in UNIX epoch time format.
" + } + }, + "EndUserOptedOut": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if it was the end user who requested their phone number be removed.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValue": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValueRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValueResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a field value for a registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValueRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} + } + }, + "SelectChoices": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList", + "traits": { + "smithy.api#documentation": "An array of values for the form field.
" + } + }, + "TextValue": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValue", + "traits": { + "smithy.api#documentation": "The text data for a free form field.
" + } + }, + "RegistrationAttachmentId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValueResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} + } + }, + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} + } + }, + "SelectChoices": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList", + "traits": { + "smithy.api#documentation": "An array of values for the form field.
" + } + }, + "TextValue": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValue", + "traits": { + "smithy.api#documentation": "The text data for a free form field.
" + } + }, + "RegistrationAttachmentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationBehavior": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASSOCIATE_BEFORE_SUBMIT", + "name": "ASSOCIATE_BEFORE_SUBMIT" + }, + { + "value": "ASSOCIATE_ON_APPROVAL", + "name": "ASSOCIATE_ON_APPROVAL" + }, + { + "value": "ASSOCIATE_AFTER_COMPLETE", + "name": "ASSOCIATE_AFTER_COMPLETE" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registrations that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "resource-type", + "name": "RESOURCE_TYPE" + }, + { + "value": "iso-country-code", + "name": "ISO_COUNTRY_CODE" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationMetadata": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The origination identity type.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number associated with the registration in E.164 format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for the origination identity that is associated with the registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationMetadata" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registration attachments that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "attachment-status", + "name": "ATTACHMENT_STATUS" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentsInformation": { + "type": "structure", + "members": { + "RegistrationAttachmentArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration attachment.
", + "smithy.api#required": {} + } + }, + "RegistrationAttachmentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
", + "smithy.api#required": {} + } + }, + "AttachmentStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus", + "traits": { + "smithy.api#documentation": "The status of the registration attachment.
\n\n UPLOAD_IN_PROGRESS The attachment is being uploaded.
\n UPLOAD_COMPLETE The attachment has been uploaded.
\n UPLOAD_FAILED The attachment failed to uploaded.
\n DELETED The attachment has been deleted..
A description of why the upload didn't successfully complete.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration attachment was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information on the specified registration attachments.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentsInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentsInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationDeniedReasonInformation": { + "type": "structure", + "members": { + "Reason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason a registration was rejected.
", + "smithy.api#required": {} + } + }, + "ShortDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A short description of the rejection reason.
", + "smithy.api#required": {} + } + }, + "LongDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A long description of the rejection reason.
" + } + }, + "DocumentationTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the document.
" + } + }, + "DocumentationLink": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The link to the document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the reason a registration was rejected.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationDeniedReasonInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationDeniedReasonInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationDisassociationBehavior": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DISASSOCIATE_ALL_CLOSES_REGISTRATION", + "name": "DISASSOCIATE_ALL_CLOSES_REGISTRATION" + }, + { + "value": "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION", + "name": "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION" + }, + { + "value": "DELETE_REGISTRATION_DISASSOCIATES", + "name": "DELETE_REGISTRATION_DISASSOCIATES" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDefinition": { + "type": "structure", + "members": { + "SectionPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath", + "traits": { + "smithy.api#documentation": "The section path of the field.
", + "smithy.api#required": {} + } + }, + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} + } + }, + "FieldType": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldType", + "traits": { + "smithy.api#documentation": "The type of field.
", + "smithy.api#required": {} + } + }, + "FieldRequirement": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldRequirement", + "traits": { + "smithy.api#documentation": "Specifies if the field for the registration form is required, conditional or optional.
", + "smithy.api#required": {} + } + }, + "SelectValidation": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectValidation", + "traits": { + "smithy.api#documentation": "The validation rules for a select field.
" + } + }, + "TextValidation": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValidation", + "traits": { + "smithy.api#documentation": "The validation rules for a text field.
" + } + }, + "DisplayHints": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDisplayHints", + "traits": { + "smithy.api#documentation": "An array of RegistrationFieldDisplayHints objects for the field.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a description of the specified field.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDefinition" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDisplayHints": { + "type": "structure", + "members": { + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the display hint.
", + "smithy.api#required": {} + } + }, + "ShortDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A short description of the display hint.
", + "smithy.api#required": {} + } + }, + "LongDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A full description of the display hint.
" + } + }, + "DocumentationTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the document the display hint is associated with.
" + } + }, + "DocumentationLink": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The link to the document the display hint is associated with.
" + } + }, + "SelectOptionDescriptions": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectOptionDescriptionsList", + "traits": { + "smithy.api#documentation": "An array of SelectOptionDescription objects.
" + } + }, + "TextValidationDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The validation rules for the text field.
" + } + }, + "ExampleTextValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Example text of what the value of a field should contain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides help information on the registration field.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldValueInformation": { + "type": "structure", + "members": { + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} + } + }, + "SelectChoices": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList", + "traits": { + "smithy.api#documentation": "An array of values for the form field.
" + } + }, + "TextValue": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValue", + "traits": { + "smithy.api#documentation": "The text data for a free form field.
" + } + }, + "RegistrationAttachmentId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
" + } + }, + "DeniedReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of why the registration was denied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the values of the specified field.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldValueInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldValueInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registrations that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "registration-type", + "name": "REGISTRATION_TYPE" + }, + { + "value": "registration-status", + "name": "REGISTRATION_STATUS" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationInformation": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "RegistrationStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus", + "traits": { + "smithy.api#documentation": "The status of the registration.
\n\n CREATED: Your registration is created but not submitted.
\n SUBMITTED: Your registration has been submitted and is awaiting review.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n PROVISIONING: Your registration has been approved and your origination identity is being created.
\n COMPLETE: Your registration has been approved and and your origination identity has been created.
\n REQUIRES_UPDATES: You must fix your registration and resubmit it.
\n CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
\n DELETED: The registration has been deleted.
The current version number of the registration.
", + "smithy.api#required": {} + } + }, + "ApprovedVersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration that was approved.
" + } + }, + "LatestDeniedVersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The latest version number of the registration that was denied.
" + } + }, + "AdditionalAttributes": { + "target": "com.amazonaws.pinpointsmsvoicev2#StringMap", + "traits": { + "smithy.api#documentation": "Metadata about a given registration which is specific to that registration type.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the requested registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDefinition": { + "type": "structure", + "members": { + "SectionPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath", + "traits": { + "smithy.api#documentation": "The path to the section of the registration.
", + "smithy.api#required": {} + } + }, + "DisplayHints": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDisplayHints", + "traits": { + "smithy.api#documentation": "The path to the section of the registration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information on the specified section definition.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDefinition" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDisplayHints": { + "type": "structure", + "members": { + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the display hint.
", + "smithy.api#required": {} + } + }, + "ShortDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A short description of the display hint.
", + "smithy.api#required": {} + } + }, + "LongDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A full description of the display hint.
" + } + }, + "DocumentationTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the document the display hint is associated with.
" + } + }, + "DocumentationLink": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The link to the document the display hint is associated with.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides help information on the registration section.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "SUBMITTED", + "name": "SUBMITTED" + }, + { + "value": "REVIEWING", + "name": "REVIEWING" + }, + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "REQUIRES_UPDATES", + "name": "REQUIRES_UPDATES" + }, + { + "value": "CLOSED", + "name": "CLOSED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9_]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDefinition": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "SupportedAssociations": { + "target": "com.amazonaws.pinpointsmsvoicev2#SupportedAssociationList", + "traits": { + "smithy.api#documentation": "The supported association behavior for the registration type.
" + } + }, + "DisplayHints": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDisplayHints", + "traits": { + "smithy.api#documentation": "Provides help information on the registration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information on the supported registration type.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDefinition" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDisplayHints": { + "type": "structure", + "members": { + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the display hint.
", + "smithy.api#required": {} + } + }, + "ShortDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A short description of the display hint.
" + } + }, + "LongDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A full description of the display hint.
" + } + }, + "DocumentationTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the document the display hint is associated with.
" + } + }, + "DocumentationLink": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The link to the document the display hint is associated with.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides help information on the registration type.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registration types that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "supported-association-resource-type", + "name": "SUPPORTED_ASSOCIATION_RESOURCE_TYPE" + }, + { + "value": "supported-association-iso-country-code", + "name": "SUPPORTED_ASSOCIATION_ISO_COUNTRY_CODE" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registration versions that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "registration-version-status", + "name": "REGISTRATION_VERSION_STATUS" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionInformation": { + "type": "structure", + "members": { + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationVersionStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the registration.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n 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.
", + "smithy.api#required": {} + } + }, + "DeniedReasons": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationDeniedReasonInformationList", + "traits": { + "smithy.api#documentation": "An array of RegistrationDeniedReasonInformation objects.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the specified version of the registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100000 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DRAFT", + "name": "DRAFT" + }, + { + "value": "SUBMITTED", + "name": "SUBMITTED" + }, + { + "value": "REVIEWING", + "name": "REVIEWING" + }, + { + "value": "APPROVED", + "name": "APPROVED" + }, + { + "value": "DISCARDED", + "name": "DISCARDED" + }, + { + "value": "DENIED", + "name": "DENIED" + }, + { + "value": "REVOKED", + "name": "REVOKED" + }, + { + "value": "ARCHIVED", + "name": "ARCHIVED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatusHistory": { + "type": "structure", + "members": { + "DraftTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the draft state, in UNIX epoch time format.
", + "smithy.api#required": {} + } + }, + "SubmittedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the submitted state, in UNIX epoch time format.
" + } + }, + "ReviewingTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the reviewing state, in UNIX epoch time format.
" + } + }, + "ApprovedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the approved state, in UNIX epoch time format.
" + } + }, + "DiscardedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the discarded state, in UNIX epoch time format.
" + } + }, + "DeniedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the denied state, in UNIX epoch time format.
" + } + }, + "RevokedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the revoked state, in UNIX epoch time format.
" + } + }, + "ArchivedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the archived state, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Releases an existing origination phone number in your account. Once released, a phone\n number is no longer available for sending messages.
\nIf the origination phone number has deletion protection enabled or is associated with\n a pool, an error is returned.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", + "traits": { + "smithy.api#documentation": "The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberResult": { + "type": "structure", + "members": { + "PhoneNumberArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberArn of the phone number that was released.
" + } + }, + "PhoneNumberId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberId of the phone number that was released.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that was released.
" + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "traits": { + "smithy.api#documentation": "The current status of the request.
" + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The message type that was associated with the phone number.
" + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Specifies if the number could be used for text messages, voice, or both.
" + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", + "traits": { + "smithy.api#documentation": "The type of number that was released.
" + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price of the phone number, in US dollars.
" + } + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the TwoWayChannel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList that was associated with the phone number.
" + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderId": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderIdRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderIdResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Releases an existing sender ID in your account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderIdRequest": { + "type": "structure", + "members": { + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn", + "traits": { + "smithy.api#documentation": "The sender ID to release.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderIdResult": { + "type": "structure", + "members": { + "SenderIdArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", + "smithy.api#required": {} + } + }, + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The sender ID that was released.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + }, + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price, in US dollars, to lease the sender ID.
", + "smithy.api#required": {} + } + }, + "Registered": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "True if the sender ID is registered.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Request an origination phone number for use in your account. For more information on\n phone number request see Requesting a\n number in the Amazon Pinpoint User Guide.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest": { + "type": "structure", + "members": { + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages, or both.
", + "smithy.api#required": {} + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType", + "traits": { + "smithy.api#documentation": "The type of phone number to request.
", + "smithy.api#required": {} + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the OptOutList to associate with the phone number. You can use the\n OptOutListName or OptOutListArn.
" + } + }, + "PoolId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "traits": { + "smithy.api#documentation": "The pool to associated with the phone number. You can use the PoolId or PoolArn.
" + } + }, + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "Use this field to attach your phone number for an external registration\n process.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be\n deleted.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of tags (key and value pairs) associate with the requested phone number.\n
" + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberResult": { + "type": "structure", + "members": { + "PhoneNumberArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the requested phone number.
" + } + }, + "PhoneNumberId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the new phone number.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The new phone number that was requested.
" + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "traits": { + "smithy.api#documentation": "The current status of the request.
" + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages or both.\n
" + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType", + "traits": { + "smithy.api#documentation": "The type of number that was released.
" + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price, in US dollars, to lease the phone number.
" + } + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The ARN used to identify the two way channel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList that is associated with the requested phone number.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the pool associated with the phone number
" + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of key and value pair tags that are associated with the phone number.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestSenderId": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestSenderIdRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestSenderIdResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Request a new sender ID that doesn't require registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestSenderIdRequest": { + "type": "structure", + "members": { + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The sender ID string to request.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + }, + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the sender ID.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestSenderIdResult": { + "type": "structure", + "members": { + "SenderIdArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", + "smithy.api#required": {} + } + }, + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The sender ID that was requested.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + }, + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price, in US dollars, to lease the sender ID.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
", + "smithy.api#required": {} + } + }, + "Registered": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "True if the sender ID is registered.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the sender ID.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LONG_CODE", + "name": "LONG_CODE" + }, + { + "value": "TOLL_FREE", + "name": "TOLL_FREE" + }, + { + "value": "TEN_DLC", + "name": "TEN_DLC" + }, + { + "value": "SIMULATOR", + "name": "SIMULATOR" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#ResourceIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + }, + "ResourceType": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceType", + "traits": { + "smithy.api#documentation": "The type of resource that caused the exception.
" + } + }, + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A requested resource couldn't be found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "account", + "name": "ACCOUNT" + }, + { + "value": "phone-number", + "name": "PHONE_NUMBER" + }, + { + "value": "sender-id", + "name": "SENDER_ID" + }, + { + "value": "pool", + "name": "POOL" + }, + { + "value": "configuration-set", + "name": "CONFIGURATION_SET" + }, + { + "value": "opt-out-list", + "name": "OPT_OUT_LIST" + }, + { + "value": "event-destination", + "name": "EVENT_DESTINATION" + }, + { + "value": "keyword", + "name": "KEYWORD" + }, + { + "value": "opted-out-number", + "name": "OPTED_OUT_NUMBER" + }, + { + "value": "registration", + "name": "REGISTRATION" + }, + { + "value": "registration-attachment", + "name": "REGISTRATION_ATTACHMENT" + }, + { + "value": "verified-destination-number", + "name": "VERIFIED_DESTINATION_NUMBER" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#SectionPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9_]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SectionPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectChoice": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoice" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectOptionDescription": { + "type": "structure", + "members": { + "Option": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the option.
", + "smithy.api#required": {} + } + }, + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the select option.
" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the option meaning.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A description of each select option.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectOptionDescriptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectOptionDescription" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectValidation": { + "type": "structure", + "members": { + "MinChoices": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The minimum number of choices for the select.
", + "smithy.api#required": {} + } + }, + "MaxChoices": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of choices for the select.
", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.pinpointsmsvoicev2#StringList", + "traits": { + "smithy.api#documentation": "An array of strings for the possible selection options.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Validation rules for a select field.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCode": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCodeRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCodeResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Before you can send test messages to a verified destination phone number you need to\n opt-in the verified destination phone number. Creates a new text message with a\n 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.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCodeRequest": { + "type": "structure", + "members": { + "VerifiedDestinationNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", + "smithy.api#required": {} + } + }, + "VerificationChannel": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationChannel", + "traits": { + "smithy.api#documentation": "Choose to send the verification code as an SMS or voice message.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#LanguageCode", + "traits": { + "smithy.api#documentation": "Choose the language to use for the message.
" + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationMessageOriginationIdentity", + "traits": { + "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + } + }, + "Context": { + "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "traits": { + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + } + }, + "DestinationCountryParameters": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters", + "traits": { + "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCodeResult": { + "type": "structure", + "members": { + "MessageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendTextMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new text message and sends it to a recipient's phone number.
\nSMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit\n depends on the destination country of your messages, as well as the type of phone number\n (origination number) that you use to send the message. For more information, see Message Parts per\n Second (MPS) limits in the Amazon Pinpoint User\n Guide.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest": { + "type": "structure", + "members": { + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The destination phone number in E.164 format.
", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity", + "traits": { + "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" + } + }, + "MessageBody": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageBody", + "traits": { + "smithy.api#documentation": "The body of the text message.
" + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are \n for messages that are critical or time-sensitive and PROMOTIONAL for messages that\n aren't critical or time-sensitive.
" + } + }, + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "traits": { + "smithy.api#documentation": "When you register a short code in the US, you must specify a program name. If you\n don’t have a US short code, omit this attribute.
" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + } + }, + "MaxPrice": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", + "traits": { + "smithy.api#documentation": "The maximum amount that you want to spend, in US dollars, per each text message part.\n A text message can contain multiple parts.
" + } + }, + "TimeToLive": { + "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", + "traits": { + "smithy.api#documentation": "How long the text message is valid for. By default this is 72 hours.
" + } + }, + "Context": { + "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "traits": { + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + } + }, + "DestinationCountryParameters": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters", + "traits": { + "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
" + } + }, + "DryRun": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendTextMessageResult": { + "type": "structure", + "members": { + "MessageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the message.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Allows you to send a request that sends a voice message through Amazon Pinpoint.\n This operation uses Amazon Polly to\n convert a text script into a voice message.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest": { + "type": "structure", + "members": { + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The destination phone number in E.164 format.
", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageOriginationIdentity", + "traits": { + "smithy.api#documentation": "The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
", + "smithy.api#required": {} + } + }, + "MessageBody": { + "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageBody", + "traits": { + "smithy.api#documentation": "The text to convert to a voice message.
" + } + }, + "MessageBodyTextType": { + "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageBodyTextType", + "traits": { + "smithy.api#documentation": "Specifies if the MessageBody field contains text or speech synthesis\n markup language (SSML).
\nTEXT: This is the default value. When used the maximum character limit is\n 3000.
\nSSML: When used the maximum character limit is 6000 including SSML\n tagging.
\nThe voice for the Amazon Polly\n service to use. By default this is set to \"MATTHEW\".
" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + } + }, + "MaxPricePerMinute": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", + "traits": { + "smithy.api#documentation": "The maximum amount to spend per voice message, in US dollars.
" + } + }, + "TimeToLive": { + "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", + "traits": { + "smithy.api#documentation": "How long the voice message is valid for. By default this is 72 hours.
" + } + }, + "Context": { + "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "traits": { + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + } + }, + "DryRun": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageResult": { + "type": "structure", + "members": { + "MessageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the message.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SenderId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 11 + }, + "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SenderIdAndCountry": { + "type": "structure", + "members": { + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier of the sender.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you want to describe. For more\n information on sender IDs see Requesting\n sender IDs for SMS messaging with Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilterName", + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterName", "traits": { "smithy.api#documentation": "The name of the attribute to filter on.
", "smithy.api#required": {} @@ -4716,19 +10015,19 @@ "Values": { "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", "traits": { - "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#documentation": "An array of values to filter for.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The information for a pool that meets a specified criteria.
" + "smithy.api#documentation": "The information for a sender ID that meets a specified criteria.
" } }, - "com.amazonaws.pinpointsmsvoicev2#PoolFilterList": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterList": { "type": "list", "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilter" + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter" }, "traits": { "smithy.api#length": { @@ -4736,247 +10035,252 @@ } } }, - "com.amazonaws.pinpointsmsvoicev2#PoolFilterName": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterName": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "status", - "name": "STATUS" - }, - { - "value": "message-type", - "name": "MESSAGE_TYPE" - }, - { - "value": "two-way-enabled", - "name": "TWO_WAY_ENABLED" - }, - { - "value": "self-managed-opt-outs-enabled", - "name": "SELF_MANAGED_OPT_OUTS_ENABLED" + "value": "sender-id", + "name": "SENDER_ID" }, { - "value": "opt-out-list-name", - "name": "OPT_OUT_LIST_NAME" + "value": "iso-country-code", + "name": "ISO_COUNTRY_CODE" }, { - "value": "shared-routes-enabled", - "name": "SHARED_ROUTES_ENABLED" + "value": "message-type", + "name": "MESSAGE_TYPE" }, { "value": "deletion-protection-enabled", "name": "DELETION_PROTECTION_ENABLED" + }, + { + "value": "registered", + "name": "REGISTERED" } ] } }, - "com.amazonaws.pinpointsmsvoicev2#PoolIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PoolInformation": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdInformation": { "type": "structure", "members": { - "PoolArn": { + "SenderIdArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pool.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", "smithy.api#required": {} } }, - "PoolId": { - "target": "smithy.api#String", + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", "traits": { - "smithy.api#documentation": "The unique identifier for the pool.
", + "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you'd like to describe.
", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The current status of the pool.
", + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", "smithy.api#required": {} } }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", "traits": { "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", "smithy.api#required": {} } }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true you can receive incoming text messages from your end recipients using\n the TwoWayChannelArn.
", - "smithy.api#required": {} - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to false, an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out requests. For more information see Self-managed opt-outs\n
", - "smithy.api#required": {} - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "MonthlyLeasingPrice": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the OptOutList associated with the pool.
", + "smithy.api#documentation": "The monthly leasing price, in US dollars.
", "smithy.api#required": {} } }, - "SharedRoutesEnabled": { + "DeletionProtectionEnabled": { "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Allows you to enable shared routes on your pool.
\nBy default, this is set to False. If you set this value to\n True, your messages are sent using phone numbers or sender IDs\n (depending on the country) that are shared with other Amazon Pinpoint users. In some\n countries, such as the United States, senders aren't allowed to use shared routes and\n must use a dedicated phone number or short code.
By default this is set to false. When set to true the sender ID can't be deleted.
", "smithy.api#required": {} } }, - "DeletionProtectionEnabled": { + "Registered": { "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to true the pool can't be deleted.
", + "smithy.api#documentation": "True if the sender ID is registered.
", "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier for the registration.
" } } }, "traits": { - "smithy.api#documentation": "The information for a pool in an Amazon Web Services account.
" + "smithy.api#documentation": "The information for all SenderIds in an Amazon Web Services account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#PoolInformationList": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdInformationList": { "type": "list", "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolInformation" + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdInformation" } }, - "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilter": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdAndCountry" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterName", - "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", - "smithy.api#required": {} - } + "Message": { + "target": "smithy.api#String" }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "Reason": { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededExceptionReason", "traits": { - "smithy.api#documentation": "An array values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The reason for the exception.
" } } }, "traits": { - "smithy.api#documentation": "Information about origination identities associated with a pool that meets a specified\n criteria.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilter" - }, - "traits": { - "smithy.api#length": { - "max": 20 - } + "smithy.api#documentation": "The request would cause a service quota to be exceeded.
", + "smithy.api#error": "client" } }, - "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterName": { + "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededExceptionReason": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "iso-country-code", - "name": "ISO_COUNTRY_CODE" + "value": "ASSOCIATIONS_PER_REGISTRATION", + "name": "ASSOCIATIONS_PER_REGISTRATION" + }, + { + "value": "CONFIGURATION_SETS_PER_ACCOUNT", + "name": "CONFIGURATION_SETS_PER_ACCOUNT" + }, + { + "value": "DAILY_DESTINATION_CALL_LIMIT", + "name": "DAILY_DESTINATION_CALL_LIMIT" + }, + { + "value": "EVENT_DESTINATIONS_PER_CONFIGURATION_SET", + "name": "EVENT_DESTINATIONS_PER_CONFIGURATION_SET" + }, + { + "value": "KEYWORDS_PER_PHONE_NUMBER", + "name": "KEYWORDS_PER_PHONE_NUMBER" + }, + { + "value": "KEYWORDS_PER_POOL", + "name": "KEYWORDS_PER_POOL" + }, + { + "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT", + "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT" + }, + { + "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE", + "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE" + }, + { + "value": "OPT_OUT_LISTS_PER_ACCOUNT", + "name": "OPT_OUT_LISTS_PER_ACCOUNT" + }, + { + "value": "ORIGINATION_IDENTITIES_PER_POOL", + "name": "ORIGINATION_IDENTITIES_PER_POOL" + }, + { + "value": "PHONE_NUMBERS_PER_ACCOUNT", + "name": "PHONE_NUMBERS_PER_ACCOUNT" }, { - "value": "number-capability", - "name": "NUMBER_CAPABILITY" - } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#PoolStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ + "value": "PHONE_NUMBERS_PER_REGISTRATION", + "name": "PHONE_NUMBERS_PER_REGISTRATION" + }, { - "value": "CREATING", - "name": "CREATING" + "value": "POOLS_PER_ACCOUNT", + "name": "POOLS_PER_ACCOUNT" }, { - "value": "ACTIVE", - "name": "ACTIVE" + "value": "REGISTRATION_ATTACHMENTS_CREATED_PER_DAY", + "name": "REGISTRATION_ATTACHMENTS_CREATED_PER_DAY" }, { - "value": "DELETING", - "name": "DELETING" + "value": "REGISTRATION_ATTACHMENTS_PER_ACCOUNT", + "name": "REGISTRATION_ATTACHMENTS_PER_ACCOUNT" + }, + { + "value": "REGISTRATION_VERSIONS_CREATED_PER_DAY", + "name": "REGISTRATION_VERSIONS_CREATED_PER_DAY" + }, + { + "value": "REGISTRATIONS_PER_ACCOUNT", + "name": "REGISTRATIONS_PER_ACCOUNT" + }, + { + "value": "SENDER_IDS_PER_ACCOUNT", + "name": "SENDER_IDS_PER_ACCOUNT" + }, + { + "value": "TAGS_PER_RESOURCE", + "name": "TAGS_PER_RESOURCE" + }, + { + "value": "VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT", + "name": "VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT" + }, + { + "value": "VERIFICATION_ATTEMPTS_PER_DAY", + "name": "VERIFICATION_ATTEMPTS_PER_DAY" } ] } }, - "com.amazonaws.pinpointsmsvoicev2#PutKeyword": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#PutKeywordResult" + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -4985,83 +10289,64 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a keyword configuration on an origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an Error is returned.
" + "smithy.api#documentation": "Sets the default message type on a configuration set.
\nChoose the category of SMS messages that you plan to send from this account. If you\n send account-related messages or time-sensitive messages such as one-time passcodes,\n choose Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeRequest": { "type": "structure", "members": { - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", - "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", - "smithy.api#required": {} - } - }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The new keyword to add.
", + "smithy.api#documentation": "The configuration set to update with a new default message type. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, - "KeywordMessage": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The message associated with the keyword.
\nAUTOMATIC_RESPONSE: A message is sent to the recipient.
\nOPT_OUT: Keeps the recipient from receiving future messages.
\nOPT_IN: The recipient wants to receive future messages.
\nThe type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", "smithy.api#required": {} } - }, - "KeywordAction": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", - "traits": { - "smithy.api#documentation": "The action to perform for the new keyword when it is received.
" - } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PutKeywordResult": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeResult": { "type": "structure", "members": { - "OriginationIdentityArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" - } - }, - "OriginationIdentity": { + "ConfigurationSetArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" - } - }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", - "traits": { - "smithy.api#documentation": "The keyword that was added.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated configuration set.
" } }, - "KeywordMessage": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The message associated with the keyword.
" + "smithy.api#documentation": "The name of the configuration set that was updated.
" } }, - "KeywordAction": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The action to perform when the keyword is used.
" + "smithy.api#documentation": "The new default message type of the configuration set.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumber": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberResult" + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdResult" }, "errors": [ { @@ -5081,95 +10366,127 @@ } ], "traits": { - "smithy.api#documentation": "Creates an opted out destination phone number in the opt-out list.
\nIf the destination phone number isn't valid or if the specified opt-out list doesn't\n exist, an Error is returned.
" + "smithy.api#documentation": "Sets default sender ID on a configuration set.
\nWhen sending a text message to a destination country that supports sender IDs, the\n default sender ID on the configuration set specified will be used if no dedicated\n origination phone numbers or registered sender IDs are available in your account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberRequest": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdRequest": { "type": "structure", "members": { - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn to add the phone number to.
", + "smithy.api#documentation": "The configuration set to updated with a new default SenderId. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, - "OptedOutNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", "traits": { - "smithy.api#documentation": "The phone number to add to the OptOutList in E.164 format.
", + "smithy.api#documentation": "The current sender ID for the configuration set. When sending a text message to a\n destination country which supports SenderIds, the default sender ID on the configuration\n set specified on SendTextMessage will be used if no dedicated\n origination phone numbers or registered SenderIds are available in your account, instead\n of a generic sender ID, such as 'NOTICE'.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdResult": { "type": "structure", "members": { - "OptOutListArn": { + "ConfigurationSetArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The OptOutListArn that the phone number was removed from.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated configuration set.
" } }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The OptOutListName that the phone number was removed from.
" + "smithy.api#documentation": "The name of the configuration set that was updated.
" } }, - "OptedOutNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", "traits": { - "smithy.api#documentation": "The phone number that was added to the OptOutList.
" + "smithy.api#documentation": "The default sender ID to set for the ConfigurationSet.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "OptedOutTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the phone number was added to the OptOutList, in UNIX epoch time format.
" - } + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - "EndUserOptedOut": { - "target": "smithy.api#PrimitiveBoolean", + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sets an account level monthly spend limit override for sending text messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
This is true if it was the end user who requested their phone number be removed.\n
" + "smithy.api#documentation": "The new monthly limit to enforce on text messages.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#RegistrationId": { - "type": "string", + "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideResult": { + "type": "structure", + "members": { + "MonthlyLimit": { + "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "traits": { + "smithy.api#documentation": "The current monthly limit to enforce on sending text messages.
" + } + } + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^\\S+$" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber": { + "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverride": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberResult" + "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -5178,119 +10495,145 @@ } ], "traits": { - "smithy.api#documentation": "Releases an existing origination phone number in your account. Once released, a phone\n number is no longer available for sending messages.
\nIf the origination phone number has deletion protection enabled or is associated with\n a pool, an Error is returned.
" + "smithy.api#documentation": "Sets an account level monthly spend limit override for sending voice messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
The new monthly limit to enforce on voice messages.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideResult": { + "type": "structure", + "members": { + "MonthlyLimit": { + "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "traits": { + "smithy.api#documentation": "The current monthly limit to enforce on sending voice messages.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberRequest": { + "com.amazonaws.pinpointsmsvoicev2#SnsDestination": { "type": "structure", "members": { - "PhoneNumberId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", + "TopicArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#SnsTopicArn", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to\n publish events to.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "An object that defines an Amazon SNS destination for events. You can use\n Amazon SNS to send notification when certain events occur.
" } }, - "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#SnsTopicArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SpendLimit": { "type": "structure", "members": { - "PhoneNumberArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PhoneNumberArn of the phone number that was released.
" - } - }, - "PhoneNumberId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PhoneNumberId of the phone number that was released.
" - } - }, - "PhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", - "traits": { - "smithy.api#documentation": "The phone number that was released.
" - } - }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", - "traits": { - "smithy.api#documentation": "The current status of the request.
" - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The message type that was associated with the phone number.
" - } - }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", - "traits": { - "smithy.api#documentation": "Specifies if the number could be used for text messages, voice, or both.
" - } - }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", - "traits": { - "smithy.api#documentation": "The type of number that was released.
" - } - }, - "MonthlyLeasingPrice": { - "target": "smithy.api#String", + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimitName", "traits": { - "smithy.api#documentation": "The monthly price of the phone number, in US dollars.
" + "smithy.api#documentation": "The name for the SpendLimit.
", + "smithy.api#required": {} } }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "EnforcedLimit": { + "target": "smithy.api#PrimitiveLong", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum amount of money, in US dollars, that you want to be able to spend sending\n messages each month. This value has to be less than or equal to the amount in\n MaxLimit. To use this custom limit, Overridden must be set\n to true.
The Amazon Resource Name (ARN) of the TwoWayChannel.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum amount of money that you are able to spend to send messages each month,\n in US dollars.
", + "smithy.api#required": {} } }, - "SelfManagedOptOutsEnabled": { + "Overridden": { "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { - "smithy.api#documentation": "The name of the OptOutList that was associated with the phone number.
" - } - }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + "smithy.api#documentation": "When set to True, the value that has been specified in the\n EnforcedLimit is used to determine the maximum amount in US dollars\n that can be spent to send messages each month, in US dollars.
Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages. For more information on increasing your monthly spend limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" } }, - "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumber": { + "com.amazonaws.pinpointsmsvoicev2#SpendLimitList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimit" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SpendLimitName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", + "name": "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT" + }, + { + "value": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", + "name": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#StringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.pinpointsmsvoicev2#StringMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersion": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersionRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberResult" + "target": "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersionResult" }, "errors": [ { @@ -5305,9 +10648,6 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -5316,303 +10656,343 @@ } ], "traits": { - "smithy.api#documentation": "Request an origination phone number for use in your account. For more information on\n phone number request see Requesting a\n number in the Amazon Pinpoint User Guide.
" + "smithy.api#documentation": "Submit the specified registration for review and approval.
" } }, - "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest": { + "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersionRequest": { "type": "structure", "members": { - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", - "smithy.api#required": {} - } - }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", - "traits": { - "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages, or both.
", - "smithy.api#required": {} - } - }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType", - "traits": { - "smithy.api#documentation": "The type of phone number to request.
", - "smithy.api#required": {} - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", - "traits": { - "smithy.api#documentation": "The name of the OptOutList to associate with the phone number. You can use the\n OutOutListName or OptPutListArn.
" - } - }, - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", - "traits": { - "smithy.api#documentation": "The pool to associated with the phone number. You can use the PoolId or PoolArn.
" - } - }, "RegistrationId": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationId", - "traits": { - "smithy.api#documentation": "Use this field to attach your phone number for an external registration\n process.
" - } - }, - "DeletionProtectionEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be\n deleted.
" - } - }, - "Tags": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagList", - "traits": { - "smithy.api#documentation": "An array of tags (key and value pairs) associate with the requested phone number.\n
" - } - }, - "ClientToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersionResult": { "type": "structure", "members": { - "PhoneNumberArn": { + "RegistrationArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the requested phone number.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "PhoneNumberId": { + "RegistrationId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the new phone number.
" - } - }, - "PhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", - "traits": { - "smithy.api#documentation": "The new phone number that was requested.
" - } - }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", - "traits": { - "smithy.api#documentation": "The current status of the request.
" - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", "traits": { - "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages or both.\n
" + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} } }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType", + "RegistrationVersionStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", "traits": { - "smithy.api#documentation": "The type of number that was released.
" + "smithy.api#documentation": "The status of the registration version.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The monthly price, in US dollars, to lease the phone number.
" + "smithy.api#documentation": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
", + "smithy.api#required": {} } - }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SupportedAssociation": { + "type": "structure", + "members": { + "ResourceType": { + "target": "smithy.api#String", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "Defines the behavior of when an origination identity and registration can be associated with each other.
", + "smithy.api#required": {} } }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The ARN used to identify the two way channel.
" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" } }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "AssociationBehavior": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationBehavior", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "The association behavior.
\n\n ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
\n ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.
\n 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 name of the OptOutList that is associated with the requested phone number.
" + "smithy.api#documentation": "The disassociation behavior.
\n\n DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.
\n DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.
\n 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.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SupportedAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SupportedAssociation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagKey", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" + "smithy.api#documentation": "The key identifier, or name, of the tag.
", + "smithy.api#required": {} } }, - "PoolId": { - "target": "smithy.api#String", + "Value": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagValue", "traits": { - "smithy.api#documentation": "The unique identifier of the pool associated with the phone number
" + "smithy.api#documentation": "The string value associated with the key of the tag.
", + "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#documentation": "The list of tags to be added to the specified topic.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 }, - "Tags": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#Tag" + }, + "traits": { + "smithy.api#length": { + "max": 200 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagResourceResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS\n Voice, version 2 resource. When you specify an existing tag key, the value is\n overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag\n consists of a key and an optional value. Tag keys must be unique per resource. For more\n information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", "traits": { - "smithy.api#documentation": "An array of key and value pair tags that are associated with the phone number.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#NonEmptyTagList", "traits": { - "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType": { + "com.amazonaws.pinpointsmsvoicev2#TagResourceResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagValue": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "LONG_CODE", - "name": "LONG_CODE" - }, - { - "value": "TOLL_FREE", - "name": "TOLL_FREE" - }, - { - "value": "TEN_DLC", - "name": "TEN_DLC" - } - ] + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^.*$" } }, - "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException": { + "com.amazonaws.pinpointsmsvoicev2#TextMessageBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/\\+-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TextValidation": { "type": "structure", "members": { - "Message": { - "target": "smithy.api#String" + "MinLength": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The minimum number of characters for the text field.
", + "smithy.api#required": {} + } }, - "ResourceType": { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceType", + "MaxLength": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The type of resource that caused the exception.
" + "smithy.api#documentation": "The maximum number of characters for the text field.
", + "smithy.api#required": {} } }, - "ResourceId": { + "Pattern": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the resource.
" + "smithy.api#documentation": "The regular expression used to validate the text field.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A requested resource couldn't be found.
", - "smithy.api#error": "client" + "smithy.api#documentation": "Validation rules for a text field.
" } }, - "com.amazonaws.pinpointsmsvoicev2#ResourceType": { + "com.amazonaws.pinpointsmsvoicev2#TextValue": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "account", - "name": "ACCOUNT" - }, - { - "value": "phone-number", - "name": "PHONE_NUMBER" - }, - { - "value": "sender-id", - "name": "SENDER_ID" - }, - { - "value": "pool", - "name": "POOL" - }, - { - "value": "configuration-set", - "name": "CONFIGURATION_SET" - }, - { - "value": "opt-out-list", - "name": "OPT_OUT_LIST" - }, - { - "value": "event-destination", - "name": "EVENT_DESTINATION" - }, - { - "value": "keyword", - "name": "KEYWORD" - }, - { - "value": "opted-out-number", - "name": "OPTED_OUT_NUMBER" - }, - { - "value": "registration", - "name": "REGISTRATION" - } - ] + "smithy.api#length": { + "min": 1, + "max": 2048 + } } }, - "com.amazonaws.pinpointsmsvoicev2#SendTextMessage": { + "com.amazonaws.pinpointsmsvoicev2#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "An error that occurred because too many requests were sent during a certain amount of\n time.
", + "smithy.api#error": "client", + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#TimeToLive": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 259200 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#UntagResource": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessageResult" + "target": "com.amazonaws.pinpointsmsvoicev2#UntagResourceResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -5621,100 +11001,45 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new text message and sends it to a recipient's phone number.
\nSMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit\n depends on the destination country of your messages, as well as the type of phone number\n (origination number) that you use to send the message. For more information, see Message Parts per\n Second (MPS) limits in the Amazon Pinpoint User\n Guide.
" + "smithy.api#documentation": "Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2\n resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" } }, - "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest": { + "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest": { "type": "structure", "members": { - "DestinationPhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", "traits": { - "smithy.api#documentation": "The destination phone number in E.164 format.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } }, - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity", - "traits": { - "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" - } - }, - "MessageBody": { - "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageBody", - "traits": { - "smithy.api#documentation": "The body of the text message.
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message. Valid values are\n TRANSACTIONAL\n for messages that are critical or time-sensitive and PROMOTIONAL for messages that\n aren't critical or time-sensitive.
" - } - }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", - "traits": { - "smithy.api#documentation": "When you register a short code in the US, you must specify a program name. If you\n don’t have a US short code, omit this attribute.
" - } - }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", - "traits": { - "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" - } - }, - "MaxPrice": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", - "traits": { - "smithy.api#documentation": "The maximum amount that you want to spend, in US dollars, per each text message part.\n A text message can contain multiple parts.
" - } - }, - "TimeToLive": { - "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", - "traits": { - "smithy.api#documentation": "How long the text message is valid for. By default this is 72 hours.
" - } - }, - "Context": { - "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", - "traits": { - "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" - } - }, - "DestinationCountryParameters": { - "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters", - "traits": { - "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
" - } - }, - "DryRun": { - "target": "smithy.api#PrimitiveBoolean", + "TagKeys": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagKeyList", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + "smithy.api#documentation": "An array of tag key values to unassociate with the resource.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SendTextMessageResult": { + "com.amazonaws.pinpointsmsvoicev2#UntagResourceResult": { "type": "structure", - "members": { - "MessageId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The unique identifier for the message.
" - } - } + "members": {}, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage": { + "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestination": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageResult" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationResult" }, "errors": [ { @@ -5729,9 +11054,6 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -5740,331 +11062,298 @@ } ], "traits": { - "smithy.api#documentation": "Allows you to send a request that sends a text message through Amazon Pinpoint.\n This operation uses Amazon Polly to\n convert a text script into a voice message.
" + "smithy.api#documentation": "Updates an existing event destination in a configuration set. You can update the\n IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can\n also enable or disable the event destination.
\nYou may want to update an event destination to change its matching event types or\n updating the destination resource ARN. You can't change an event destination's type\n between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
" } }, - "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest": { + "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest": { "type": "structure", "members": { - "DestinationPhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The destination phone number in E.164 format.
", + "smithy.api#documentation": "The configuration set to update with the new event destination. Valid values for this\n can be the ConfigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageOriginationIdentity", + "EventDestinationName": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", "traits": { - "smithy.api#documentation": "The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
", + "smithy.api#documentation": "The name to use for the event destination.
", "smithy.api#required": {} } }, - "MessageBody": { - "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageBody", + "Enabled": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "The text to convert to a voice message.
" + "smithy.api#documentation": "When set to true logging is enabled.
" } }, - "MessageBodyTextType": { - "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageBodyTextType", + "MatchingEventTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", "traits": { - "smithy.api#documentation": "Specifies if the MessageBody field contains text or speech synthesis\n markup language (SSML).
\nTEXT: This is the default value. When used the maximum character limit is\n 3000.
\nSSML: When used the maximum character limit is 6000 including SSML\n tagging.
\nAn array of event types that determine which events to log.
\nThe TEXT_SENT event type is not supported.
The voice for the Amazon Polly\n service to use. By default this is set to \"MATTHEW\".
" + "smithy.api#documentation": "An object that contains information about an event destination that sends data to\n CloudWatch Logs.
" } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "KinesisFirehoseDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + "smithy.api#documentation": "An object that contains information about an event destination for logging to Kinesis Data Firehose.
" } }, - "MaxPricePerMinute": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", + "SnsDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", "traits": { - "smithy.api#documentation": "The maximum amount to spend per voice message, in US dollars.
" + "smithy.api#documentation": "An object that contains information about an event destination that sends data to\n Amazon SNS.
" } - }, - "TimeToLive": { - "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "How long the voice message is valid for. By default this is 72 hours.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
" } }, - "Context": { - "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + "smithy.api#documentation": "The name of the configuration set.
" } }, - "DryRun": { - "target": "smithy.api#PrimitiveBoolean", + "EventDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + "smithy.api#documentation": "An EventDestination object containing the details of where events will be logged.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageResult": { - "type": "structure", - "members": { - "MessageId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The unique identifier for the message.
" - } + "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderId": { - "type": "string", + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 11 - }, - "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + "smithy.api#documentation": "Updates the configuration of an existing origination phone number. You can update the\n opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable\n or disable self-managed opt-outs, and enable or disable deletion protection.
\nIf the origination phone number is associated with a pool, an error is\n returned.
" } }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdAndCountry": { + "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberRequest": { "type": "structure", "members": { - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn", + "PhoneNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier of the sender.
", + "smithy.api#documentation": "The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.
", "smithy.api#required": {} } }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "TwoWayEnabled": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" } - } - }, - "traits": { - "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you want to describe. For more\n information on sender IDs see Requesting\n sender IDs for SMS messaging with Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterName", + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" } }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", "traits": { - "smithy.api#documentation": "An array of values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The OptOutList to add the phone number to. Valid values for this field can be either\n the OutOutListName or OutOutListArn.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" } } }, "traits": { - "smithy.api#documentation": "The information for a sender ID that meets a specified criteria.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter" - }, - "traits": { - "smithy.api#length": { - "max": 20 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "sender-id", - "name": "SENDER_ID" - }, - { - "value": "iso-country-code", - "name": "ISO_COUNTRY_CODE" - }, - { - "value": "message-type", - "name": "MESSAGE_TYPE" - } - ] + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdInformation": { + "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberResult": { "type": "structure", "members": { - "SenderIdArn": { + "PhoneNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated phone number.
" } }, - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "PhoneNumberId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you'd like to describe.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of the phone number.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that was updated.
" + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "traits": { + "smithy.api#documentation": "The current status of the request.
" } }, "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" } }, - "MessageTypes": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", - "smithy.api#required": {} + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Specifies if the number could be used for text messages, voice or both.
" + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", + "traits": { + "smithy.api#documentation": "The type of number that was requested.
" } }, "MonthlyLeasingPrice": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The monthly leasing price, in US dollars.
", - "smithy.api#required": {} + "smithy.api#documentation": "The monthly leasing price of the phone number, in US dollars.
" } - } - }, - "traits": { - "smithy.api#documentation": "The information for all SenderIds in an Amazon Web Services account.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdInformation" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdAndCountry" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } }, - "Reason": { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededExceptionReason", + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", "traits": { - "smithy.api#documentation": "The reason for the exception.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" } - } - }, - "traits": { - "smithy.api#documentation": "The request would cause a service quota to be exceeded.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONFIGURATION_SETS_PER_ACCOUNT", - "name": "CONFIGURATION_SETS_PER_ACCOUNT" - }, - { - "value": "DAILY_DESTINATION_CALL_LIMIT", - "name": "DAILY_DESTINATION_CALL_LIMIT" - }, - { - "value": "EVENT_DESTINATIONS_PER_CONFIGURATION_SET", - "name": "EVENT_DESTINATIONS_PER_CONFIGURATION_SET" - }, - { - "value": "KEYWORDS_PER_PHONE_NUMBER", - "name": "KEYWORDS_PER_PHONE_NUMBER" - }, - { - "value": "KEYWORDS_PER_POOL", - "name": "KEYWORDS_PER_POOL" - }, - { - "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT", - "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT" - }, - { - "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE", - "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE" - }, - { - "value": "OPT_OUT_LISTS_PER_ACCOUNT", - "name": "OPT_OUT_LISTS_PER_ACCOUNT" - }, - { - "value": "ORIGINATION_IDENTITIES_PER_POOL", - "name": "ORIGINATION_IDENTITIES_PER_POOL" - }, - { - "value": "PHONE_NUMBERS_PER_ACCOUNT", - "name": "PHONE_NUMBERS_PER_ACCOUNT" - }, - { - "value": "PHONE_NUMBERS_PER_REGISTRATION", - "name": "PHONE_NUMBERS_PER_REGISTRATION" - }, - { - "value": "POOLS_PER_ACCOUNT", - "name": "POOLS_PER_ACCOUNT" - }, - { - "value": "TAGS_PER_RESOURCE", - "name": "TAGS_PER_RESOURCE" + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if self managed opt-out are enabled.
" } - ] + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList associated with the phone number.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true the phone number can't be deleted.
" + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType": { + "com.amazonaws.pinpointsmsvoicev2#UpdatePool": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePoolRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeResult" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePoolResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -6079,129 +11368,157 @@ } ], "traits": { - "smithy.api#documentation": "Sets the default message type on a configuration set.
\nChoose the category of SMS messages that you plan to send from this account. If you\n send account-related messages or time-sensitive messages such as one-time passcodes,\n choose Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" + "smithy.api#documentation": "Updates the configuration of an existing pool. You can update the opt-out list, enable\n or disable two-way messaging, change the TwoWayChannelArn, enable or\n disable self-managed opt-outs, enable or disable deletion protection, and enable or\n disable shared routes.
The configuration set to update with a new default message type. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", + "smithy.api#documentation": "The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.
", "smithy.api#required": {} } }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "TwoWayEnabled": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", - "smithy.api#required": {} + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.
" + } + }, + "SharedRoutesEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "When set to true the pool can't be deleted.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeResult": { + "com.amazonaws.pinpointsmsvoicev2#UpdatePoolResult": { "type": "structure", "members": { - "ConfigurationSetArn": { + "PoolArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated configuration set.
" + "smithy.api#documentation": "The ARN of the pool.
" } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "PoolId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the configuration set that was updated.
" + "smithy.api#documentation": "The unique identifier of the pool.
" + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", + "traits": { + "smithy.api#documentation": "The current status of the pool update request.
" } }, "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The new default message type of the configuration set.
" + "smithy.api#documentation": "The type of message for the pool to use.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Sets default sender ID on a configuration set.
\nWhen sending a text message to a destination country that supports sender IDs, the\n default sender ID on the configuration set specified will be used if no dedicated\n origination phone numbers or registered sender IDs are available in your account.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdRequest": { - "type": "structure", - "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "The configuration set to updated with a new default SenderId. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", - "smithy.api#required": {} + "smithy.api#default": false, + "smithy.api#documentation": "When an end recipient sends a message that begins with HELP or STOP to one of your\n dedicated numbers, Amazon Pinpoint automatically replies with a customizable message\n and adds the end recipient to the OptOutList. When set to true you're responsible for\n responding to HELP and STOP requests. You're also responsible for tracking and honoring\n opt-out requests.
" } }, - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "The current sender ID for the configuration set. When sending a text message to a\n destination country which supports SenderIds, the default sender ID on the configuration\n set specified on SendTextMessage will be used if no dedicated\n origination phone numbers or registered SenderIds are available in your account, instead\n of a generic sender ID, such as 'NOTICE'.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the OptOutList associated with the pool.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", + }, + "SharedRoutesEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated configuration set.
" + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "The name of the configuration set that was updated.
" + "smithy.api#default": false, + "smithy.api#documentation": "When set to true the pool can't be deleted.
" } }, - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The default sender ID to set for the ConfigurationSet.
" + "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride": { + "com.amazonaws.pinpointsmsvoicev2#UpdateSenderId": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateSenderIdRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideResult" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateSenderIdResult" }, "errors": [ { @@ -6210,6 +11527,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -6218,674 +11538,484 @@ } ], "traits": { - "smithy.api#documentation": "Sets an account level monthly spend limit override for sending text messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
Updates the configuration of an existing sender ID.
" } }, - "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideRequest": { + "com.amazonaws.pinpointsmsvoicev2#UpdateSenderIdRequest": { "type": "structure", "members": { - "MonthlyLimit": { - "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn", "traits": { - "smithy.api#documentation": "The new monthly limit to enforce on text messages.
", + "smithy.api#documentation": "The sender ID to update.
", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideResult": { - "type": "structure", - "members": { - "MonthlyLimit": { - "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The current monthly limit to enforce on sending text messages.
" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverride": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Sets an account level monthly spend limit override for sending voice messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
The new monthly limit to enforce on voice messages.
", - "smithy.api#required": {} + "smithy.api#documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideResult": { + "com.amazonaws.pinpointsmsvoicev2#UpdateSenderIdResult": { "type": "structure", "members": { - "MonthlyLimit": { - "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "SenderIdArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The current monthly limit to enforce on sending voice messages.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", + "smithy.api#required": {} + } + }, + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The sender ID that was updated.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + }, + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price, in US dollars, to lease the sender ID.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
", + "smithy.api#required": {} + } + }, + "Registered": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "True if the sender ID is registered..
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SnsDestination": { + "com.amazonaws.pinpointsmsvoicev2#ValidationException": { "type": "structure", "members": { - "TopicArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#SnsTopicArn", + "Message": { + "target": "smithy.api#String" + }, + "Reason": { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionReason", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to\n publish events to.
", - "smithy.api#required": {} + "smithy.api#documentation": "The reason for the exception.
" + } + }, + "Fields": { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The field that failed validation.
" } } }, "traits": { - "smithy.api#documentation": "An object that defines an Amazon SNS destination for events. You can use\n Amazon SNS to send notification when certain events occur.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SnsTopicArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" + "smithy.api#documentation": "A validation exception for a field.
", + "smithy.api#error": "client" } }, - "com.amazonaws.pinpointsmsvoicev2#SpendLimit": { + "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionField": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimitName", - "traits": { - "smithy.api#documentation": "The name for the SpendLimit.
", - "smithy.api#required": {} - } - }, - "EnforcedLimit": { - "target": "smithy.api#PrimitiveLong", + "target": "smithy.api#String", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum amount of money, in US dollars, that you want to be able to spend sending\n messages each month. This value has to be less than or equal to the amount in\n MaxLimit. To use this custom limit, Overridden must be set\n to true.
The name of the field.
", "smithy.api#required": {} } }, - "MaxLimit": { - "target": "smithy.api#PrimitiveLong", + "Message": { + "target": "smithy.api#String", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum amount of money that you are able to spend to send messages each month,\n in US dollars.
", + "smithy.api#documentation": "The message associated with the validation exception with information to help\n determine its cause.
", "smithy.api#required": {} } - }, - "Overridden": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to True, the value that has been specified in the\n EnforcedLimit is used to determine the maximum amount in US dollars\n that can be spent to send messages each month, in US dollars.
The field associated with the validation exception.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionField" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CANNOT_ADD_OPTED_OUT_NUMBER", + "name": "CANNOT_ADD_OPTED_OUT_NUMBER" + }, + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "COUNTRY_CODE_MISMATCH", + "name": "COUNTRY_CODE_MISMATCH" + }, + { + "value": "DESTINATION_COUNTRY_BLOCKED", + "name": "DESTINATION_COUNTRY_BLOCKED" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "ATTACHMENT_TYPE_NOT_SUPPORTED", + "name": "ATTACHMENT_TYPE_NOT_SUPPORTED" + }, + { + "value": "INVALID_ARN", + "name": "INVALID_ARN" + }, + { + "value": "INVALID_FILTER_VALUES", + "name": "INVALID_FILTER_VALUES" + }, + { + "value": "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY", + "name": "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY" + }, + { + "value": "INVALID_NEXT_TOKEN", + "name": "INVALID_NEXT_TOKEN" + }, + { + "value": "INVALID_PARAMETER", + "name": "INVALID_PARAMETER" + }, + { + "value": "INVALID_REQUEST", + "name": "INVALID_REQUEST" + }, + { + "value": "INVALID_REGISTRATION_ASSOCIATION", + "name": "INVALID_REGISTRATION_ASSOCIATION" + }, + { + "value": "MAXIMUM_SIZE_EXCEEDED", + "name": "MAXIMUM_SIZE_EXCEEDED" + }, + { + "value": "MISSING_PARAMETER", + "name": "MISSING_PARAMETER" + }, + { + "value": "PARAMETERS_CANNOT_BE_USED_TOGETHER", + "name": "PARAMETERS_CANNOT_BE_USED_TOGETHER" + }, + { + "value": "PHONE_NUMBER_CANNOT_BE_OPTED_IN", + "name": "PHONE_NUMBER_CANNOT_BE_OPTED_IN" + }, + { + "value": "PHONE_NUMBER_CANNOT_BE_RELEASED", + "name": "PHONE_NUMBER_CANNOT_BE_RELEASED" + }, + { + "value": "PRICE_OVER_THRESHOLD", + "name": "PRICE_OVER_THRESHOLD" + }, + { + "value": "RESOURCE_NOT_ACCESSIBLE", + "name": "RESOURCE_NOT_ACCESSIBLE" + }, + { + "value": "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT", + "name": "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT" + }, + { + "value": "SENDER_ID_NOT_REGISTERED", + "name": "SENDER_ID_NOT_REGISTERED" + }, + { + "value": "SENDER_ID_NOT_SUPPORTED", + "name": "SENDER_ID_NOT_SUPPORTED" + }, + { + "value": "SENDER_ID_REQUIRES_REGISTRATION", + "name": "SENDER_ID_REQUIRES_REGISTRATION" + }, + { + "value": "TWO_WAY_TOPIC_NOT_PRESENT", + "name": "TWO_WAY_TOPIC_NOT_PRESENT" + }, + { + "value": "TWO_WAY_NOT_ENABLED", + "name": "TWO_WAY_NOT_ENABLED" + }, + { + "value": "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY", + "name": "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY" + }, + { + "value": "TWO_WAY_NOT_SUPPORTED_IN_REGION", + "name": "TWO_WAY_NOT_SUPPORTED_IN_REGION" + }, + { + "value": "TWO_WAY_CHANNEL_NOT_PRESENT", + "name": "TWO_WAY_CHANNEL_NOT_PRESENT" + }, + { + "value": "UNKNOWN_REGISTRATION_FIELD", + "name": "UNKNOWN_REGISTRATION_FIELD" + }, + { + "value": "UNKNOWN_REGISTRATION_SECTION", + "name": "UNKNOWN_REGISTRATION_SECTION" + }, + { + "value": "UNKNOWN_REGISTRATION_TYPE", + "name": "UNKNOWN_REGISTRATION_TYPE" + }, + { + "value": "UNKNOWN_REGISTRATION_VERSION", + "name": "UNKNOWN_REGISTRATION_VERSION" + }, + { + "value": "UNKNOWN_OPERATION", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "REGISTRATION_FIELD_CANNOT_BE_DELETED", + "name": "REGISTRATION_FIELD_CANNOT_BE_DELETED" + }, + { + "value": "VERIFICATION_CODE_MISMATCH", + "name": "VERIFICATION_CODE_MISMATCH" + }, + { + "value": "VOICE_CAPABILITY_NOT_AVAILABLE", + "name": "VOICE_CAPABILITY_NOT_AVAILABLE" + }, + { + "value": "OTHER", + "name": "OTHER" } - } - }, - "traits": { - "smithy.api#documentation": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages. For more information on increasing your monthly spend limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SpendLimitList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimit" + ] } }, - "com.amazonaws.pinpointsmsvoicev2#SpendLimitName": { + "com.amazonaws.pinpointsmsvoicev2#VerificationChannel": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", - "name": "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT" + "value": "TEXT", + "name": "TEXT" }, { - "value": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", - "name": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT" + "value": "VOICE", + "name": "VOICE" } ] } }, - "com.amazonaws.pinpointsmsvoicev2#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagKey", - "traits": { - "smithy.api#documentation": "The key identifier, or name, of the tag.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagValue", - "traits": { - "smithy.api#documentation": "The string value associated with the key of the tag.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The list of tags to be added to the specified topic.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#Tag" - }, - "traits": { - "smithy.api#length": { - "max": 200 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS\n Voice, version 2 resource. When you specify an existing tag key, the value is\n overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag\n consists of a key and an optional value. Tag keys must be unique per resource. For more\n information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.pinpointsmsvoicev2#NonEmptyTagList", - "traits": { - "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagResourceResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.pinpointsmsvoicev2#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 256 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#TextMessageBody": { + "com.amazonaws.pinpointsmsvoicev2#VerificationCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 1600 + "max": 20 }, - "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + "smithy.api#pattern": "^[A-Za-z0-9]+$" } }, - "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity": { + "com.amazonaws.pinpointsmsvoicev2#VerificationMessageOriginationIdentity": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, - "smithy.api#pattern": "^[A-Za-z0-9_:/\\+-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ThrottlingException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "An error that occurred because too many requests were sent during a certain amount of\n time.
", - "smithy.api#error": "client", - "smithy.api#retryable": { - "throttling": true - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TimeToLive": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 5, - "max": 259200 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#UntagResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2\n resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagKeyList", - "traits": { - "smithy.api#documentation": "An array of tag key values to unassociate with the resource.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#UntagResourceResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], + "smithy.api#pattern": "^[A-Za-z0-9_:/\\+-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#VerificationStatus": { + "type": "string", "traits": { - "smithy.api#documentation": "Updates an existing event destination in a configuration set. You can update the\n IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can\n also enable or disable the event destination.
\nYou may want to update an event destination to change its matching event types or\n updating the destination resource ARN. You can't change an event destination's type\n between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
" + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "VERIFIED", + "name": "VERIFIED" + } + ] } }, - "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest": { + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilter": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilterName", "traits": { - "smithy.api#documentation": "The configuration set to update with the new event destination. Valid values for this\n can be the ConfigurationSetName or ConfigurationSetArn.
", + "smithy.api#documentation": "The name of the attribute to filter on.
", "smithy.api#required": {} } }, - "EventDestinationName": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", "traits": { - "smithy.api#documentation": "The name to use for the event destination.
", + "smithy.api#documentation": "An array of values to filter on.
", "smithy.api#required": {} } - }, - "Enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "When set to true logging is enabled.
" - } - }, - "MatchingEventTypes": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", - "traits": { - "smithy.api#documentation": "An array of event types that determine which events to log.
" - } - }, - "CloudWatchLogsDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#CloudWatchLogsDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination that sends data to\n CloudWatch Logs.
" - } - }, - "KinesisFirehoseDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination for logging to Kinesis Data Firehose.
" - } - }, - "SnsDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination that sends data to\n Amazon SNS.
" - } } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering verified destination phone numbers that meets a specified criteria.
" } }, - "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
" - } - }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", - "traits": { - "smithy.api#documentation": "The name of the configuration set.
" - } - }, - "EventDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination", - "traits": { - "smithy.api#documentation": "An EventDestination object containing the details of where events will be logged.\n
" - } + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 } } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumber": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberResult" + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "status", + "name": "STATUS" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn" }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Updates the configuration of an existing origination phone number. You can update the\n opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable\n or disable self-managed opt-outs, and enable or disable deletion protection.
\nIf the origination phone number is associated with a pool, an Error is\n returned.
" + "smithy.api#length": { + "max": 5 + } } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberRequest": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", - "traits": { - "smithy.api#documentation": "The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.
", - "smithy.api#required": {} - } - }, - "TwoWayEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", - "traits": { - "smithy.api#documentation": "The OptOutList to add the phone number to. Valid values for this field can be either\n the OutOutListName or OutOutListArn.
" - } + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 }, - "DeletionProtectionEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" - } - } + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberInformation": { "type": "structure", "members": { - "PhoneNumberArn": { + "VerifiedDestinationNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated phone number.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
", + "smithy.api#required": {} } }, - "PhoneNumberId": { + "VerifiedDestinationNumberId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the phone number.
" + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", + "smithy.api#required": {} } }, - "PhoneNumber": { + "DestinationPhoneNumber": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "The phone number that was updated.
" + "smithy.api#documentation": "The verified destination phone number, in E.164 format.
", + "smithy.api#required": {} } }, "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", - "traits": { - "smithy.api#documentation": "The current status of the request.
" - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" - } - }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", - "traits": { - "smithy.api#documentation": "Specifies if the number could be used for text messages, voice or both.
" - } - }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", - "traits": { - "smithy.api#documentation": "The type of number that was requested.
" - } - }, - "MonthlyLeasingPrice": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The monthly leasing price of the phone number, in US dollars.
" - } - }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "This is true if self managed opt-out are enabled.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { - "smithy.api#documentation": "The name of the OptOutList associated with the phone number.
" - } - }, - "DeletionProtectionEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationStatus", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true the phone number can't be deleted.
" + "smithy.api#documentation": "The status of the verified destination phone number.
\n\n PENDING: The phone number hasn't been verified yet.
\n VERIFIED: The phone number is verified and can receive messages.
The time when the phone number was created, in UNIX epoch time format.
" + "smithy.api#documentation": "The time when the destination phone number was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Provides information about the requested verified destintion phone number.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberInformation" } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePool": { + "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumber": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePoolRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumberRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePoolResult" + "target": "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumberResult" }, "errors": [ { @@ -6908,285 +12038,72 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of an existing pool. You can update the opt-out list, enable\n or disable two-way messaging, change the TwoWayChannelArn, enable or\n disable self-managed opt-outs, enable or disable deletion protection, and enable or\n disable shared routes.
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.
" } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePoolRequest": { + "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumberRequest": { "type": "structure", "members": { - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "VerifiedDestinationNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.
", + "smithy.api#documentation": "The unique identifier for the verififed destination phone number.
", "smithy.api#required": {} } }, - "TwoWayEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", - "traits": { - "smithy.api#documentation": "The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.
" - } - }, - "SharedRoutesEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" - } - }, - "DeletionProtectionEnabled": { - "target": "smithy.api#Boolean", + "VerificationCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationCode", "traits": { - "smithy.api#documentation": "When set to true the pool can't be deleted.
" + "smithy.api#documentation": "The verification code that was received by the verified destination phone number.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePoolResult": { + "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumberResult": { "type": "structure", "members": { - "PoolArn": { + "VerifiedDestinationNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ARN of the pool.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
", + "smithy.api#required": {} } }, - "PoolId": { + "VerifiedDestinationNumberId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the pool.
" - } - }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", - "traits": { - "smithy.api#documentation": "The current status of the pool update request.
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message for the pool to use.
" - } - }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When an end recipient sends a message that begins with HELP or STOP to one of your\n dedicated numbers, Amazon Pinpoint automatically replies with a customizable message\n and adds the end recipient to the OptOutList. When set to true you're responsible for\n responding to HELP and STOP requests. You're also responsible for tracking and honoring\n opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { - "smithy.api#documentation": "The name of the OptOutList associated with the pool.
" + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", + "smithy.api#required": {} } }, - "SharedRoutesEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" + "smithy.api#documentation": "The phone number in E.164 format.
", + "smithy.api#required": {} } }, - "DeletionProtectionEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationStatus", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true the pool can't be deleted.
" + "smithy.api#documentation": "The status for being able to send messages to the phone number.
", + "smithy.api#required": {} } }, "CreatedTimestamp": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - }, - "Reason": { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionReason", - "traits": { - "smithy.api#documentation": "The reason for the exception.
" - } - }, - "Fields": { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "The field that failed validation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A validation exception for a field.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionField": { - "type": "structure", - "members": { - "Name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The name of the field.
", - "smithy.api#required": {} - } - }, - "Message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The message associated with the validation exception with information to help\n determine its cause.
", + "smithy.api#documentation": "The time when the destination phone number was created, in UNIX epoch time format.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The field associated with the validation exception.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionField" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN_OPERATION", - "name": "UNKNOWN_OPERATION" - }, - { - "value": "CANNOT_PARSE", - "name": "CANNOT_PARSE" - }, - { - "value": "FIELD_VALIDATION_FAILED", - "name": "FIELD_VALIDATION_FAILED" - }, - { - "value": "OTHER", - "name": "OTHER" - }, - { - "value": "INVALID_PARAMETER", - "name": "INVALID_PARAMETER" - }, - { - "value": "INVALID_ARN", - "name": "INVALID_ARN" - }, - { - "value": "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY", - "name": "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY" - }, - { - "value": "DESTINATION_COUNTRY_BLOCKED", - "name": "DESTINATION_COUNTRY_BLOCKED" - }, - { - "value": "CANNOT_ADD_OPTED_OUT_NUMBER", - "name": "CANNOT_ADD_OPTED_OUT_NUMBER" - }, - { - "value": "COUNTRY_CODE_MISMATCH", - "name": "COUNTRY_CODE_MISMATCH" - }, - { - "value": "INVALID_FILTER_VALUES", - "name": "INVALID_FILTER_VALUES" - }, - { - "value": "INVALID_NEXT_TOKEN", - "name": "INVALID_NEXT_TOKEN" - }, - { - "value": "MISSING_PARAMETER", - "name": "MISSING_PARAMETER" - }, - { - "value": "PARAMETERS_CANNOT_BE_USED_TOGETHER", - "name": "PARAMETERS_CANNOT_BE_USED_TOGETHER" - }, - { - "value": "PHONE_NUMBER_CANNOT_BE_OPTED_IN", - "name": "PHONE_NUMBER_CANNOT_BE_OPTED_IN" - }, - { - "value": "PHONE_NUMBER_CANNOT_BE_RELEASED", - "name": "PHONE_NUMBER_CANNOT_BE_RELEASED" - }, - { - "value": "PRICE_OVER_THRESHOLD", - "name": "PRICE_OVER_THRESHOLD" - }, - { - "value": "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT", - "name": "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT" - }, - { - "value": "SENDER_ID_NOT_REGISTERED", - "name": "SENDER_ID_NOT_REGISTERED" - }, - { - "value": "SENDER_ID_NOT_SUPPORTED", - "name": "SENDER_ID_NOT_SUPPORTED" - }, - { - "value": "TWO_WAY_NOT_ENABLED", - "name": "TWO_WAY_NOT_ENABLED" - }, - { - "value": "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY", - "name": "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY" - }, - { - "value": "TWO_WAY_NOT_SUPPORTED_IN_REGION", - "name": "TWO_WAY_NOT_SUPPORTED_IN_REGION" - }, - { - "value": "TWO_WAY_TOPIC_NOT_PRESENT", - "name": "TWO_WAY_TOPIC_NOT_PRESENT" - } - ] + "smithy.api#output": {} } }, "com.amazonaws.pinpointsmsvoicev2#VoiceId": { diff --git a/codegen/sdk/aws-models/polly.json b/codegen/sdk/aws-models/polly.json index 582a4f2a957..def7aa319b5 100644 --- a/codegen/sdk/aws-models/polly.json +++ b/codegen/sdk/aws-models/polly.json @@ -167,7 +167,7 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "Specifies the engine (standard or neural)\n used by Amazon Polly when processing input text for speech synthesis.
Specifies the engine (standard, neural or\n long-form) used by Amazon Polly when processing input text for\n speech synthesis.
Specifies the engine (standard or neural)\n for Amazon Polly to use when processing input text for speech synthesis. Using a\n voice that is not supported for the engine selected will result in an\n error.
Specifies the engine (standard, neural or\n long-form) for Amazon Polly to use when processing input text for\n speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.
The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" + "smithy.api#documentation": "The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" } }, "SnsTopicArn": { @@ -2498,7 +2504,7 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "Specifies the engine (standard or neural)\n for Amazon Polly to use when processing input text for speech synthesis. Using a\n voice that is not supported for the engine selected will result in an\n error.
Specifies the engine (standard, neural or\n long-form) for Amazon Polly to use when processing input text for\n speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.
The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" + "smithy.api#documentation": "The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" } }, "SpeechMarkTypes": { @@ -2683,7 +2689,7 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "Specifies the engine (standard or neural)\n for Amazon Polly to use when processing input text for speech synthesis. For\n information on Amazon Polly voices and which voices are available in\n standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.
\n NTTS-only voices\n
\nWhen using NTTS-only voices such as Kevin (en-US), this parameter is\n required and must be set to neural. If the engine is not\n specified, or is set to standard, this will result in an\n error.
Type: String
\nValid Values: standard | neural\n
Required: Yes
\n\n Standard voices\n
\nFor standard voices, this is not required; the engine parameter\n defaults to standard. If the engine is not specified, or is\n set to standard and an NTTS-only voice is selected, this will\n result in an error.
Specifies the engine (standard, neural or\n long-form) for Amazon Polly to use when processing input text for\n speech synthesis. For information on Amazon Polly voices and which voices are\n available for each engine, see Available Voices.
\n NTTS-only voices\n
\nWhen using NTTS-only voices such as Kevin (en-US), this parameter is\n required and must be set to neural. If the engine is not\n specified, or is set to standard, this will result in an\n error.
\n long-form-only voices\n
\nWhen using long-form-only voices such as Danielle (en-US), this\n parameter is required and must be set to long-form. If the\n engine is not specified, or is set to standard or\n neural, this will result in an error.
Type: String
\nValid Values: standard | neural |\n long-form\n
Required: Yes
\n\n Standard voices\n
\nFor standard voices, this is not required; the engine parameter\n defaults to standard. If the engine is not specified, or is\n set to standard and an NTTS-only voice is selected, this will\n result in an error.
The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" + "smithy.api#documentation": "The audio frequency specified in Hz.
\nThe valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\".
\nValid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".
" } }, "SpeechMarkTypes": { @@ -2912,7 +2918,7 @@ "SupportedEngines": { "target": "com.amazonaws.polly#EngineList", "traits": { - "smithy.api#documentation": "Specifies which engines (standard or neural)\n that are supported by a given voice.
Specifies which engines (standard, neural or\n long-form) are supported by a given voice.
An array of option definitions for an analysis.
" + } } }, "traits": { @@ -1119,7 +1125,8 @@ "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ARN of the specific Analysis resource whose override properties are configured in this structure.
The ARN of the specific Analysis resource whose override properties are configured in this structure.
The ARN of the specific Dashboard resource whose override properties are configured in this structure.
The ARN of the specific Dashboard resource whose override properties are configured in this structure.
The ARN of the specific DataSet resource whose override properties are configured in this structure.
The ARN of the specific DataSet resource whose override properties are configured in this structure.
The ARN of the specific DataSource resource whose override properties are configured in this structure.
The ARN of the specific DataSource resource whose override properties are configured in this structure.
The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
The format for the export job.
" } + }, + "IncludePermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The flag that determines the inclusion of permissions associated with each resource ARN.
" + } + }, + "IncludeTags": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The flag that determines the inclusion of tags associated with each resource ARN.
" + } } }, "traits": { @@ -1622,7 +1647,8 @@ "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ARN of the specific Theme resource whose override properties are configured in this structure.
The ARN of the specific Theme resource whose override properties are configured in this structure.
The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
A Boolean value that indicates whether to export resources under strict or lenient mode.
" + } + } + }, + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "A description of the warning.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a warning that occurred during an Asset Bundle export job.
" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobWarningList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobWarning" + } + }, "com.amazonaws.quicksight#AssetBundleImportBodyBlob": { "type": "blob", "traits": { @@ -1800,6 +1868,74 @@ } } }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions": { + "type": "structure", + "members": { + "AnalysisIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of permissions to be applied to a list of analysis IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags": { + "type": "structure", + "members": { + "AnalysisIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of tags to be assigned to a list of analysis IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParameters": { "type": "structure", "members": { @@ -1833,6 +1969,79 @@ } } }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions": { + "type": "structure", + "members": { + "DashboardIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.quicksight#AssetBundleResourceLinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "A structure that contains the link sharing configurations that you want to apply overrides to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of permissions to be applied to a list of dashboard IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags": { + "type": "structure", + "members": { + "DashboardIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of tags to be assigned to a list of dashboard IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParameters": { "type": "structure", "members": { @@ -1866,6 +2075,74 @@ } } }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions": { + "type": "structure", + "members": { + "DataSetIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of permissions to be applied to a list of dataset IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags": { + "type": "structure", + "members": { + "DataSetIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of tags to be assigned to a list of dataset IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair": { "type": "structure", "members": { @@ -1957,6 +2234,74 @@ } } }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions": { + "type": "structure", + "members": { + "DataSourceIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of permissions to be applied to a list of data source IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags": { + "type": "structure", + "members": { + "DataSourceIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of tags to be assigned to a list of data source IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.quicksight#AssetBundleImportJobError": { "type": "structure", "members": { @@ -2045,6 +2390,103 @@ "smithy.api#documentation": "A list of overrides that modify the asset bundle resource configuration before the resource is imported.
" } }, + "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions": { + "type": "structure", + "members": { + "DataSources": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList", + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags": { + "type": "structure", + "members": { + "VPCConnections": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList", + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy": { + "type": "structure", + "members": { + "StrictModeForAllResources": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.
" + } + }, "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParameters": { "type": "structure", "members": { @@ -2223,6 +2665,74 @@ } } }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions": { + "type": "structure", + "members": { + "ThemeIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of permissions to be applied to a list of theme IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags": { + "type": "structure", + "members": { + "ThemeIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of tags to be assigned to a list of theme IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParameters": { "type": "structure", "members": { @@ -2280,6 +2790,40 @@ } } }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags": { + "type": "structure", + "members": { + "VPCConnectionIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a list of tags to be assigned to a list of VPC connection IDs.
" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.quicksight#AssetBundleImportSource": { "type": "structure", "members": { @@ -2304,7 +2848,7 @@ "type": "structure", "members": { "Body": { - "target": "com.amazonaws.quicksight#String", + "target": "com.amazonaws.quicksight#SensitiveS3Uri", "traits": { "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.
" + } + }, + "com.amazonaws.quicksight#AssetBundleResourcePermissions": { + "type": "structure", + "members": { + "Principals": { + "target": "com.amazonaws.quicksight#AssetBundlePrincipalList", + "traits": { + "smithy.api#documentation": "A list of principals to grant permissions on.
", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#ActionList", + "traits": { + "smithy.api#documentation": "A list of IAM actions to grant permissions on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
" + } + }, + "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\*|[\\w\\-]{1,2048}$" + } + }, + "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetOptions": { + "type": "structure", + "members": { + "Timezone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "Determines the timezone for the analysis.
" + } + }, + "WeekStart": { + "target": "com.amazonaws.quicksight#DayOfTheWeek", + "traits": { + "smithy.api#documentation": "Determines the week start day for an analysis.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An array of analysis level configurations.
" + } + }, "com.amazonaws.quicksight#AssignmentStatus": { "type": "enum", "members": { @@ -3172,6 +3802,27 @@ } } }, + "com.amazonaws.quicksight#BigQueryParameters": { + "type": "structure", + "members": { + "ProjectId": { + "target": "com.amazonaws.quicksight#ProjectId", + "traits": { + "smithy.api#documentation": "The Google Cloud Platform project ID where your datasource was created.
", + "smithy.api#required": {} + } + }, + "DataSetRegion": { + "target": "com.amazonaws.quicksight#DataSetRegion", + "traits": { + "smithy.api#documentation": "The storage location where you create a Google BigQuery data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The parameters that are required to connect to a Google BigQuery data source.
" + } + }, "com.amazonaws.quicksight#BinCountLimit": { "type": "long", "traits": { @@ -3868,6 +4519,12 @@ "smithy.api#required": {} } }, + "SubType": { + "target": "com.amazonaws.quicksight#ColumnDataSubType", + "traits": { + "smithy.api#documentation": "The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
" + } + }, "Format": { "target": "com.amazonaws.quicksight#TypeCastFormat", "traits": { @@ -4411,6 +5068,23 @@ } } }, + "com.amazonaws.quicksight#ColumnDataSubType": { + "type": "enum", + "members": { + "FLOAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOAT" + } + }, + "FIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED" + } + } + } + }, "com.amazonaws.quicksight#ColumnDataType": { "type": "enum", "members": { @@ -5825,7 +6499,7 @@ "AuthenticationMethod": { "target": "com.amazonaws.quicksight#AuthenticationMethodOption", "traits": { - "smithy.api#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\n and an AdminGroup associated with your Active Directory.
The method that you want to use to authenticate your Amazon QuickSight account.
\nIf you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName\n 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\n Active Directory in Amazon QuickSight, see Using Active Directory with\n Amazon QuickSight Enterprise Edition in the Amazon QuickSight\n 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": { "target": "com.amazonaws.quicksight#GroupsList", "traits": { - "smithy.api#documentation": "The author group associated with your Active Directory. For more information about using\n Active Directory in Amazon QuickSight, see Using Active Directory with\n Amazon QuickSight Enterprise Edition in the Amazon QuickSight\n User Guide.
" + "smithy.api#documentation": "The author group associated with your Active Directory or IAM Identity Center account.
\nFor 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": { "target": "com.amazonaws.quicksight#GroupsList", "traits": { - "smithy.api#documentation": "The reader group associated with your Active Direcrtory. For more information about\n using Active Directory in Amazon QuickSight, see Using Active Directory with\n Amazon QuickSight Enterprise Edition in the Amazon QuickSight\n User Guide.
" + "smithy.api#documentation": "The reader group associated with your Active Directory or IAM Identity Center account.
\nFor 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": { @@ -6249,6 +6923,12 @@ "traits": { "smithy.api#documentation": "When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
" } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#LinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "A structure that contains the permissions of a shareable link to the dashboard.
" + } } }, "traits": { @@ -7638,6 +8318,108 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#CreateRoleMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateRoleMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateRoleMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.
The name of the group that you want to add to the role.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#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.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace that the role belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "The role that you want to add a group to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateRoleMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#CreateTemplate": { "type": "operation", "input": { @@ -9672,6 +10454,12 @@ }, "AnalysisDefaults": { "target": "com.amazonaws.quicksight#AnalysisDefaults" + }, + "Options": { + "target": "com.amazonaws.quicksight#AssetOptions", + "traits": { + "smithy.api#documentation": "An array of option definitions for a dashboard.
" + } } }, "traits": { @@ -10605,6 +11393,15 @@ "smithy.api#documentation": "The refresh properties of a dataset.
" } }, + "com.amazonaws.quicksight#DataSetRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.quicksight#DataSetSchema": { "type": "structure", "members": { @@ -11125,6 +11922,12 @@ "traits": { "smithy.api#documentation": "The parameters that are required to connect to a Trino data source.
" } + }, + "BigQueryParameters": { + "target": "com.amazonaws.quicksight#BigQueryParameters", + "traits": { + "smithy.api#documentation": "The parameters that are required to connect to a Google BigQuery data source.
" + } } }, "traits": { @@ -11392,6 +12195,24 @@ "traits": { "smithy.api#enumValue": "DATABRICKS" } + }, + "STARBURST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARBURST" + } + }, + "TRINO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRINO" + } + }, + "BIGQUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGQUERY" + } } } }, @@ -12017,6 +12838,53 @@ "smithy.api#pattern": "^(?:LAST_DAY_OF_MONTH|1[0-9]|2[0-8]|[12]|[3-9])$" } }, + "com.amazonaws.quicksight#DayOfTheWeek": { + "type": "enum", + "members": { + "SUNDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNDAY" + } + }, + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "TUESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUESDAY" + } + }, + "WEDNESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEDNESDAY" + } + }, + "THURSDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THURSDAY" + } + }, + "FRIDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRIDAY" + } + }, + "SATURDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATURDAY" + } + } + } + }, "com.amazonaws.quicksight#DayOfWeek": { "type": "enum", "members": { @@ -13669,21 +14537,218 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a namespace and the users and groups that are associated with the namespace.\n This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not \n deleted. To delete these assets, you use the API operations for the relevant asset.
", + "smithy.api#documentation": "Deletes a namespace and the users and groups that are associated with the namespace.\n This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not \n deleted. To delete these assets, you use the API operations for the relevant asset.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteNamespaceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteNamespaceResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a refresh schedule from a dataset.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteRoleCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Removes custom permissions from the role.
", "smithy.api#http": { "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", "code": 200 } } }, - "com.amazonaws.quicksight#DeleteNamespaceRequest": { + "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest": { "type": "structure", "members": { + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "The role that you want to remove permissions from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13691,7 +14756,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "The namespace that you want to delete.
", + "smithy.api#documentation": "The namespace that includes the role.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13701,7 +14766,7 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DeleteNamespaceResponse": { + "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse": { "type": "structure", "members": { "RequestId": { @@ -13714,8 +14779,7 @@ "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The HTTP status of the request.
" } } }, @@ -13723,13 +14787,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#DeleteRefreshSchedule": { + "com.amazonaws.quicksight#DeleteRoleMembership": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DeleteRefreshScheduleRequest" + "target": "com.amazonaws.quicksight#DeleteRoleMembershipRequest" }, "output": { - "target": "com.amazonaws.quicksight#DeleteRefreshScheduleResponse" + "target": "com.amazonaws.quicksight#DeleteRoleMembershipResponse" }, "errors": [ { @@ -13742,31 +14806,42 @@ "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, { - "target": "com.amazonaws.quicksight#LimitExceededException" + "target": "com.amazonaws.quicksight#PreconditionNotMetException" }, { "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, { "target": "com.amazonaws.quicksight#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "Deletes a refresh schedule from a dataset.
", + "smithy.api#documentation": "Removes a group from a role.
", "smithy.api#http": { "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", "code": 200 } } }, - "com.amazonaws.quicksight#DeleteRefreshScheduleRequest": { + "com.amazonaws.quicksight#DeleteRoleMembershipRequest": { "type": "structure", "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "MemberName": { + "target": "com.amazonaws.quicksight#GroupName", "traits": { - "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#documentation": "The name of the group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "The role that you want to remove permissions from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13774,15 +14849,15 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "The ID of the refresh schedule.
", + "smithy.api#documentation": "The namespace that contains the role.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13792,33 +14867,21 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DeleteRefreshScheduleResponse": { + "com.amazonaws.quicksight#DeleteRoleMembershipResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The ID of the refresh schedule.
" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } }, @@ -15419,7 +16482,7 @@ } }, "DownloadUrl": { - "target": "com.amazonaws.quicksight#String", + "target": "com.amazonaws.quicksight#SensitiveS3Uri", "traits": { "smithy.api#documentation": "The URL to download the exported asset bundle data from.
\nThis 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.
", "smithy.api#httpResponseCode": {} } + }, + "IncludePermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The include permissions flag.
" + } + }, + "IncludeTags": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The include tags flag.
" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy", + "traits": { + "smithy.api#documentation": "The validation strategy that is used to export the analysis or dashboard.
" + } + }, + "Warnings": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobWarningList", + "traits": { + "smithy.api#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.
\nThis property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.
Optional overrides to be applied to the resource configuration before import.
" + "smithy.api#documentation": "Optional overrides that are applied to the resource configuration before import.
" } }, "FailureAction": { @@ -15626,6 +16715,24 @@ "smithy.api#documentation": "The HTTP status of the response.
", "smithy.api#httpResponseCode": {} } + }, + "OverridePermissions": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions", + "traits": { + "smithy.api#documentation": "Optional permission overrides that are applied to the resource configuration before import.
" + } + }, + "OverrideTags": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", + "traits": { + "smithy.api#documentation": "Optional tag overrides that are applied to the resource configuration before import.
" + } + }, + "OverrideValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", + "traits": { + "smithy.api#documentation": "An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
" + } } }, "traits": { @@ -17283,13 +18390,207 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#DescribeIAMPolicyAssignment": { + "com.amazonaws.quicksight#DescribeIAMPolicyAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an existing IAM policy assignment, as specified by the\n\t\t\tassignment name.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the assignment that you want to\n\t\t\tdescribe.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "The name of the assignment, also called a rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace that contains the assignment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse": { + "type": "structure", + "members": { + "IAMPolicyAssignment": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignment", + "traits": { + "smithy.api#documentation": "Information describing the IAM policy assignment.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeIngestionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a SPICE ingestion.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeIngestionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the dataset used in the ingestion.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "An ID for the ingestion.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeIngestionResponse": { + "type": "structure", + "members": { + "Ingestion": { + "target": "com.amazonaws.quicksight#Ingestion", + "traits": { + "smithy.api#documentation": "Information about the ingestion.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeIpRestriction": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest" + "target": "com.amazonaws.quicksight#DescribeIpRestrictionRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse" + "target": "com.amazonaws.quicksight#DescribeIpRestrictionResponse" }, "errors": [ { @@ -17298,9 +18599,6 @@ { "target": "com.amazonaws.quicksight#InternalFailureException" }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, @@ -17312,37 +18610,21 @@ } ], "traits": { - "smithy.api#documentation": "Describes an existing IAM policy assignment, as specified by the\n\t\t\tassignment name.
", + "smithy.api#documentation": "Provides a summary and status of IP rules.
", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", + "uri": "/accounts/{AwsAccountId}/ip-restriction", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest": { + "com.amazonaws.quicksight#DescribeIpRestrictionRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the assignment that you want to\n\t\t\tdescribe.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "The name of the assignment, also called a rule.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "The namespace that contains the assignment.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IP rules.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17352,13 +18634,25 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse": { + "com.amazonaws.quicksight#DescribeIpRestrictionResponse": { "type": "structure", "members": { - "IAMPolicyAssignment": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignment", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "Information describing the IAM policy assignment.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IP rules.
" + } + }, + "IpRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "A map that describes the IP rules with CIDR range and description.
" + } + }, + "Enabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "A value that specifies whether IP rules are turned on.
" } }, "RequestId": { @@ -17371,7 +18665,7 @@ "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#documentation": "The HTTP status of the request.\n\t\t\t
", "smithy.api#httpResponseCode": {} } } @@ -17380,13 +18674,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#DescribeIngestion": { + "com.amazonaws.quicksight#DescribeNamespace": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeIngestionRequest" + "target": "com.amazonaws.quicksight#DescribeNamespaceRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeIngestionResponse" + "target": "com.amazonaws.quicksight#DescribeNamespaceResponse" }, "errors": [ { @@ -17399,47 +18693,39 @@ "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, { - "target": "com.amazonaws.quicksight#ResourceExistsException" + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" + "target": "com.amazonaws.quicksight#ResourceUnavailableException" }, { "target": "com.amazonaws.quicksight#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "Describes a SPICE ingestion.
", + "smithy.api#documentation": "Describes the current namespace.
", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeIngestionRequest": { + "com.amazonaws.quicksight#DescribeNamespaceRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The ID of the dataset used in the ingestion.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "An ID for the ingestion.
", + "smithy.api#documentation": "The namespace that you want to describe.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17449,13 +18735,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DescribeIngestionResponse": { + "com.amazonaws.quicksight#DescribeNamespaceResponse": { "type": "structure", "members": { - "Ingestion": { - "target": "com.amazonaws.quicksight#Ingestion", + "Namespace": { + "target": "com.amazonaws.quicksight#NamespaceInfoV2", "traits": { - "smithy.api#documentation": "Information about the ingestion.
" + "smithy.api#documentation": "The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.
Provides a summary and status of IP rules.
", + "smithy.api#documentation": "Provides a summary of a refresh schedule.
", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/ip-restriction", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeIpRestrictionRequest": { + "com.amazonaws.quicksight#DescribeRefreshScheduleRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IP rules.
", + "smithy.api#documentation": "The Amazon Web Services account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeIpRestrictionResponse": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IP rules.
" - } - }, - "IpRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "A map that describes the IP rules with CIDR range and description.
" - } - }, - "Enabled": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "A value that specifies whether IP rules are turned on.
" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The HTTP status of the request.\n\t\t\t
", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeNamespace": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeNamespaceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeNamespaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "Describes the current namespace.
", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeNamespaceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.
", + "smithy.api#documentation": "The ID of the dataset.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The namespace that you want to describe.
", + "smithy.api#documentation": "The ID of the refresh schedule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17628,13 +18832,21 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DescribeNamespaceResponse": { + "com.amazonaws.quicksight#DescribeRefreshScheduleResponse": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#NamespaceInfoV2", + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", "traits": { - "smithy.api#documentation": "The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.
The refresh schedule.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } }, "RequestId": { @@ -17643,12 +18855,10 @@ "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" } } }, @@ -17656,13 +18866,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#DescribeRefreshSchedule": { + "com.amazonaws.quicksight#DescribeRoleCustomPermission": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeRefreshScheduleRequest" + "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeRefreshScheduleResponse" + "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse" }, "errors": [ { @@ -17675,47 +18885,50 @@ "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, { - "target": "com.amazonaws.quicksight#LimitExceededException" + "target": "com.amazonaws.quicksight#PreconditionNotMetException" }, { "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, { "target": "com.amazonaws.quicksight#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "Provides a summary of a refresh schedule.
", + "smithy.api#documentation": "Describes all custom permissions that are mapped to a role.
", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeRefreshScheduleRequest": { + "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "Role": { + "target": "com.amazonaws.quicksight#Role", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#documentation": "The name of the role whose permissions you want described.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#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.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "The ID of the refresh schedule.
", + "smithy.api#documentation": "The namespace that contains the role.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17725,21 +18938,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DescribeRefreshScheduleResponse": { + "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse": { "type": "structure", "members": { - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#RefreshSchedule", - "traits": { - "smithy.api#documentation": "The refresh schedule.
" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The name of the custom permission that is described.
" } }, "RequestId": { @@ -17748,10 +18953,11 @@ "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
" } } }, @@ -25018,6 +26224,12 @@ "smithy.api#documentation": "The data type of the column.
", "smithy.api#required": {} } + }, + "SubType": { + "target": "com.amazonaws.quicksight#ColumnDataSubType", + "traits": { + "smithy.api#documentation": "The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
" + } } }, "traits": { @@ -28547,6 +29759,138 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#ListRoleMemberships": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListRoleMembershipsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListRoleMembershipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all groups that are associated with a role.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MembersList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListRoleMembershipsRequest": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "The name of the role.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
", + "smithy.api#httpQuery": "max-results" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#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.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace that includes the role.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListRoleMembershipsResponse": { + "type": "structure", + "members": { + "MembersList": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "The list of groups associated with a role
" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#ListTagsForResource": { "type": "operation", "input": { @@ -31710,7 +33054,7 @@ "Name": { "target": "com.amazonaws.quicksight#ColumnName", "traits": { - "smithy.api#documentation": "A display name for the dataset.
" + "smithy.api#documentation": "The display name of the column..
" } }, "Description": { @@ -31722,7 +33066,13 @@ "Type": { "target": "com.amazonaws.quicksight#ColumnDataType", "traits": { - "smithy.api#documentation": "The type.
" + "smithy.api#documentation": "The data type of the column.
" + } + }, + "SubType": { + "target": "com.amazonaws.quicksight#ColumnDataSubType", + "traits": { + "smithy.api#documentation": "The sub data type of the column.
" } } }, @@ -33980,6 +35330,15 @@ "smithy.api#documentation": "The options that determine the presentation of the progress bar of a KPI visual.
" } }, + "com.amazonaws.quicksight#ProjectId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.quicksight#ProjectOperation": { "type": "structure", "members": { @@ -34242,6 +35601,9 @@ { "target": "com.amazonaws.quicksight#CreateRefreshSchedule" }, + { + "target": "com.amazonaws.quicksight#CreateRoleMembership" + }, { "target": "com.amazonaws.quicksight#CreateTemplate" }, @@ -34305,6 +35667,12 @@ { "target": "com.amazonaws.quicksight#DeleteRefreshSchedule" }, + { + "target": "com.amazonaws.quicksight#DeleteRoleCustomPermission" + }, + { + "target": "com.amazonaws.quicksight#DeleteRoleMembership" + }, { "target": "com.amazonaws.quicksight#DeleteTemplate" }, @@ -34416,6 +35784,9 @@ { "target": "com.amazonaws.quicksight#DescribeRefreshSchedule" }, + { + "target": "com.amazonaws.quicksight#DescribeRoleCustomPermission" + }, { "target": "com.amazonaws.quicksight#DescribeTemplate" }, @@ -34515,6 +35886,9 @@ { "target": "com.amazonaws.quicksight#ListRefreshSchedules" }, + { + "target": "com.amazonaws.quicksight#ListRoleMemberships" + }, { "target": "com.amazonaws.quicksight#ListTagsForResource" }, @@ -34647,6 +36021,9 @@ { "target": "com.amazonaws.quicksight#UpdateRefreshSchedule" }, + { + "target": "com.amazonaws.quicksight#UpdateRoleCustomPermission" + }, { "target": "com.amazonaws.quicksight#UpdateTemplate" }, @@ -37304,6 +38681,29 @@ "smithy.api#pattern": "^[\\w\\-]+$" } }, + "com.amazonaws.quicksight#Role": { + "type": "enum", + "members": { + "ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN" + } + }, + "AUTHOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR" + } + }, + "READER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER" + } + } + } + }, "com.amazonaws.quicksight#RoleArn": { "type": "string", "traits": { @@ -41021,6 +42421,26 @@ "traits": { "smithy.api#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.
\nUse 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.\n
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.
" + "smithy.api#documentation": "Optional overrides that are applied to the resource configuration before import.
" } }, "FailureAction": { @@ -41137,6 +42557,24 @@ "traits": { "smithy.api#documentation": "The failure action for the import job.
\nIf 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\n 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": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", + "traits": { + "smithy.api#documentation": "Optional tag overrides that are applied to the resource configuration before import.
" + } + }, + "OverrideValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", + "traits": { + "smithy.api#documentation": "An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
" + } } }, "traits": { @@ -43088,6 +44526,12 @@ }, "AnalysisDefaults": { "target": "com.amazonaws.quicksight#AnalysisDefaults" + }, + "Options": { + "target": "com.amazonaws.quicksight#AssetOptions", + "traits": { + "smithy.api#documentation": "An array of option definitions for a template.
" + } } }, "traits": { @@ -48004,7 +49448,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 2 + "max": 100 } } }, @@ -48207,6 +49651,106 @@ } } }, + "com.amazonaws.quicksight#UpdateRoleCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the custom permissions that are associated with a role.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest": { + "type": "structure", + "members": { + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "The name of the custom permission that you want to update the role with.
", + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "The name of role tht you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#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.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace that contains the role that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateTemplate": { "type": "operation", "input": { @@ -50012,7 +51556,7 @@ "Mode": { "target": "com.amazonaws.quicksight#ValidationStrategyMode", "traits": { - "smithy.api#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 engine version to upgrade the DB snapshot to.
\nThe following are the database engines and engine versions that are available when you upgrade a DB snapshot.
\n\n MySQL\n
\n\n 5.5.46 (supported for 5.1 DB snapshots)
\n Oracle\n
\n\n 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB\n snapshots)
\n 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB\n snapshots)
\n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
\n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
\n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
\n PostgreSQL\n
\nFor the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.
" + "smithy.api#documentation": "The engine version to upgrade the DB snapshot to.
\nThe following are the database engines and engine versions that are available when you upgrade a DB snapshot.
\n\n MySQL\n
\nFor the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.\n
\n\n Oracle\n
\n\n 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB\n snapshots)
\n 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB\n snapshots)
\n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
\n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
\n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
\n PostgreSQL\n
\nFor the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.\n
" } }, "OptionGroupName": { diff --git a/codegen/sdk/aws-models/redshift.json b/codegen/sdk/aws-models/redshift.json index 4938e916680..0091bd76b42 100644 --- a/codegen/sdk/aws-models/redshift.json +++ b/codegen/sdk/aws-models/redshift.json @@ -236,6 +236,9 @@ }, { "target": "com.amazonaws.redshift#UnauthorizedPartnerIntegrationFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -1496,6 +1499,24 @@ "traits": { "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
" } + }, + "IpAddressType": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The IP address type for the cluster. Possible values are ipv4 and dualstack.
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
" + } + }, + "MultiAZSecondary": { + "target": "com.amazonaws.redshift#SecondaryClusterInfo", + "traits": { + "smithy.api#documentation": "The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
" + } } }, "traits": { @@ -2265,6 +2286,12 @@ "traits": { "smithy.api#documentation": "The list of tags for the cluster subnet group.
" } + }, + "SupportedClusterIpAddressTypes": { + "target": "com.amazonaws.redshift#ValueStringList", + "traits": { + "smithy.api#documentation": "The IP address types supported by this cluster subnet group. Possible values are ipv4 and dualstack.
There is a conflict while updating the resource policy.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.redshift#CopyClusterSnapshot": { "type": "operation", "input": { @@ -2455,6 +2499,9 @@ "target": "com.amazonaws.redshift#CopyClusterSnapshotResult" }, "errors": [ + { + "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, { "target": "com.amazonaws.redshift#ClusterSnapshotAlreadyExistsFault" }, @@ -2664,6 +2711,9 @@ { "target": "com.amazonaws.redshift#InvalidVPCNetworkStateFault" }, + { + "target": "com.amazonaws.redshift#Ipv6CidrBlockNotFoundFault" + }, { "target": "com.amazonaws.redshift#LimitExceededFault" }, @@ -2681,6 +2731,9 @@ }, { "target": "com.amazonaws.redshift#UnauthorizedOperation" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -2911,6 +2964,18 @@ "traits": { "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. \n You can only use this parameter if ManageMasterPassword is true.
The IP address types that the cluster supports. Possible values are ipv4 and dualstack.
If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).
" + } } }, "traits": { @@ -3705,6 +3770,9 @@ "target": "com.amazonaws.redshift#ScheduledAction" }, "errors": [ + { + "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, { "target": "com.amazonaws.redshift#InvalidScheduledActionFault" }, @@ -3722,6 +3790,9 @@ }, { "target": "com.amazonaws.redshift#UnauthorizedOperation" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -4155,7 +4226,7 @@ "min": 1, "max": 253 }, - "smithy.api#pattern": "^((?!-)[A-Za-z0-9-]{1,63}(?The identifier of the cluster to delete a custom domain association for.", "smithy.api#required": {} } + }, + "CustomDomainName": { + "target": "com.amazonaws.redshift#CustomDomainNameString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The custom domain name for the custom domain association.
", + "smithy.api#required": {} + } } }, "traits": { @@ -5024,12 +5106,51 @@ }, { "target": "com.amazonaws.redshift#UnauthorizedPartnerIntegrationFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { "smithy.api#documentation": "Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.
" } }, + "com.amazonaws.redshift#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#DeleteResourcePolicyMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the resource policy for a specified resource.
" + } + }, + "com.amazonaws.redshift#DeleteResourcePolicyMessage": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource of which its resource policy is deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.redshift#DeleteScheduledAction": { "type": "operation", "input": { @@ -6812,6 +6933,67 @@ "smithy.api#input": {} } }, + "com.amazonaws.redshift#DescribeInboundIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#DescribeInboundIntegrationsMessage" + }, + "output": { + "target": "com.amazonaws.redshift#InboundIntegrationsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#InvalidNamespaceFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of inbound integrations.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "InboundIntegrations", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.redshift#DescribeInboundIntegrationsMessage": { + "type": "structure", + "members": { + "IntegrationArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inbound integration.
" + } + }, + "TargetArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target of an inbound integration.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.
Default: 100\n
Constraints: minimum 20, maximum 100.
" + } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeInboundIntegrations request\n exceed the value specified in MaxRecords, Amazon Web Services returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
" + } + }, + "com.amazonaws.redshift#FailoverPrimaryComputeInputMessage": { + "type": "structure", + "members": { + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the cluster for which the primary compute unit will be failed over to another Availability Zone.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshift#FailoverPrimaryComputeResult": { + "type": "structure", + "members": { + "Cluster": { + "target": "com.amazonaws.redshift#Cluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#GetClusterCredentials": { "type": "operation", "input": { @@ -9062,6 +9315,59 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#GetResourcePolicyMessage" + }, + "output": { + "target": "com.amazonaws.redshift#GetResourcePolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#InvalidPolicyFault" + }, + { + "target": "com.amazonaws.redshift#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "Get the resource policy for a specified resource.
" + } + }, + "com.amazonaws.redshift#GetResourcePolicyMessage": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource of which its resource policy is fetched.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshift#GetResourcePolicyResult": { + "type": "structure", + "members": { + "ResourcePolicy": { + "target": "com.amazonaws.redshift#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The content of the resource policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#HsmClientCertificate": { "type": "structure", "members": { @@ -9393,15 +9699,88 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.redshift#IncompatibleOrderableOptions": { + "com.amazonaws.redshift#InboundIntegration": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.redshift#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { + "IntegrationArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an inbound integration.
" + } + }, + "SourceArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source of an inbound integration.
" + } + }, + "TargetArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target of an inbound integration.
" + } + }, + "Status": { + "target": "com.amazonaws.redshift#ZeroETLIntegrationStatus", + "traits": { + "smithy.api#documentation": "The status of an inbound integration.
" + } + }, + "Errors": { + "target": "com.amazonaws.redshift#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "The outstanding errors of an inbound integration. Each item is an \"IntegrationError\". This is null if there is no error.
" + } + }, + "CreateTime": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "The creation time of an inbound integration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The content of an inbound integration.
" + } + }, + "com.amazonaws.redshift#InboundIntegrationList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#InboundIntegration", + "traits": { + "smithy.api#xmlName": "InboundIntegration" + } + } + }, + "com.amazonaws.redshift#InboundIntegrationsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.
A list of InboundIntegration instances.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshift#IncompatibleOrderableOptions": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { "code": "IncompatibleOrderableOptions", "httpResponseCode": 400 }, @@ -9450,6 +9829,54 @@ "com.amazonaws.redshift#IntegerOptional": { "type": "integer" }, + "com.amazonaws.redshift#IntegrationError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The error code of an inbound integration error.
", + "smithy.api#required": {} + } + }, + "ErrorMessage": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The error message of an inbound integration error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The error of an inbound integration.
" + } + }, + "com.amazonaws.redshift#IntegrationErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#IntegrationError", + "traits": { + "smithy.api#xmlName": "IntegrationError" + } + } + }, + "com.amazonaws.redshift#IntegrationNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The integration can't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.redshift#InvalidAuthenticationProfileRequestFault": { "type": "structure", "members": { @@ -9722,6 +10149,23 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.redshift#InvalidPolicyFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidPolicyFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The resource policy isn't valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.redshift#InvalidReservedNodeStateFault": { "type": "structure", "members": { @@ -9960,6 +10404,23 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.redshift#Ipv6CidrBlockNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "Ipv6CidrBlockNotFoundFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode,\n associate an IPv6 CIDR block with each subnet in your VPC.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.redshift#LimitExceededFault": { "type": "structure", "members": { @@ -10282,6 +10743,9 @@ { "target": "com.amazonaws.redshift#InvalidRetentionPeriodFault" }, + { + "target": "com.amazonaws.redshift#Ipv6CidrBlockNotFoundFault" + }, { "target": "com.amazonaws.redshift#LimitExceededFault" }, @@ -10325,6 +10789,9 @@ }, { "target": "com.amazonaws.redshift#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -10675,6 +11142,18 @@ "traits": { "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. \n You can only use this parameter if ManageMasterPassword is true.
The IP address types that the cluster supports. Possible values are ipv4 and dualstack.
If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.
" + } } }, "traits": { @@ -10940,6 +11419,9 @@ { "target": "com.amazonaws.redshift#CustomCnameAssociationFault" }, + { + "target": "com.amazonaws.redshift#CustomDomainAssociationNotFoundFault" + }, { "target": "com.amazonaws.redshift#UnsupportedOperationFault" } @@ -10954,13 +11436,17 @@ "CustomDomainName": { "target": "com.amazonaws.redshift#CustomDomainNameString", "traits": { - "smithy.api#documentation": "The custom domain name for a changed custom domain association.
" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The custom domain name for a changed custom domain association.
", + "smithy.api#required": {} } }, "CustomDomainCertificateArn": { "target": "com.amazonaws.redshift#CustomDomainCertificateArnString", "traits": { - "smithy.api#documentation": "The certificate Amazon Resource Name (ARN) for the changed custom domain association.
" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The certificate Amazon Resource Name (ARN) for the changed custom domain association.
", + "smithy.api#required": {} } }, "ClusterIdentifier": { @@ -11176,6 +11662,9 @@ "target": "com.amazonaws.redshift#ScheduledAction" }, "errors": [ + { + "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, { "target": "com.amazonaws.redshift#InvalidScheduledActionFault" }, @@ -11190,6 +11679,9 @@ }, { "target": "com.amazonaws.redshift#UnauthorizedOperation" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -11449,6 +11941,12 @@ "traits": { "smithy.api#documentation": "The Availability Zone.
" } + }, + "Ipv6Address": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The IPv6 address of the network interface within the subnet.
" + } } }, "traits": { @@ -12047,6 +12545,9 @@ }, { "target": "com.amazonaws.redshift#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -12220,6 +12721,70 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#PutResourcePolicyMessage" + }, + "output": { + "target": "com.amazonaws.redshift#PutResourcePolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#ConflictPolicyUpdateFault" + }, + { + "target": "com.amazonaws.redshift#InvalidPolicyFault" + }, + { + "target": "com.amazonaws.redshift#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "Updates the resource policy for a specified resource.
" + } + }, + "com.amazonaws.redshift#PutResourcePolicyMessage": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource of which its resource policy is updated.
", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The content of the resource policy being updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshift#PutResourcePolicyResult": { + "type": "structure", + "members": { + "ResourcePolicy": { + "target": "com.amazonaws.redshift#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The content of the updated resource policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#RebootCluster": { "type": "operation", "input": { @@ -12421,6 +12986,9 @@ { "target": "com.amazonaws.redshift#DeletePartner" }, + { + "target": "com.amazonaws.redshift#DeleteResourcePolicy" + }, { "target": "com.amazonaws.redshift#DeleteScheduledAction" }, @@ -12505,6 +13073,9 @@ { "target": "com.amazonaws.redshift#DescribeHsmConfigurations" }, + { + "target": "com.amazonaws.redshift#DescribeInboundIntegrations" + }, { "target": "com.amazonaws.redshift#DescribeLoggingStatus" }, @@ -12565,6 +13136,9 @@ { "target": "com.amazonaws.redshift#EnableSnapshotCopy" }, + { + "target": "com.amazonaws.redshift#FailoverPrimaryCompute" + }, { "target": "com.amazonaws.redshift#GetClusterCredentials" }, @@ -12577,6 +13151,9 @@ { "target": "com.amazonaws.redshift#GetReservedNodeExchangeOfferings" }, + { + "target": "com.amazonaws.redshift#GetResourcePolicy" + }, { "target": "com.amazonaws.redshift#ModifyAquaConfiguration" }, @@ -12634,6 +13211,9 @@ { "target": "com.amazonaws.redshift#PurchaseReservedNodeOffering" }, + { + "target": "com.amazonaws.redshift#PutResourcePolicy" + }, { "target": "com.amazonaws.redshift#RebootCluster" }, @@ -14567,6 +15147,26 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.redshift#ResourcePolicy": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The resources that a policy is attached to.
" + } + }, + "Policy": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The content of a resource policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The policy that is attached to a resource.
" + } + }, "com.amazonaws.redshift#RestorableNodeTypeList": { "type": "list", "member": { @@ -14648,6 +15248,9 @@ { "target": "com.amazonaws.redshift#InvalidVPCNetworkStateFault" }, + { + "target": "com.amazonaws.redshift#Ipv6CidrBlockNotFoundFault" + }, { "target": "com.amazonaws.redshift#LimitExceededFault" }, @@ -14900,6 +15503,18 @@ "traits": { "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. \n You can only use this parameter if ManageMasterPassword is true.
The IP address type for the cluster. Possible values are ipv4 and dualstack.
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
" + } } }, "traits": { @@ -15098,6 +15713,9 @@ }, { "target": "com.amazonaws.redshift#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -15391,6 +16009,9 @@ }, { "target": "com.amazonaws.redshift#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -15818,6 +16439,26 @@ } } }, + "com.amazonaws.redshift#SecondaryClusterInfo": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The name of the Availability Zone in which the secondary compute unit of the cluster is located.
" + } + }, + "ClusterNodes": { + "target": "com.amazonaws.redshift#ClusterNodesList", + "traits": { + "smithy.api#documentation": "The nodes in the secondary compute unit.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The AvailabilityZone and ClusterNodes information of the secondary compute unit.
" + } + }, "com.amazonaws.redshift#SensitiveString": { "type": "string", "traits": { @@ -17182,6 +17823,9 @@ }, { "target": "com.amazonaws.redshift#UnauthorizedPartnerIntegrationFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -17557,6 +18201,53 @@ "smithy.api#xmlName": "VpcSecurityGroup" } } + }, + "com.amazonaws.redshift#ZeroETLIntegrationStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "SYNCING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "syncing" + } + }, + "NEEDS_ATTENTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "needs_attention" + } + } + } } } } diff --git a/codegen/sdk/aws-models/s3-control.json b/codegen/sdk/aws-models/s3-control.json index 44b0018d490..6d616e76cbe 100644 --- a/codegen/sdk/aws-models/s3-control.json +++ b/codegen/sdk/aws-models/s3-control.json @@ -48,6 +48,9 @@ { "target": "com.amazonaws.s3control#CreateMultiRegionAccessPoint" }, + { + "target": "com.amazonaws.s3control#CreateStorageLensGroup" + }, { "target": "com.amazonaws.s3control#DeleteAccessPoint" }, @@ -90,6 +93,9 @@ { "target": "com.amazonaws.s3control#DeleteStorageLensConfigurationTagging" }, + { + "target": "com.amazonaws.s3control#DeleteStorageLensGroup" + }, { "target": "com.amazonaws.s3control#DescribeJob" }, @@ -159,6 +165,9 @@ { "target": "com.amazonaws.s3control#GetStorageLensConfigurationTagging" }, + { + "target": "com.amazonaws.s3control#GetStorageLensGroup" + }, { "target": "com.amazonaws.s3control#ListAccessPoints" }, @@ -177,6 +186,12 @@ { "target": "com.amazonaws.s3control#ListStorageLensConfigurations" }, + { + "target": "com.amazonaws.s3control#ListStorageLensGroups" + }, + { + "target": "com.amazonaws.s3control#ListTagsForResource" + }, { "target": "com.amazonaws.s3control#PutAccessPointConfigurationForObjectLambda" }, @@ -219,11 +234,20 @@ { "target": "com.amazonaws.s3control#SubmitMultiRegionAccessPointRoutes" }, + { + "target": "com.amazonaws.s3control#TagResource" + }, + { + "target": "com.amazonaws.s3control#UntagResource" + }, { "target": "com.amazonaws.s3control#UpdateJobPriority" }, { "target": "com.amazonaws.s3control#UpdateJobStatus" + }, + { + "target": "com.amazonaws.s3control#UpdateStorageLensGroup" } ], "traits": { @@ -6082,37 +6106,43 @@ "ActivityMetrics": { "target": "com.amazonaws.s3control#ActivityMetrics", "traits": { - "smithy.api#documentation": "A container for S3 Storage Lens activity metrics.
" + "smithy.api#documentation": "A container element for S3 Storage Lens activity metrics.
" } }, "BucketLevel": { "target": "com.amazonaws.s3control#BucketLevel", "traits": { - "smithy.api#documentation": "A container for the S3 Storage Lens bucket-level configuration.
", + "smithy.api#documentation": "A container element for the S3 Storage Lens bucket-level configuration.
", "smithy.api#required": {} } }, "AdvancedCostOptimizationMetrics": { "target": "com.amazonaws.s3control#AdvancedCostOptimizationMetrics", "traits": { - "smithy.api#documentation": "A container for S3 Storage Lens advanced cost-optimization metrics.
" + "smithy.api#documentation": "A container element for S3 Storage Lens advanced cost-optimization metrics.
" } }, "AdvancedDataProtectionMetrics": { "target": "com.amazonaws.s3control#AdvancedDataProtectionMetrics", "traits": { - "smithy.api#documentation": "A container for S3 Storage Lens advanced data-protection metrics.
" + "smithy.api#documentation": "A container element for S3 Storage Lens advanced data-protection metrics.
" } }, "DetailedStatusCodesMetrics": { "target": "com.amazonaws.s3control#DetailedStatusCodesMetrics", "traits": { - "smithy.api#documentation": "A container for detailed status code metrics.
" + "smithy.api#documentation": "A container element for detailed status code metrics.
" + } + }, + "StorageLensGroupLevel": { + "target": "com.amazonaws.s3control#StorageLensGroupLevel", + "traits": { + "smithy.api#documentation": "\nA container element for S3 Storage Lens groups metrics.\n
" } } }, "traits": { - "smithy.api#documentation": "A container for the account-level Amazon S3 Storage Lens configuration.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
" + "smithy.api#documentation": "A container element for the account-level Amazon S3 Storage Lens configuration.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#ActivityMetrics": { @@ -7186,6 +7216,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.s3control#CreateStorageLensGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#CreateStorageLensGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An\n S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags,\n object size, object age, or a combination of these filters. For each Storage Lens group\n that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information\n about S3 Storage Lens groups, see Working with S3 Storage Lens\n groups.
\nTo use this operation, you must have the permission to perform the\n s3:CreateStorageLensGroup action. If you’re trying to create a Storage Lens\n group with Amazon Web Services resource tags, you must also have permission to perform the\n s3:TagResource action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/v20180820/storagelensgroup", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "RequiresAccountId": { + "value": true + } + } + } + }, + "com.amazonaws.s3control#CreateStorageLensGroupRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "\nThe Amazon Web Services account ID that the Storage Lens group is created from and associated with.\n
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "StorageLensGroup": { + "target": "com.amazonaws.s3control#StorageLensGroup", + "traits": { + "smithy.api#documentation": "\nThe Storage Lens group configuration.\n
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.s3control#TagList", + "traits": { + "smithy.api#documentation": "\nThe Amazon Web Services resource tags that you're adding to your Storage Lens group. This parameter is optional.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.s3control#CreationDate": { "type": "timestamp" }, @@ -7459,7 +7547,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete\n an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.
\nDeletes the lifecycle configuration from the specified Outposts bucket.\n Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource\n associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer\n automatically deletes any objects on the basis of rules contained in the deleted lifecycle\n configuration. For more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket\n owner has this permission and the Outposts bucket owner can grant this permission to\n others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\nThis action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete\n an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.
\nDeletes the lifecycle configuration from the specified Outposts bucket.\n Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource\n associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer\n automatically deletes any objects on the basis of rules contained in the deleted lifecycle\n configuration. For more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.
\nTo use this operation, you must have permission to perform the\n s3-outposts:PutLifecycleConfiguration action. By default, the bucket owner\n has this permission and the Outposts bucket owner can grant this permission to\n others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\n\nDeletes an existing S3 Storage Lens group.
\nTo use this operation, you must have the permission to perform the\n s3:DeleteStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/v20180820/storagelensgroup/{Name}", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "RequiresAccountId": { + "value": true + } + } + } + }, + "com.amazonaws.s3control#DeleteStorageLensGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.s3control#StorageLensGroupName", + "traits": { + "smithy.api#documentation": "\nThe name of the Storage Lens group that you're trying to delete.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "\nThe Amazon Web Services account ID used to create the Storage Lens group that you're trying to delete.\n
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.s3control#DescribeJob": { "type": "operation", "input": { @@ -9990,6 +10131,74 @@ "smithy.api#output": {} } }, + "com.amazonaws.s3control#GetStorageLensGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#GetStorageLensGroupRequest" + }, + "output": { + "target": "com.amazonaws.s3control#GetStorageLensGroupResult" + }, + "traits": { + "smithy.api#documentation": "\nRetrieves the Storage Lens group configuration details.
\nTo use this operation, you must have the permission to perform the\n s3:GetStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/v20180820/storagelensgroup/{Name}", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "RequiresAccountId": { + "value": true + } + } + } + }, + "com.amazonaws.s3control#GetStorageLensGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.s3control#StorageLensGroupName", + "traits": { + "smithy.api#documentation": "\nThe name of the Storage Lens group that you're trying to retrieve the configuration details for.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "\nThe Amazon Web Services account ID associated with the Storage Lens group that you're trying to retrieve the details for.\n
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3control#GetStorageLensGroupResult": { + "type": "structure", + "members": { + "StorageLensGroup": { + "target": "com.amazonaws.s3control#StorageLensGroup", + "traits": { + "smithy.api#documentation": "\nThe name of the Storage Lens group that you're trying to retrieve the configuration details for.\n
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.s3control#GrantFullControl": { "type": "string" }, @@ -11635,86 +11844,330 @@ "smithy.api#output": {} } }, - "com.amazonaws.s3control#Location": { - "type": "string" - }, - "com.amazonaws.s3control#MFA": { - "type": "string" - }, - "com.amazonaws.s3control#MFADelete": { - "type": "enum", + "com.amazonaws.s3control#ListStorageLensGroupEntry": { + "type": "structure", "members": { - "Enabled": { - "target": "smithy.api#Unit", + "Name": { + "target": "com.amazonaws.s3control#StorageLensGroupName", "traits": { - "smithy.api#enumValue": "Enabled" + "smithy.api#documentation": "\nContains the name of the Storage Lens group that exists in the specified home Region.\n
", + "smithy.api#required": {} } }, - "Disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disabled" - } - } - } - }, - "com.amazonaws.s3control#MFADeleteStatus": { - "type": "enum", - "members": { - "Enabled": { - "target": "smithy.api#Unit", + "StorageLensGroupArn": { + "target": "com.amazonaws.s3control#StorageLensGroupArn", "traits": { - "smithy.api#enumValue": "Enabled" + "smithy.api#documentation": "\nContains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.\n
", + "smithy.api#required": {} } }, - "Disabled": { - "target": "smithy.api#Unit", + "HomeRegion": { + "target": "com.amazonaws.s3control#S3AWSRegion", "traits": { - "smithy.api#enumValue": "Disabled" + "smithy.api#documentation": "\nContains the Amazon Web Services Region where the Storage Lens group was created.\n
", + "smithy.api#required": {} } } - } - }, - "com.amazonaws.s3control#ManifestPrefixString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.s3control#MaxLength1024String": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } + "smithy.api#documentation": "\nEach entry contains a Storage Lens group that exists in the specified home Region.\n
" } }, - "com.amazonaws.s3control#MaxResults": { - "type": "integer", + "com.amazonaws.s3control#ListStorageLensGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#ListStorageLensGroupsRequest" + }, + "output": { + "target": "com.amazonaws.s3control#ListStorageLensGroupsResult" + }, "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 1000 + "smithy.api#documentation": "\nLists all the Storage Lens groups in the specified home Region.\n
\nTo use this operation, you must have the permission to perform the\n s3:ListStorageLensGroups action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/v20180820/storagelensgroup", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken" + }, + "smithy.rules#staticContextParams": { + "RequiresAccountId": { + "value": true + } } } }, - "com.amazonaws.s3control#Metrics": { + "com.amazonaws.s3control#ListStorageLensGroupsRequest": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.s3control#MetricsStatus", + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "Specifies whether replication metrics are enabled.
", - "smithy.api#required": {} - } - }, - "EventThreshold": { - "target": "com.amazonaws.s3control#ReplicationTimeValue", + "smithy.api#documentation": "\n The Amazon Web Services account ID that owns the Storage Lens groups.\n
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "NextToken": { + "target": "com.amazonaws.s3control#ContinuationToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.\n
\n If NextToken is returned, there are more Storage Lens groups results available. The value of NextToken is a\n unique pagination token for each page. Make the call again using the returned token to\n retrieve the next page. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours.\n
\nThe list of Storage Lens groups that exist in the specified home Region.\n
", + "smithy.api#xmlFlattened": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3control#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.s3control#ListTagsForResourceResult" + }, + "traits": { + "smithy.api#documentation": "This operation allows you to list all the Amazon Web Services resource tags for the specified\n resource.
\nTo use this operation, you must have the permission to perform the\n s3:ListTagsForResource action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
\nThis operation is only supported for S3 Storage Lens\n groups.
\n\nThe Amazon Web Services account ID of the resource owner.\n
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "ResourceArn": { + "target": "com.amazonaws.s3control#S3ResourceArn", + "traits": { + "smithy.api#documentation": "\nThe Amazon Resource Name (ARN) of the S3 resource that you want to list the tags for.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3control#ListTagsForResourceResult": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.s3control#TagList", + "traits": { + "smithy.api#documentation": "\nThe Amazon Web Services resource tags that are associated with the resource.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.s3control#Location": { + "type": "string" + }, + "com.amazonaws.s3control#MFA": { + "type": "string" + }, + "com.amazonaws.s3control#MFADelete": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3control#MFADeleteStatus": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + } + } + }, + "com.amazonaws.s3control#ManifestPrefixString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.s3control#MatchAnyPrefix": { + "type": "list", + "member": { + "target": "com.amazonaws.s3control#Prefix", + "traits": { + "smithy.api#xmlName": "Prefix" + } + } + }, + "com.amazonaws.s3control#MatchAnySuffix": { + "type": "list", + "member": { + "target": "com.amazonaws.s3control#Suffix", + "traits": { + "smithy.api#xmlName": "Suffix" + } + } + }, + "com.amazonaws.s3control#MatchAnyTag": { + "type": "list", + "member": { + "target": "com.amazonaws.s3control#S3Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + } + }, + "com.amazonaws.s3control#MatchObjectAge": { + "type": "structure", + "members": { + "DaysGreaterThan": { + "target": "com.amazonaws.s3control#ObjectAgeValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\nSpecifies the maximum object age in days. Must be a positive whole number, greater than the minimum object age and less than or equal to 2,147,483,647. \n
" + } + }, + "DaysLessThan": { + "target": "com.amazonaws.s3control#ObjectAgeValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\nSpecifies the minimum object age in days. The value must be a positive whole number, greater than 0 and less than or equal to 2,147,483,647.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n A filter condition that specifies the object age range of included objects in days. Only integers are supported.\n
" + } + }, + "com.amazonaws.s3control#MatchObjectSize": { + "type": "structure", + "members": { + "BytesGreaterThan": { + "target": "com.amazonaws.s3control#ObjectSizeValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\nSpecifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.\n
" + } + }, + "BytesLessThan": { + "target": "com.amazonaws.s3control#ObjectSizeValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\nSpecifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nA filter condition that specifies the object size range of included objects in bytes. Only integers are supported.\n
" + } + }, + "com.amazonaws.s3control#MaxLength1024String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.s3control#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.s3control#Metrics": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3control#MetricsStatus", + "traits": { + "smithy.api#documentation": "Specifies whether replication metrics are enabled.
", + "smithy.api#required": {} + } + }, + "EventThreshold": { + "target": "com.amazonaws.s3control#ReplicationTimeValue", "traits": { "smithy.api#documentation": "A container that specifies the time threshold for emitting the\n s3:Replication:OperationMissedThreshold event.
This is not supported by Amazon S3 on Outposts buckets.
\nIndicates the algorithm\n that\n you want Amazon S3 to use to create the checksum. For more\n information,\n see Checking object integrity in the Amazon S3 User Guide.
" + "smithy.api#documentation": "Indicates the algorithm\n that\n you want Amazon S3 to use to create the checksum. For more\n information,\n see Checking object integrity in the Amazon S3 User Guide.
" } } }, @@ -14825,6 +15290,16 @@ "smithy.api#documentation": "Directs the specified job to invoke ReplicateObject on every object in the\n job's manifest.
A container for the encryption of the S3 Storage Lens metrics exports.
" } }, - "com.amazonaws.s3control#StorageLensPrefixLevelDelimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.s3control#StorageLensPrefixLevelMaxDepth": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.s3control#StorageLensTag": { + "com.amazonaws.s3control#StorageLensGroup": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.s3control#TagKeyString", + "Name": { + "target": "com.amazonaws.s3control#StorageLensGroupName", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "\nContains the name of the Storage Lens group.\n
", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3control#StorageLensGroupFilter", + "traits": { + "smithy.api#documentation": "Sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the AND or OR\n logical operator is used.
\nContains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "A custom grouping of objects that include filters for prefixes, suffixes, object tags,\n object size, or object age. You can create an S3 Storage Lens group that includes a single\n filter or multiple filter conditions. To specify multiple filter conditions, you use\n AND or OR logical operators.
\n Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.\n
" + } + }, + "MatchAnySuffix": { + "target": "com.amazonaws.s3control#MatchAnySuffix", + "traits": { + "smithy.api#documentation": "\n Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.\n
" + } + }, + "MatchAnyTag": { + "target": "com.amazonaws.s3control#MatchAnyTag", + "traits": { + "smithy.api#documentation": "\n Contains the list of object tags. At least one object tag must be specified. Up to 10 object tags are allowed.\n
" + } + }, + "MatchObjectAge": { + "target": "com.amazonaws.s3control#MatchObjectAge", + "traits": { + "smithy.api#documentation": "\n Contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).\n
\n Contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).\n
\nA logical operator that allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data.\n
" + } + }, + "com.amazonaws.s3control#StorageLensGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1024 + }, + "smithy.api#pattern": "^arn:[a-z\\-]+:s3:[a-z0-9\\-]+:\\d{12}:storage\\-lens\\-group\\/" + } + }, + "com.amazonaws.s3control#StorageLensGroupFilter": { + "type": "structure", + "members": { + "MatchAnyPrefix": { + "target": "com.amazonaws.s3control#MatchAnyPrefix", + "traits": { + "smithy.api#documentation": "\n Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.\n
" + } + }, + "MatchAnySuffix": { + "target": "com.amazonaws.s3control#MatchAnySuffix", + "traits": { + "smithy.api#documentation": "\n Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.\n
" + } + }, + "MatchAnyTag": { + "target": "com.amazonaws.s3control#MatchAnyTag", + "traits": { + "smithy.api#documentation": "\n Contains the list of S3 object tags. At least one object tag must be specified. Up to 10 object tags are allowed.\n
" + } + }, + "MatchObjectAge": { + "target": "com.amazonaws.s3control#MatchObjectAge", + "traits": { + "smithy.api#documentation": "\n Contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).\n
\n Contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).\n
A logical operator that allows multiple filter conditions to be joined for more complex\n comparisons of Storage Lens group data. Objects must match all of the listed filter\n conditions that are joined by the And logical operator. Only one of each filter condition\n is allowed.
A single logical operator that allows multiple filter conditions to be joined. Objects\n can match any of the listed filter conditions, which are joined by the Or logical operator.\n Only one of each filter condition is allowed.
The filter element sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the AND or OR\n logical operator is used.
\n Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nSpecifies the Storage Lens groups to include in the Storage Lens group aggregation.\n
" + } + }, + "com.amazonaws.s3control#StorageLensGroupLevelExclude": { + "type": "list", + "member": { + "target": "com.amazonaws.s3control#StorageLensGroupArn", + "traits": { + "smithy.api#xmlName": "Arn" + } + } + }, + "com.amazonaws.s3control#StorageLensGroupLevelInclude": { + "type": "list", + "member": { + "target": "com.amazonaws.s3control#StorageLensGroupArn", + "traits": { + "smithy.api#xmlName": "Arn" + } + } + }, + "com.amazonaws.s3control#StorageLensGroupLevelSelectionCriteria": { + "type": "structure", + "members": { + "Include": { + "target": "com.amazonaws.s3control#StorageLensGroupLevelInclude", + "traits": { + "smithy.api#documentation": "\nIndicates which Storage Lens group ARNs to include in the Storage Lens group aggregation.\n
" + } + }, + "Exclude": { + "target": "com.amazonaws.s3control#StorageLensGroupLevelExclude", + "traits": { + "smithy.api#documentation": "Indicates which Storage Lens group ARNs to exclude from the Storage Lens group\n aggregation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group\n aggregation. You can only attach Storage Lens groups to your Storage Lens dashboard if\n they're included in your Storage Lens group aggregation. If this value is left null, then\n all Storage Lens groups are selected.
" + } + }, + "com.amazonaws.s3control#StorageLensGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3control#ListStorageLensGroupEntry", + "traits": { + "smithy.api#xmlName": "StorageLensGroup" + } + } + }, + "com.amazonaws.s3control#StorageLensGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.s3control#StorageLensGroupOrOperator": { + "type": "structure", + "members": { + "MatchAnyPrefix": { + "target": "com.amazonaws.s3control#MatchAnyPrefix", + "traits": { + "smithy.api#documentation": "Filters objects that match any of the specified prefixes.
" + } + }, + "MatchAnySuffix": { + "target": "com.amazonaws.s3control#MatchAnySuffix", + "traits": { + "smithy.api#documentation": "\nFilters objects that match any of the specified suffixes.\n
" + } + }, + "MatchAnyTag": { + "target": "com.amazonaws.s3control#MatchAnyTag", + "traits": { + "smithy.api#documentation": "\nFilters objects that match any of the specified S3 object tags.\n
" + } + }, + "MatchObjectAge": { + "target": "com.amazonaws.s3control#MatchObjectAge", + "traits": { + "smithy.api#documentation": "\nFilters objects that match the specified object age range.\n
" + } + }, + "MatchObjectSize": { + "target": "com.amazonaws.s3control#MatchObjectSize", + "traits": { + "smithy.api#documentation": "\nFilters objects that match the specified object size range.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "A container element for specifying Or rule conditions. The rule conditions\n determine the subset of objects to which the Or rule applies. Objects can\n match any of the listed filter conditions, which are joined by the Or logical operator.\n Only one of each filter condition is allowed.
The tag key for your Amazon Web Services resource. A tag key can be up to 128 Unicode characters in\n length and is case-sensitive. System created tags that begin with aws: aren’t supported.\n
\n The tag value for your Amazon Web Services resource. A tag value can be up to 256 Unicode characters in length and is case-sensitive.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n An Amazon Web Services resource tag that's associated with your S3 resource. You can add tags to new objects when you upload them, or you can add object tags to existing objects. \n
\nThis data type is only supported for S3 Storage Lens groups.
\nCreates a new Amazon Web Services resource tag or updates an existing resource tag. You can add up to\n 50 Amazon Web Services resource tags for each S3 resource.
\nTo use this operation, you must have the permission to perform the\n s3:TagResource action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
\nThis operation is only supported for S3 Storage Lens groups.
\n\nThe Amazon Web Services account ID that created the S3 resource that you're trying to add tags to. \n
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "ResourceArn": { + "target": "com.amazonaws.s3control#S3ResourceArn", + "traits": { + "smithy.api#documentation": "\nThe Amazon Resource Name (ARN) of the S3 resource that you're trying to add tags to.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.s3control#TagList", + "traits": { + "smithy.api#documentation": "\nThe Amazon Web Services resource tags that you want to add to the specified S3 resource.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3control#TagResourceResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.s3control#TagValueString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 1024 + "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } @@ -15569,6 +16398,74 @@ } } }, + "com.amazonaws.s3control#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.s3control#UntagResourceResult" + }, + "traits": { + "smithy.api#documentation": "This operation removes the specified Amazon Web Services resource tags from an S3 resource.
\nTo use this operation, you must have the permission to perform the\n s3:UntagResource action. For more information about the required Storage\n Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about S3 Tagging errors, see List of Amazon S3\n Tagging error codes.
\nThis operation is only supported for S3 Storage Lens\n groups.
\n\nThe Amazon Web Services account ID that owns the resource that you're trying to remove the tags from.\n
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "ResourceArn": { + "target": "com.amazonaws.s3control#S3ResourceArn", + "traits": { + "smithy.api#documentation": "\nThe Amazon Resource Name (ARN) of the S3 resource that you want to remove the resource tags from.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.s3control#TagKeyList", + "traits": { + "smithy.api#documentation": "\nThe tag key pair of the S3 resource tag that you're trying to remove.\n
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.s3control#UntagResourceResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.s3control#UpdateJobPriority": { "type": "operation", "input": { @@ -15779,6 +16676,66 @@ "smithy.api#output": {} } }, + "com.amazonaws.s3control#UpdateStorageLensGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3control#UpdateStorageLensGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "\nUpdates the existing Storage Lens group.
\nTo use this operation, you must have the permission to perform the\n s3:UpdateStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, + "smithy.api#http": { + "method": "PUT", + "uri": "/v20180820/storagelensgroup/{Name}", + "code": 204 + }, + "smithy.rules#staticContextParams": { + "RequiresAccountId": { + "value": true + } + } + } + }, + "com.amazonaws.s3control#UpdateStorageLensGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.s3control#StorageLensGroupName", + "traits": { + "smithy.api#documentation": "\nThe name of the Storage Lens group that you want to update.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "\nThe Amazon Web Services account ID of the Storage Lens group owner.\n
", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "AccountId" + } + } + }, + "StorageLensGroup": { + "target": "com.amazonaws.s3control#StorageLensGroup", + "traits": { + "smithy.api#documentation": "\nThe JSON file that contains the Storage Lens group configuration.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.s3control#VersioningConfiguration": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index 7e1a5236dcf..9ae747f5e7f 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -1363,6 +1363,24 @@ "traits": { "smithy.api#enumValue": "ml.p4de.24xlarge" } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } } } }, @@ -16026,6 +16044,12 @@ "smithy.api#documentation": "The IAM Identity Center managed application instance ID.
" } }, + "SingleSignOnApplicationArn": { + "target": "com.amazonaws.sagemaker#SingleSignOnApplicationArn", + "traits": { + "smithy.api#documentation": "The ARN of the associated Amazon Web Services Single Sign-On application\n for this Domain.
" + } + }, "Status": { "target": "com.amazonaws.sagemaker#DomainStatus", "traits": { @@ -22168,7 +22192,7 @@ "min": 1, "max": 40 }, - "smithy.api#pattern": "^[\\S\\s]+$" + "smithy.api#pattern": "^[-a-zA-Z0-9_.,;:! ]*$" } }, "com.amazonaws.sagemaker#DeviceFleetArn": { @@ -22184,7 +22208,7 @@ "min": 1, "max": 800 }, - "smithy.api#pattern": "^[\\S\\s]+$" + "smithy.api#pattern": "^[-a-zA-Z0-9_.,;:! ]*$" } }, "com.amazonaws.sagemaker#DeviceFleetSummaries": { @@ -38494,6 +38518,16 @@ } } }, + "com.amazonaws.sagemaker#MaxPendingTimeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Maximum job scheduler pending time in seconds.", + "smithy.api#range": { + "min": 7200, + "max": 2419200 + } + } + }, "com.amazonaws.sagemaker#MaxPercentageOfInputDatasetLabeled": { "type": "integer", "traits": { @@ -40912,9 +40946,7 @@ "ModelPackageName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model package.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the model package.
" } }, "ModelPackageGroupName": { @@ -42076,7 +42108,7 @@ "min": 1, "max": 63 }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" } }, "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey": { @@ -44794,7 +44826,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$" + "smithy.api#pattern": "^[A-Za-z0-9\\-_]*$" } }, "com.amazonaws.sagemaker#PipelineStatus": { @@ -53189,6 +53221,12 @@ "smithy.api#documentation": "A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, the results of the S3 key prefix\n matches are shuffled. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.
For Pipe input mode, when ShuffleConfig is specified shuffling is done at\n the start of every epoch. With large datasets, this ensures that the order of the\n training data is different for each epoch, and it helps reduce bias and possible\n overfitting. In a multi-node training job when ShuffleConfig is combined\n with S3DataDistributionType of ShardedByS3Key, the data is\n shuffled across nodes so that the content sent to a particular node on the first epoch\n 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\n complete. It is the amount of time spent waiting for Spot capacity plus the amount of\n time the job can run. It must be equal to or greater than\n MaxRuntimeInSeconds. If the job does not complete during this time,\n SageMaker ends the job.
When RetryStrategy is specified in the job request,\n MaxWaitTimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt.
The maximum pending time in seconds.
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/ssm-incidents.json b/codegen/sdk/aws-models/ssm-incidents.json index 1dbe2a05c88..5cc6a2fadff 100644 --- a/codegen/sdk/aws-models/ssm-incidents.json +++ b/codegen/sdk/aws-models/ssm-incidents.json @@ -123,6 +123,132 @@ } } }, + "com.amazonaws.ssmincidents#BatchGetIncidentFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindingsInput" + }, + "output": { + "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmincidents#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmincidents#InternalServerException" + }, + { + "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmincidents#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmincidents#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding\n represents a recent application environment change made by an CodeDeploy\n deployment or an CloudFormation stack creation or update that can be investigated as a\n potential cause of the incident.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/batchGetIncidentFindings" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmincidents#BatchGetIncidentFindingsError": { + "type": "structure", + "members": { + "findingId": { + "target": "com.amazonaws.ssmincidents#FindingId", + "traits": { + "smithy.api#documentation": "The ID of a specified finding for which an error was returned for a\n BatchGetIncidentFindings operation.
The code associated with an error that was returned for a\n BatchGetIncidentFindings operation.
The description for an error that was returned for a BatchGetIncidentFindings\n operation.
Details about an error returned for a BatchGetIncidentFindings\n operation.
" + } + }, + "com.amazonaws.ssmincidents#BatchGetIncidentFindingsErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindingsError" + } + }, + "com.amazonaws.ssmincidents#BatchGetIncidentFindingsInput": { + "type": "structure", + "members": { + "incidentRecordArn": { + "target": "com.amazonaws.ssmincidents#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the incident for which you want to view finding\n details.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "logs_required" + ] + } + }, + "findingIds": { + "target": "com.amazonaws.ssmincidents#FindingIdList", + "traits": { + "smithy.api#documentation": "A list of IDs of findings for which you want to view details.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmincidents#BatchGetIncidentFindingsOutput": { + "type": "structure", + "members": { + "findings": { + "target": "com.amazonaws.ssmincidents#FindingList", + "traits": { + "smithy.api#documentation": "Information about the requested findings.
", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindingsErrorList", + "traits": { + "smithy.api#documentation": "A list of errors encountered during the operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssmincidents#ChatChannel": { "type": "union", "members": { @@ -169,6 +295,81 @@ } } }, + "com.amazonaws.ssmincidents#CloudFormationStackUpdate": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the CloudFormation stack creation or update began.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the CloudFormation stack creation or update ended. Not reported\n for deployments that are still in progress.
" + } + }, + "stackArn": { + "target": "com.amazonaws.ssmincidents#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CloudFormation stack involved in the\n update.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "logs_investigations" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Information about an CloudFormation stack creation or update that occurred around\n the time of an incident and could be a potential cause of the incident.
" + } + }, + "com.amazonaws.ssmincidents#CodeDeployDeployment": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the CodeDeploy deployment began.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the CodeDeploy deployment ended. Not reported for\n deployments that are still in progress.
" + } + }, + "deploymentGroupArn": { + "target": "com.amazonaws.ssmincidents#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CodeDeploy deployment group associated with\n the deployment.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "logs_investigations" + ] + } + }, + "deploymentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the CodeDeploy deployment.
", + "smithy.api#length": { + "max": 128 + }, + "smithy.api#required": {}, + "smithy.api#tags": [ + "logs_investigations" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a CodeDeploy deployment that occurred around the time of an\n incident and could be a possible cause of the incident.
" + } + }, "com.amazonaws.ssmincidents#Condition": { "type": "union", "members": { @@ -494,7 +695,7 @@ "eventTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time that the event occurred.
", + "smithy.api#documentation": "The timestamp for when the event occurred.
", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" @@ -504,7 +705,7 @@ "eventType": { "target": "com.amazonaws.ssmincidents#TimelineEventType", "traits": { - "smithy.api#documentation": "The type of event. You can create timeline events of type Custom\n Event.
The type of event. You can create timeline events of type Custom Event and\n Note.
To make a Note-type event appear on the Incident notes panel in the\n console, specify eventType as Noteand enter the Amazon Resource Name\n (ARN) of the incident as the value for eventReference.
The time that the event occurred.
", + "smithy.api#documentation": "The timestamp for when the event occurred.
", "smithy.api#required": {} } }, "eventUpdatedTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time that the timeline event was last updated.
", + "smithy.api#documentation": "The timestamp for when the timeline event was last updated.
", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.ssmincidents#TimelineEventType", "traits": { - "smithy.api#documentation": "The type of event. The timeline event must be Custom Event.
The type of event. The timeline event must be Custom Event or\n Note.
The ID assigned to the finding.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "logs_investigations" + ] + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when a finding was created.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the finding was most recently updated with additional\n information.
", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.ssmincidents#FindingDetails", + "traits": { + "smithy.api#documentation": "Details about the finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a specific CodeDeploy deployment or CloudFormation\n stack creation or update that occurred around the time of a reported incident. These\n activities can be investigated as a potential cause of the incident.
" + } + }, + "com.amazonaws.ssmincidents#FindingDetails": { + "type": "union", + "members": { + "codeDeployDeployment": { + "target": "com.amazonaws.ssmincidents#CodeDeployDeployment", + "traits": { + "smithy.api#documentation": "Information about the CodeDeploy deployment associated with the finding.
" + } + }, + "cloudFormationStackUpdate": { + "target": "com.amazonaws.ssmincidents#CloudFormationStackUpdate", + "traits": { + "smithy.api#documentation": "Information about the CloudFormation stack creation or update associated with the\n finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Extended textual information about the finding.
" + } + }, + "com.amazonaws.ssmincidents#FindingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + } + } + }, + "com.amazonaws.ssmincidents#FindingIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmincidents#FindingId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.ssmincidents#FindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmincidents#Finding" + } + }, + "com.amazonaws.ssmincidents#FindingSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.ssmincidents#FindingId", + "traits": { + "smithy.api#documentation": "The ID of the finding.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "logs_investigations" + ] + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp for when the finding was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Identifying information about the finding.
" + } + }, + "com.amazonaws.ssmincidents#FindingSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmincidents#FindingSummary" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, "com.amazonaws.ssmincidents#GeneratedId": { "type": "string", "traits": { @@ -1344,7 +1665,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
", + "smithy.api#documentation": "The pagination token for the next set of items to return. (You received this token from a\n previous call.)
", "smithy.api#tags": [ "logs_investigations" ] @@ -1365,7 +1686,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
" + "smithy.api#documentation": "The pagination token to use when requesting the next set of items. If there are no\n additional items to return, the string is null.
" } } } @@ -1593,27 +1914,27 @@ "impact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { - "smithy.api#documentation": "The impact of the incident on customers and applications.
", + "smithy.api#documentation": "The impact of the incident on customers and applications.
\n\n Supported impact codes\n
\n\n 1 - Critical
\n 2 - High
\n 3 - Medium
\n 4 - Low
\n 5 - No Impact
The time that Incident Manager created the incident record.
", + "smithy.api#documentation": "The timestamp for when Incident Manager created the incident record.
", "smithy.api#required": {} } }, "resolvedTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the incident was resolved. This appears as a timeline event.
" + "smithy.api#documentation": "The timestamp for when the incident was resolved. This appears as a timeline event.
" } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the incident was most recently modified.
", + "smithy.api#documentation": "The timestamp for when the incident was most recently modified.
", "smithy.api#required": {} } }, @@ -1756,14 +2077,14 @@ "creationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time the incident was created.
", + "smithy.api#documentation": "The timestamp for when the incident was created.
", "smithy.api#required": {} } }, "resolvedTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time the incident was resolved.
" + "smithy.api#documentation": "The timestamp for when the incident was resolved.
" } }, "incidentRecordSource": { @@ -1818,7 +2139,7 @@ "impact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { - "smithy.api#documentation": "The impact of the incident on your customers and applications.
", + "smithy.api#documentation": "The impact of the incident on your customers and applications.
\n\n Supported impact codes\n
\n\n 1 - Critical
\n 2 - High
\n 3 - Medium
\n 4 - Low
\n 5 - No Impact
Used to stop Incident Manager from creating multiple incident records for the same incident.\n
", + "smithy.api#documentation": "The string Incident Manager uses to prevent the same root cause from creating multiple\n incidents in the same account.
\nA deduplication string is a term or phrase the system uses to check for duplicate\n incidents. If you specify a deduplication string, Incident Manager searches for open incidents that\n contain the same string in the dedupeString field when it creates the incident.\n If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing\n incident.
By default, Incident Manager automatically deduplicates multiple incidents created by the\n same Amazon CloudWatch alarm or Amazon EventBridge event. You don't have to enter\n your own deduplication string to prevent duplication for these resource types.
\nDescribes a related item.
" } }, + "com.amazonaws.ssmincidents#ListIncidentFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmincidents#ListIncidentFindingsInput" + }, + "output": { + "target": "com.amazonaws.ssmincidents#ListIncidentFindingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmincidents#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmincidents#InternalServerException" + }, + { + "target": "com.amazonaws.ssmincidents#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmincidents#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmincidents#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of the IDs of findings, plus their last modified times, that have been\n identified for a specified incident. A finding represents a recent application environment\n change made by an CloudFormation stack creation or update or an CodeDeploy\n deployment that can be investigated as a potential cause of the incident.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/listIncidentFindings" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "findings" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmincidents#ListIncidentFindingsInput": { + "type": "structure", + "members": { + "incidentRecordArn": { + "target": "com.amazonaws.ssmincidents#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the incident for which you want to view associated\n findings.
", + "smithy.api#required": {}, + "smithy.api#tags": [ + "logs_required" + ] + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of findings to retrieve per call.
", + "smithy.api#range": { + "min": 1, + "max": 20 + }, + "smithy.api#tags": [ + "logs_investigations" + ] + } + }, + "nextToken": { + "target": "com.amazonaws.ssmincidents#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token for the next set of items to return. (You received this token from a\n previous call.)
", + "smithy.api#tags": [ + "logs_investigations" + ] + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmincidents#ListIncidentFindingsOutput": { + "type": "structure", + "members": { + "findings": { + "target": "com.amazonaws.ssmincidents#FindingSummaryList", + "traits": { + "smithy.api#documentation": "A list of findings that represent deployments that might be the potential cause of the\n incident.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ssmincidents#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token to use when requesting the next set of items. If there are no\n additional items to return, the string is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssmincidents#ListIncidentRecords": { "type": "operation", "input": { @@ -2081,7 +2504,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
", + "smithy.api#documentation": "The pagination token for the next set of items to return. (You received this token from a\n previous call.)
", "smithy.api#tags": [ "logs_investigations" ] @@ -2102,7 +2525,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
" + "smithy.api#documentation": "The pagination token to use when requesting the next set of items. If there are no\n additional items to return, the string is null.
" } } } @@ -2170,7 +2593,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
", + "smithy.api#documentation": "The pagination token for the next set of items to return. (You received this token from a\n previous call.)
", "smithy.api#tags": [ "logs_investigations" ] @@ -2191,7 +2614,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
" + "smithy.api#documentation": "The pagination token to use when requesting the next set of items. If there are no\n additional items to return, the string is null.
" } } } @@ -2249,7 +2672,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
", + "smithy.api#documentation": "The pagination token for the next set of items to return. (You received this token from a\n previous call.)
", "smithy.api#tags": [ "logs_investigations" ] @@ -2270,7 +2693,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
" + "smithy.api#documentation": "The pagination token to use when requesting the next set of items. If there are no\n additional items to return, the string is null.
" } } } @@ -2328,7 +2751,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
", + "smithy.api#documentation": "The pagination token for the next set of items to return. (You received this token from a\n previous call.)
", "smithy.api#tags": [ "logs_investigations" ] @@ -2349,7 +2772,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
" + "smithy.api#documentation": "The pagination token to use when requesting the next set of items. If there are no\n additional items to return, the string is null.
" } } } @@ -2380,7 +2803,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the tags that are attached to the specified response plan.
", + "smithy.api#documentation": "Lists the tags that are attached to the specified response plan or incident.
", "smithy.api#http": { "code": 200, "method": "GET", @@ -2395,7 +2818,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the response plan.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the response plan or incident.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#tags": [ @@ -2411,7 +2834,7 @@ "tags": { "target": "com.amazonaws.ssmincidents#TagMap", "traits": { - "smithy.api#documentation": "A list of tags for the response plan.
", + "smithy.api#documentation": "A list of tags for the response plan or incident.
", "smithy.api#required": {} } } @@ -2471,7 +2894,7 @@ "filters": { "target": "com.amazonaws.ssmincidents#FilterList", "traits": { - "smithy.api#documentation": "Filters the timeline events based on the provided conditional values. You can filter\n timeline events with the following keys:
\n\n eventTime\n
\n eventType\n
Note the following when deciding how to use Filters:
\nIf you don't specify a Filter, the response includes all timeline events.
\nIf you specify more than one filter in a single request, the response returns timeline\n events that match all filters.
\nIf you specify a filter with more than one value, the response returns timeline events\n that match any of the values provided.
\nFilters the timeline events based on the provided conditional values. You can filter\n timeline events with the following keys:
\n\n eventReference\n
\n eventTime\n
\n eventType\n
Note the following when deciding how to use Filters:
\nIf you don't specify a Filter, the response includes all timeline events.
\nIf you specify more than one filter in a single request, the response returns timeline\n events that match all filters.
\nIf you specify a filter with more than one value, the response returns timeline events\n that match any of the values provided.
\nThe pagination token to continue to the next page of results.
", + "smithy.api#documentation": "The pagination token for the next set of items to return. (You received this token from a\n previous call.)
", "smithy.api#tags": [ "logs_investigations" ] @@ -2525,7 +2948,7 @@ "nextToken": { "target": "com.amazonaws.ssmincidents#NextToken", "traits": { - "smithy.api#documentation": "The pagination token to continue to the next page of results.
" + "smithy.api#documentation": "The pagination token to use when requesting the next set of items. If there are no\n additional items to return, the string is null.
" } } } @@ -2795,7 +3218,7 @@ "statusUpdateDateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The most recent date and time that Incident Manager updated the Amazon Web Services Region's status.
", + "smithy.api#documentation": "The timestamp for when Incident Manager updated the status of the Amazon Web Services Region.
", "smithy.api#required": {} } } @@ -3212,6 +3635,9 @@ "type": "service", "version": "2018-05-10", "operations": [ + { + "target": "com.amazonaws.ssmincidents#BatchGetIncidentFindings" + }, { "target": "com.amazonaws.ssmincidents#CreateReplicationSet" }, @@ -3251,6 +3677,9 @@ { "target": "com.amazonaws.ssmincidents#GetTimelineEvent" }, + { + "target": "com.amazonaws.ssmincidents#ListIncidentFindings" + }, { "target": "com.amazonaws.ssmincidents#ListIncidentRecords" }, @@ -4436,7 +4865,7 @@ "impact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { - "smithy.api#documentation": "Defines the impact to the customers. Providing an impact overwrites the impact provided by\n a response plan.
\n\n Possible impacts:\n
\n\n 1 - Critical impact, this typically relates to full application failure\n that impacts many to all customers.
\n 2 - High impact, partial application failure with impact to many\n customers.
\n 3 - Medium impact, the application is providing reduced service to\n customers.
\n 4 - Low impact, customer might aren't impacted by the problem yet.
\n 5 - No impact, customers aren't currently impacted but urgent action is\n needed to avoid impact.
Defines the impact to the customers. Providing an impact overwrites the impact provided by\n a response plan.
\n\n Supported impact codes\n
\n\n 1 - Critical
\n 2 - High
\n 3 - Medium
\n 4 - Low
\n 5 - No Impact
The time that the event occurred.
", + "smithy.api#documentation": "The timestamp for when the event occurred.
", "smithy.api#required": {} } }, "eventUpdatedTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time that the timeline event was last updated.
", + "smithy.api#documentation": "The timestamp for when the timeline event was last updated.
", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.ssmincidents#TimelineEventType", "traits": { - "smithy.api#documentation": "The type of event that occurred. Currently Incident Manager supports only the Custom\n Event type.
The type of event that occurred. Currently Incident Manager supports only the Custom\n Event and Note types.
The time that the incident was detected.
", + "smithy.api#documentation": "The timestamp for when the incident was detected.
", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" @@ -5009,7 +5438,7 @@ "impact": { "target": "com.amazonaws.ssmincidents#Impact", "traits": { - "smithy.api#documentation": "Defines the impact of the incident to customers and applications. If you provide an impact\n for an incident, it overwrites the impact provided by the response plan.
\n\n Possible impacts:\n
\n\n 1 - Critical impact, full application failure that impacts many to all\n customers.
\n 2 - High impact, partial application failure with impact to many\n customers.
\n 3 - Medium impact, the application is providing reduced service to\n customers.
\n 4 - Low impact, customer aren't impacted by the problem yet.
\n 5 - No impact, customers aren't currently impacted but urgent action is\n needed to avoid impact.
Defines the impact of the incident to customers and applications. If you provide an impact\n for an incident, it overwrites the impact provided by the response plan.
\n\n Supported impact codes\n
\n\n 1 - Critical
\n 2 - High
\n 3 - Medium
\n 4 - Low
\n 5 - No Impact
Defines the impact to the customers. Providing an impact overwrites the impact provided by\n a response plan.
\n\n Possible impacts:\n
\n\n 5 - Severe impact
\n 4 - High impact
\n 3 - Medium impact
\n 2 - Low impact
\n 1 - No impact
Defines the impact to the customers. Providing an impact overwrites the impact provided by\n a response plan.
\n\n Supported impact codes\n
\n\n 1 - Critical
\n 2 - High
\n 3 - Medium
\n 4 - Low
\n 5 - No Impact
The time that the event occurred.
", + "smithy.api#documentation": "The timestamp for when the event occurred.
", "smithy.api#tags": [ "logs_investigations" ] @@ -5429,7 +5858,7 @@ "eventType": { "target": "com.amazonaws.ssmincidents#TimelineEventType", "traits": { - "smithy.api#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\n Note.
The ID of the application.
" } }, + "DiscoveryStatus": { + "target": "com.amazonaws.ssmsap#ApplicationDiscoveryStatus", + "traits": { + "smithy.api#documentation": "The status of the latest discovery.
" + } + }, "Type": { "target": "com.amazonaws.ssmsap#ApplicationType", "traits": { @@ -250,6 +285,12 @@ "traits": { "smithy.api#enumValue": "HANA" } + }, + "SAP_ABAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_ABAP" + } } } }, @@ -274,6 +315,12 @@ "smithy.api#documentation": "The ID of the Amazon EC2 instance.
" } }, + "IpAddresses": { + "target": "com.amazonaws.ssmsap#IpAddressList", + "traits": { + "smithy.api#documentation": "The IP addresses of the associated host.
" + } + }, "OsVersion": { "target": "smithy.api#String", "traits": { @@ -362,6 +409,18 @@ "smithy.api#documentation": "The ID of the component.
" } }, + "Sid": { + "target": "com.amazonaws.ssmsap#SID", + "traits": { + "smithy.api#documentation": "The SAP System Identifier of the application component.
" + } + }, + "SystemNumber": { + "target": "com.amazonaws.ssmsap#SAPInstanceNumber", + "traits": { + "smithy.api#documentation": "The SAP system number of the application component.
" + } + }, "ParentComponent": { "target": "com.amazonaws.ssmsap#ComponentId", "traits": { @@ -389,7 +448,7 @@ "Status": { "target": "com.amazonaws.ssmsap#ComponentStatus", "traits": { - "smithy.api#documentation": "The status of the component.
" + "smithy.api#documentation": "The status of the component.
\nACTIVATED - this status has been deprecated.
\nSTARTING - the component is in the process of being started.
\nSTOPPED - the component is not running.
\nSTOPPING - the component is in the process of being stopped.
\nRUNNING - the component is running.
\nRUNNING_WITH_ERROR - one or more child component(s) of the parent component is not\n running. Call \n GetComponent\n to review the status of each child\n component.
UNDEFINED - AWS Systems Manager for SAP cannot provide the component status\n based on the discovered information. Verify your SAP application.
\nThe hostname of the component.
" } }, + "SapFeature": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The SAP feature of the component.
" + } + }, "SapKernelVersion": { "target": "smithy.api#String", "traits": { @@ -446,6 +511,12 @@ "smithy.api#documentation": "The primary host of the component.
" } }, + "DatabaseConnection": { + "target": "com.amazonaws.ssmsap#DatabaseConnection", + "traits": { + "smithy.api#documentation": "The connection specifications for the database of the component.
" + } + }, "LastUpdated": { "target": "smithy.api#Timestamp", "traits": { @@ -580,6 +651,42 @@ "traits": { "smithy.api#enumValue": "HANA_NODE" } + }, + "ABAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABAP" + } + }, + "ASCS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCS" + } + }, + "DIALOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIALOG" + } + }, + "WEBDISP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEBDISP" + } + }, + "WD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WD" + } + }, + "ERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERS" + } } } }, @@ -681,6 +788,49 @@ "smithy.api#documentation": "The SAP HANA database of the application registered with AWS Systems Manager for\n SAP.
" } }, + "com.amazonaws.ssmsap#DatabaseConnection": { + "type": "structure", + "members": { + "DatabaseConnectionMethod": { + "target": "com.amazonaws.ssmsap#DatabaseConnectionMethod", + "traits": { + "smithy.api#documentation": "The method of connection.
" + } + }, + "DatabaseArn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the connected SAP HANA database.
" + } + }, + "ConnectionIp": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The IP address for connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The connection specifications for the database.
" + } + }, + "com.amazonaws.ssmsap#DatabaseConnectionMethod": { + "type": "enum", + "members": { + "DIRECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT" + } + }, + "OVERLAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERLAY" + } + } + } + }, "com.amazonaws.ssmsap#DatabaseId": { "type": "string", "traits": { @@ -885,6 +1035,9 @@ { "target": "com.amazonaws.ssmsap#InternalServerException" }, + { + "target": "com.amazonaws.ssmsap#UnauthorizedException" + }, { "target": "com.amazonaws.ssmsap#ValidationException" } @@ -1074,6 +1227,9 @@ { "target": "com.amazonaws.ssmsap#InternalServerException" }, + { + "target": "com.amazonaws.ssmsap#UnauthorizedException" + }, { "target": "com.amazonaws.ssmsap#ValidationException" } @@ -1412,6 +1568,38 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.ssmsap#IpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#IpAddressMember" + } + }, + "com.amazonaws.ssmsap#IpAddressMember": { + "type": "structure", + "members": { + "IpAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The IP address.
" + } + }, + "Primary": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The primary IP address.
" + } + }, + "AllocationType": { + "target": "com.amazonaws.ssmsap#AllocationType", + "traits": { + "smithy.api#documentation": "The type of allocation for the IP address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information of the IP address.
" + } + }, "com.amazonaws.ssmsap#ListApplications": { "type": "operation", "input": { @@ -1462,6 +1650,12 @@ "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.
" } + }, + "Filters": { + "target": "com.amazonaws.ssmsap#FilterList", + "traits": { + "smithy.api#documentation": "The filter of name, value, and operator.
" + } } } }, @@ -1497,6 +1691,9 @@ { "target": "com.amazonaws.ssmsap#ResourceNotFoundException" }, + { + "target": "com.amazonaws.ssmsap#UnauthorizedException" + }, { "target": "com.amazonaws.ssmsap#ValidationException" } @@ -1775,7 +1972,7 @@ "com.amazonaws.ssmsap#MaxResults": { "type": "integer", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 50, "smithy.api#range": { "min": 1, "max": 50 @@ -2044,6 +2241,9 @@ { "target": "com.amazonaws.ssmsap#InternalServerException" }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, { "target": "com.amazonaws.ssmsap#ValidationException" } @@ -2102,8 +2302,15 @@ "Credentials": { "target": "com.amazonaws.ssmsap#ApplicationCredentialList", "traits": { - "smithy.api#documentation": "The credentials of the SAP application.
", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#documentation": "The credentials of the SAP application.
" + } + }, + "DatabaseArn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the SAP HANA database.
" } } } @@ -2186,6 +2393,12 @@ "traits": { "smithy.api#documentation": "The cluster status of the component.
" } + }, + "EnqueueReplication": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if or not enqueue replication is enabled for the ASCS component.
" + } } }, "traits": { @@ -3019,6 +3232,9 @@ { "target": "com.amazonaws.ssmsap#ResourceNotFoundException" }, + { + "target": "com.amazonaws.ssmsap#UnauthorizedException" + }, { "target": "com.amazonaws.ssmsap#ValidationException" } @@ -3142,6 +3358,19 @@ } } }, + "com.amazonaws.ssmsap#UnauthorizedException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request is not authorized.
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, "com.amazonaws.ssmsap#UntagResource": { "type": "operation", "input": { @@ -3213,6 +3442,9 @@ { "target": "com.amazonaws.ssmsap#ResourceNotFoundException" }, + { + "target": "com.amazonaws.ssmsap#UnauthorizedException" + }, { "target": "com.amazonaws.ssmsap#ValidationException" } @@ -3253,6 +3485,12 @@ "traits": { "smithy.api#documentation": "Installation of AWS Backint Agent for SAP HANA.
" } + }, + "DatabaseArn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA\n connection with the SAP_ABAP application.
" + } } } }, diff --git a/codegen/sdk/aws-models/ssm.json b/codegen/sdk/aws-models/ssm.json index 865973f952e..8511482b06a 100644 --- a/codegen/sdk/aws-models/ssm.json +++ b/codegen/sdk/aws-models/ssm.json @@ -828,7 +828,7 @@ "name": "ssm" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.
\nThis 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.
\n\n Related resources\n
\nFor information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
\nFor details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the\n \n Systems Manager Automation runbook reference\n .
\nFor information about AppConfig, a capability of Systems Manager, see the \n AppConfig User Guide\n \n and the \n AppConfig\n API Reference\n .
\nFor information about Incident Manager, a capability of Systems Manager, see the \n Systems Manager Incident Manager User\n Guide\n and the \n Systems Manager Incident Manager API\n Reference\n .
\nAmazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.
\nThis 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.
\n\n Related resources\n
\nFor information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
\nFor details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the\n \n Systems Manager Automation runbook reference\n .
\nFor information about AppConfig, a capability of Systems Manager, see the \n AppConfig User Guide\n \n and the \n AppConfig\n API Reference\n .
\nFor information about Incident Manager, a capability of Systems Manager, see the \n Systems Manager Incident Manager User\n Guide\n and the \n Systems Manager Incident Manager API\n Reference\n .
\nThe name of the Change Manager change request.
" } + }, + "Variables": { + "target": "com.amazonaws.ssm#AutomationParameterMap", + "traits": { + "smithy.api#documentation": "Variables defined for the automation.
" + } } }, "traits": { @@ -3989,6 +3995,12 @@ "traits": { "smithy.api#enumValue": "CompletedWithFailure" } + }, + "EXITED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Exited" + } } } }, @@ -6370,7 +6382,7 @@ "OpsItemType": { "target": "com.amazonaws.ssm#OpsItemType", "traits": { - "smithy.api#documentation": "The type of OpsItem to create. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insights\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem to create. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insight\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nEach element in the array is a structure containing a key-value pair.
\nSupported keys for DescribeInstancePatchesinclude the following:
\n \n Classification\n \n
Sample values: Security | SecurityUpdates\n
\n \n KBId\n \n
Sample values: KB4480056 | java-1.7.0-openjdk.x86_64\n
\n \n Severity\n \n
Sample values: Important | Medium | Low\n
\n \n State\n \n
Sample values: Installed | InstalledOther |\n InstalledPendingReboot\n
Each element in the array is a structure containing a key-value pair.
\nSupported keys for DescribeInstancePatchesinclude the following:
\n \n Classification\n \n
Sample values: Security | SecurityUpdates\n
\n \n KBId\n \n
Sample values: KB4480056 | java-1.7.0-openjdk.x86_64\n
\n \n Severity\n \n
Sample values: Important | Medium | Low\n
\n \n State\n \n
Sample values: Installed | InstalledOther |\n InstalledPendingReboot\n
For lists of all State values, see Understanding\n 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:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insights\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insight\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insights\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe type of OpsItem. Systems Manager supports the following types of OpsItems:
\n\n /aws/issue\n
This type of OpsItem is used for default OpsItems created by OpsCenter.
\n\n /aws/changerequest\n
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change\n requests.
\n\n /aws/insight\n
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate\n OpsItems.
\nThe unique ID of a step execution.
" + } + }, + "StepName": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The name of the step.
" + } + }, + "Action": { + "target": "com.amazonaws.ssm#AutomationActionName", + "traits": { + "smithy.api#documentation": "The name of the automation action.
" + } + }, + "Iteration": { + "target": "com.amazonaws.ssm#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The current repetition of the loop represented by an integer.
" + } + }, + "IteratorValue": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The current value of the specified iterator in the loop.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A detailed status of the parent step.
" + } + }, "com.amazonaws.ssm#Patch": { "type": "structure", "members": { @@ -27231,6 +27282,12 @@ "traits": { "smithy.api#documentation": "The CloudWatch alarms that were invoked by the automation.
" } + }, + "ParentStepDetails": { + "target": "com.amazonaws.ssm#ParentStepDetails", + "traits": { + "smithy.api#documentation": "Information about the parent step.
" + } } }, "traits": { @@ -27243,7 +27300,7 @@ "Key": { "target": "com.amazonaws.ssm#StepExecutionFilterKey", "traits": { - "smithy.api#documentation": "One or more keys to limit the results. Valid filter keys include the following: StepName,\n Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.
", + "smithy.api#documentation": "One or more keys to limit the results.
", "smithy.api#required": {} } }, @@ -27297,6 +27354,24 @@ "traits": { "smithy.api#enumValue": "Action" } + }, + "PARENT_STEP_EXECUTION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ParentStepExecutionId" + } + }, + "PARENT_STEP_ITERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ParentStepIteration" + } + }, + "PARENT_STEP_ITERATOR_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ParentStepIteratorValue" + } } } }, @@ -29633,7 +29708,7 @@ "SettingValue": { "target": "com.amazonaws.ssm#ServiceSettingValue", "traits": { - "smithy.api#documentation": "The new value to specify for the service setting. The following list specifies the available\n values for each setting.
\n\n /ssm/managed-instance/default-ec2-instance-management-role: The name of an IAM role\n
\n /ssm/automation/customer-script-log-destination: CloudWatch\n
\n /ssm/automation/customer-script-log-group-name: The name of an Amazon CloudWatch Logs log group
\n /ssm/documents/console/public-sharing-permission: Enable or\n Disable\n
\n /ssm/managed-instance/activation-tier: standard or\n advanced\n
\n /ssm/opsinsights/opscenter: Enabled or Disabled\n
\n /ssm/parameter-store/default-parameter-tier: Standard,\n Advanced, Intelligent-Tiering\n
\n /ssm/parameter-store/high-throughput-enabled: true or\n false\n
The new value to specify for the service setting. The following list specifies the available\n values for each setting.
\nFor /ssm/managed-instance/default-ec2-instance-management-role, enter the\n 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\n Amazon CloudWatch Logs log group.
For /ssm/documents/console/public-sharing-permission, enter\n Enable or Disable.
For /ssm/managed-instance/activation-tier, enter standard or\n advanced.
For /ssm/opsinsights/opscenter, enter Enabled or\n Disabled.
For /ssm/parameter-store/default-parameter-tier, enter Standard,\n Advanced, or Intelligent-Tiering\n
For /ssm/parameter-store/high-throughput-enabled, enter true or\n false.
The name of the attribute associated with your identities in your identity source. This is\n used to map a specified attribute in your identity source with an attribute in\n IAM Identity Center.
", + "smithy.api#documentation": "The name of the attribute associated with your identities in your identity source.\n This is used to map a specified attribute in your identity source with an attribute in\n IAM Identity Center.
", "smithy.api#required": {} } }, @@ -20,7 +20,7 @@ } }, "traits": { - "smithy.api#documentation": "These are IAM Identity Center identity store attributes that you can configure for use in\n attributes-based access control (ABAC). You can create permissions policies that determine who\n can access your Amazon Web Services resources based upon the configured attribute values. When you enable\n ABAC and specify AccessControlAttributes, IAM Identity Center passes the attribute values of\n the authenticated user into IAM for use in policy evaluation.
These are IAM Identity Center identity store attributes that you can configure for use in\n attributes-based access control (ABAC). You can create permissions policies that\n determine who can access your Amazon Web Services resources based upon the configured attribute\n values. When you enable ABAC and specify AccessControlAttributes, IAM Identity Center\n passes the attribute values of the authenticated user into IAM for use in policy\n evaluation.
The value used for mapping a specified attribute to an identity source. For more\n information, see Attribute mappings\n in the IAM Identity Center User Guide.
" + "smithy.api#documentation": "The value used for mapping a specified attribute to an identity source. For more\n information, see Attribute\n mappings in the IAM Identity Center User Guide.
" } }, "com.amazonaws.ssoadmin#AccessControlAttributeValueSource": { @@ -127,7 +127,39 @@ } }, "traits": { - "smithy.api#documentation": "The assignment that indicates a principal's limited access to a specified Amazon Web Services account\n with a specified permission set.
\nThe term principal here refers to a user or group that is defined\n in IAM Identity Center.
\nThe assignment that indicates a principal's limited access to a specified Amazon Web Services\n account with a specified permission set.
\nThe term principal here refers to a user or group that is\n defined in IAM Identity Center.
\nThe account ID number of the Amazon Web Services account.
" + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center permission set assigned to this principal for this\n Amazon Web Services account.
" + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#documentation": "The ID of the principal.
" + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "The type of the principal.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes an assignment of an Amazon Web Services account to a principal and the\n permissions that principal has in the account.
" } }, "com.amazonaws.ssoadmin#AccountAssignmentList": { @@ -136,6 +168,12 @@ "target": "com.amazonaws.ssoadmin#AccountAssignment" } }, + "com.amazonaws.ssoadmin#AccountAssignmentListForPrincipal": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentForPrincipal" + } + }, "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus": { "type": "structure", "members": { @@ -148,13 +186,13 @@ "RequestId": { "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.
" + "smithy.api#documentation": "The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.
" } }, "FailureReason": { "target": "com.amazonaws.ssoadmin#Reason", "traits": { - "smithy.api#documentation": "The message that contains an error or exception in case of an operation failure.
" + "smithy.api#documentation": "The message that contains an error or exception in case of an operation\n failure.
" } }, "TargetId": { @@ -195,7 +233,7 @@ } }, "traits": { - "smithy.api#documentation": "The status of the creation or deletion operation of an assignment that a principal needs\n to access an account.
" + "smithy.api#documentation": "The status of the creation or deletion operation of an assignment that a principal\n needs to access an account.
" } }, "com.amazonaws.ssoadmin#AccountAssignmentOperationStatusList": { @@ -216,7 +254,7 @@ "RequestId": { "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.
" + "smithy.api#documentation": "The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.
" } }, "CreatedDate": { @@ -227,7 +265,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about the AccountAssignment creation\n request.
" + "smithy.api#documentation": "Provides information about the AccountAssignment creation\n request.
" } }, "com.amazonaws.ssoadmin#AccountId": { @@ -246,6 +284,331 @@ "target": "com.amazonaws.ssoadmin#AccountId" } }, + "com.amazonaws.ssoadmin#ActorPolicyDocument": { + "type": "document" + }, + "com.amazonaws.ssoadmin#Application": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "The ARN of the application.
" + } + }, + "ApplicationProviderArn": { + "target": "com.amazonaws.ssoadmin#ApplicationProviderArn", + "traits": { + "smithy.api#documentation": "The ARN of the application provider for this application.
" + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#NameType", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "ApplicationAccount": { + "target": "com.amazonaws.ssoadmin#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID number of the application.
" + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the instance of IAM Identity Center that is configured with this application.
" + } + }, + "Status": { + "target": "com.amazonaws.ssoadmin#ApplicationStatus", + "traits": { + "smithy.api#documentation": "The current status of the application in this instance of IAM Identity Center.
" + } + }, + "PortalOptions": { + "target": "com.amazonaws.ssoadmin#PortalOptions", + "traits": { + "smithy.api#documentation": "A structure that describes the options for the access portal associated with this\n application.
" + } + }, + "Description": { + "target": "com.amazonaws.ssoadmin#Description", + "traits": { + "smithy.api#documentation": "The description of the application.
" + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssoadmin#Date", + "traits": { + "smithy.api#documentation": "The date and time when the application was originally created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes an application that uses IAM Identity Center for access\n management.
" + } + }, + "com.amazonaws.ssoadmin#ApplicationAccessScopeResource": { + "type": "resource", + "identifiers": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn" + }, + "Scope": { + "target": "com.amazonaws.ssoadmin#Scope" + } + }, + "put": { + "target": "com.amazonaws.ssoadmin#PutApplicationAccessScope" + }, + "read": { + "target": "com.amazonaws.ssoadmin#GetApplicationAccessScope" + }, + "delete": { + "target": "com.amazonaws.ssoadmin#DeleteApplicationAccessScope" + }, + "list": { + "target": "com.amazonaws.ssoadmin#ListApplicationAccessScopes" + } + }, + "com.amazonaws.ssoadmin#ApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#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}$" + } + }, + "com.amazonaws.ssoadmin#ApplicationAssignment": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "The ARN of the application that has principals assigned.
", + "smithy.api#required": {} + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#documentation": "The unique identifier of the principal assigned to the application.
", + "smithy.api#required": {} + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "The type of the principal assigned to the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes an assignment of a principal to an application.
" + } + }, + "com.amazonaws.ssoadmin#ApplicationAssignmentForPrincipal": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "The ARN of the application to which the specified principal is assigned.
" + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#documentation": "The unique identifier of the principal assigned to the application.
" + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "The type of the principal assigned to the application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes an application to which a principal is assigned.
" + } + }, + "com.amazonaws.ssoadmin#ApplicationAssignmentListForPrincipal": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#ApplicationAssignmentForPrincipal" + } + }, + "com.amazonaws.ssoadmin#ApplicationAssignmentsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#ApplicationAssignment" + } + }, + "com.amazonaws.ssoadmin#ApplicationAuthenticationMethodResource": { + "type": "resource", + "identifiers": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn" + }, + "AuthenticationMethodType": { + "target": "com.amazonaws.ssoadmin#AuthenticationMethodType" + } + }, + "put": { + "target": "com.amazonaws.ssoadmin#PutApplicationAuthenticationMethod" + }, + "read": { + "target": "com.amazonaws.ssoadmin#GetApplicationAuthenticationMethod" + }, + "delete": { + "target": "com.amazonaws.ssoadmin#DeleteApplicationAuthenticationMethod" + }, + "list": { + "target": "com.amazonaws.ssoadmin#ListApplicationAuthenticationMethods" + } + }, + "com.amazonaws.ssoadmin#ApplicationGrantResource": { + "type": "resource", + "identifiers": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn" + }, + "GrantType": { + "target": "com.amazonaws.ssoadmin#GrantType" + } + }, + "put": { + "target": "com.amazonaws.ssoadmin#PutApplicationGrant" + }, + "read": { + "target": "com.amazonaws.ssoadmin#GetApplicationGrant" + }, + "delete": { + "target": "com.amazonaws.ssoadmin#DeleteApplicationGrant" + }, + "list": { + "target": "com.amazonaws.ssoadmin#ListApplicationGrants" + } + }, + "com.amazonaws.ssoadmin#ApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#Application" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ssoadmin#ApplicationProvider": { + "type": "structure", + "members": { + "ApplicationProviderArn": { + "target": "com.amazonaws.ssoadmin#ApplicationProviderArn", + "traits": { + "smithy.api#documentation": "The ARN of the application provider.
", + "smithy.api#required": {} + } + }, + "FederationProtocol": { + "target": "com.amazonaws.ssoadmin#FederationProtocol", + "traits": { + "smithy.api#documentation": "The protocol that the application provider uses to perform federation.
" + } + }, + "DisplayData": { + "target": "com.amazonaws.ssoadmin#DisplayData", + "traits": { + "smithy.api#documentation": "A structure that describes how IAM Identity Center represents the application provider in the\n portal.
" + } + }, + "ResourceServerConfig": { + "target": "com.amazonaws.ssoadmin#ResourceServerConfig", + "traits": { + "smithy.api#documentation": "A structure that describes the application provider's resource server.
" + } + } + }, + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.ssoadmin#ApplicationProviderArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$" + } + }, + "com.amazonaws.ssoadmin#ApplicationProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#ApplicationProvider" + } + }, + "com.amazonaws.ssoadmin#ApplicationStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.ssoadmin#ApplicationUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^http(s)?:\\/\\/[-a-zA-Z0-9+&@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\\/%?=~_|]$" + } + }, + "com.amazonaws.ssoadmin#ApplicationVisibility": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#default": "ENABLED" + } + }, + "com.amazonaws.ssoadmin#AssignmentRequired": { + "type": "boolean", + "traits": { + "smithy.api#default": true + } + }, "com.amazonaws.ssoadmin#AttachCustomerManagedPolicyReferenceToPermissionSet": { "type": "operation", "input": { @@ -349,7 +712,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches an Amazon Web Services managed policy ARN to a permission set.
\nIf the permission set is already referenced by one or more account assignments, you will\n need to call \n ProvisionPermissionSet\n after this operation.\n Calling ProvisionPermissionSet applies the corresponding IAM policy updates\n to all assigned accounts.
Attaches an Amazon Web Services managed policy ARN to a permission set.
\nIf the permission set is already referenced by one or more account assignments,\n you will need to call \n ProvisionPermissionSet\n after\n this operation. Calling ProvisionPermissionSet applies the\n corresponding IAM policy updates to all assigned accounts.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "The ARN of the PermissionSet that the managed policy should be attached\n to.
", + "smithy.api#documentation": "The ARN of the PermissionSet that the managed policy should be\n attached to.
", "smithy.api#required": {} } }, @@ -414,21 +777,138 @@ "target": "com.amazonaws.ssoadmin#AttachedManagedPolicy" } }, - "com.amazonaws.ssoadmin#ConflictException": { - "type": "structure", + "com.amazonaws.ssoadmin#AuthenticationMethod": { + "type": "union", "members": { - "Message": { - "target": "com.amazonaws.ssoadmin#ConflictExceptionMessage" + "Iam": { + "target": "com.amazonaws.ssoadmin#IamAuthenticationMethod", + "traits": { + "smithy.api#documentation": "A structure that describes details for IAM authentication.
" + } } }, "traits": { - "smithy.api#documentation": "Occurs when a conflict with a previous successful write is detected. This generally occurs\n when the previous write did not have time to propagate to the host serving the current\n request. A retry (with appropriate backoff logic) is the recommended response to this\n exception.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 + "smithy.api#documentation": "A structure that describes an authentication method that can be used by an\n application.
" } }, - "com.amazonaws.ssoadmin#ConflictExceptionMessage": { - "type": "string" + "com.amazonaws.ssoadmin#AuthenticationMethodItem": { + "type": "structure", + "members": { + "AuthenticationMethodType": { + "target": "com.amazonaws.ssoadmin#AuthenticationMethodType", + "traits": { + "smithy.api#documentation": "The type of authentication that is used by this method.
" + } + }, + "AuthenticationMethod": { + "target": "com.amazonaws.ssoadmin#AuthenticationMethod", + "traits": { + "smithy.api#documentation": "A structure that describes an authentication method. The contents of this structure is\n determined by the AuthenticationMethodType.
A structure that describes an authentication method and its type.
" + } + }, + "com.amazonaws.ssoadmin#AuthenticationMethodType": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + } + } + }, + "com.amazonaws.ssoadmin#AuthenticationMethods": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#AuthenticationMethodItem" + } + }, + "com.amazonaws.ssoadmin#AuthorizationCodeGrant": { + "type": "structure", + "members": { + "RedirectUris": { + "target": "com.amazonaws.ssoadmin#RedirectUris", + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + } + }, + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + }, + "com.amazonaws.ssoadmin#AuthorizedTokenIssuer": { + "type": "structure", + "members": { + "TrustedTokenIssuerArn": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerArn", + "traits": { + "smithy.api#documentation": "The ARN of the trusted token issuer.
" + } + }, + "AuthorizedAudiences": { + "target": "com.amazonaws.ssoadmin#TokenIssuerAudiences", + "traits": { + "smithy.api#documentation": "An array list of authorized audiences, or applications, that can consume the tokens\n generated by the associated trusted token issuer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes a trusted token issuer and associates it with a set of authorized\n audiences.
" + } + }, + "com.amazonaws.ssoadmin#AuthorizedTokenIssuers": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#AuthorizedTokenIssuer" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ssoadmin#ClaimAttributePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^\\p{L}+(?:(\\.|\\_)\\p{L}+){0,2}$" + } + }, + "com.amazonaws.ssoadmin#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[!-~]+$" + } + }, + "com.amazonaws.ssoadmin#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssoadmin#ConflictExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "Occurs when a conflict with a previous successful write is detected. This generally\n occurs when the previous write did not have time to propagate to the host serving the\n current request. A retry (with appropriate backoff logic) is the recommended response to\n this exception.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.ssoadmin#ConflictExceptionMessage": { + "type": "string" }, "com.amazonaws.ssoadmin#CreateAccountAssignment": { "type": "operation", @@ -462,7 +942,7 @@ } ], "traits": { - "smithy.api#documentation": "Assigns access to a principal for a specified Amazon Web Services account using a specified\n permission set.
\nThe term principal here refers to a user or group that is defined\n in IAM Identity Center.
\nAs part of a successful CreateAccountAssignment call, the specified\n permission set will automatically be provisioned to the account in the form of an IAM\n policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set\n is subsequently updated, the corresponding IAM policies attached to roles in your accounts\n will not be updated automatically. In this case, you must call \n ProvisionPermissionSet\n to make these updates.
\n After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation request.\n
Assigns access to a principal for a specified Amazon Web Services account using a specified\n permission set.
\nThe term principal here refers to a user or group that is\n defined in IAM Identity Center.
\nAs part of a successful CreateAccountAssignment call, the specified\n permission set will automatically be provisioned to the account in the form of an\n IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the\n permission set is subsequently updated, the corresponding IAM policies attached to\n roles in your accounts will not be updated automatically. In this case, you must\n call \n ProvisionPermissionSet\n to make these\n updates.
After a successful response, call\n DescribeAccountAssignmentCreationStatus to describe the status of\n an assignment creation request.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, @@ -492,7 +972,7 @@ "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "The ARN of the permission set that the admin wants to grant the principal access\n to.
", + "smithy.api#documentation": "The ARN of the permission set that the admin wants to grant the principal access\n to.
", "smithy.api#required": {} } }, @@ -529,13 +1009,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfiguration": { + "com.amazonaws.ssoadmin#CreateApplication": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfigurationRequest" + "target": "com.amazonaws.ssoadmin#CreateApplicationRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfigurationResponse" + "target": "com.amazonaws.ssoadmin#CreateApplicationResponse" }, "errors": [ { @@ -550,6 +1030,9 @@ { "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" }, + { + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.ssoadmin#ThrottlingException" }, @@ -558,45 +1041,16 @@ } ], "traits": { - "smithy.api#documentation": "Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center\n instance. You can also specify new attributes to add to your ABAC configuration during the\n enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
\nAfter a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that\n InstanceAccessControlAttributeConfiguration was created.
The ARN of the IAM Identity Center instance under which the operation will be executed.
", - "smithy.api#required": {} - } - }, - "InstanceAccessControlAttributeConfiguration": { - "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When\n using an external identity provider as an identity source, you can pass attributes through the\n SAML assertion. Doing so provides an alternative to configuring attributes from the IAM Identity Center\n identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the\n attribute value with the value from the IAM Identity Center identity store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Creates an application in IAM Identity Center for the given application provider.
" } }, - "com.amazonaws.ssoadmin#CreatePermissionSet": { + "com.amazonaws.ssoadmin#CreateApplicationAssignment": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#CreatePermissionSetRequest" + "target": "com.amazonaws.ssoadmin#CreateApplicationAssignmentRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#CreatePermissionSetResponse" + "target": "com.amazonaws.ssoadmin#CreateApplicationAssignmentResponse" }, "errors": [ { @@ -622,48 +1076,31 @@ } ], "traits": { - "smithy.api#documentation": "Creates a permission set within a specified IAM Identity Center instance.
\nTo grant users and groups access to Amazon Web Services account resources, use \n CreateAccountAssignment\n .
Grant application access to a user or group.
" } }, - "com.amazonaws.ssoadmin#CreatePermissionSetRequest": { + "com.amazonaws.ssoadmin#CreateApplicationAssignmentRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.ssoadmin#PermissionSetName", + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "The name of the PermissionSet.
", + "smithy.api#documentation": "The ARN of the application provider under which the operation will run.
", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.ssoadmin#PermissionSetDescription", - "traits": { - "smithy.api#documentation": "The description of the PermissionSet.
" - } - }, - "InstanceArn": { - "target": "com.amazonaws.ssoadmin#InstanceArn", + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#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.
", "smithy.api#required": {} } }, - "SessionDuration": { - "target": "com.amazonaws.ssoadmin#Duration", - "traits": { - "smithy.api#documentation": "The length of time that the application user sessions are valid in the ISO-8601\n standard.
" - } - }, - "RelayState": { - "target": "com.amazonaws.ssoadmin#RelayState", - "traits": { - "smithy.api#documentation": "Used to redirect users within the application during the federation authentication\n process.
" - } - }, - "Tags": { - "target": "com.amazonaws.ssoadmin#TagList", + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", "traits": { - "smithy.api#documentation": "The tags to attach to the new PermissionSet.
" + "smithy.api#documentation": "The entity type for which the assignment will be created.
", + "smithy.api#required": {} } } }, @@ -671,125 +1108,66 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#CreatePermissionSetResponse": { + "com.amazonaws.ssoadmin#CreateApplicationAssignmentResponse": { "type": "structure", - "members": { - "PermissionSet": { - "target": "com.amazonaws.ssoadmin#PermissionSet", - "traits": { - "smithy.api#documentation": "Defines the level of access on an Amazon Web Services account.
" - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#CustomerManagedPolicyReference": { + "com.amazonaws.ssoadmin#CreateApplicationRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.ssoadmin#ManagedPolicyName", + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
", + "smithy.api#documentation": "The ARN of the instance of IAM Identity Center under which the operation will run.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, - "Path": { - "target": "com.amazonaws.ssoadmin#ManagedPolicyPath", + "ApplicationProviderArn": { + "target": "com.amazonaws.ssoadmin#ApplicationProviderArn", "traits": { - "smithy.api#documentation": "The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is /. For more information, see Friendly\n names and paths in the IAM User Guide.
The ARN of the application provider under which the operation will run.
", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.
" - } - }, - "com.amazonaws.ssoadmin#CustomerManagedPolicyReferenceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssoadmin#CustomerManagedPolicyReference" - } - }, - "com.amazonaws.ssoadmin#Date": { - "type": "timestamp" - }, - "com.amazonaws.ssoadmin#DeleteAccountAssignment": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssoadmin#DeleteAccountAssignmentRequest" - }, - "output": { - "target": "com.amazonaws.ssoadmin#DeleteAccountAssignmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ssoadmin#AccessDeniedException" - }, - { - "target": "com.amazonaws.ssoadmin#ConflictException" - }, - { - "target": "com.amazonaws.ssoadmin#InternalServerException" }, - { - "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssoadmin#ThrottlingException" - }, - { - "target": "com.amazonaws.ssoadmin#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a principal's access from a specified Amazon Web Services account using a specified permission\n set.
\nAfter a successful response, call DescribeAccountAssignmentDeletionStatus to\n describe the status of an assignment deletion request.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The name of the .
", "smithy.api#required": {} } }, - "TargetId": { - "target": "com.amazonaws.ssoadmin#TargetId", + "Description": { + "target": "com.amazonaws.ssoadmin#Description", "traits": { - "smithy.api#documentation": "TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
", - "smithy.api#required": {} + "smithy.api#documentation": "The description of the .
" } }, - "TargetType": { - "target": "com.amazonaws.ssoadmin#TargetType", + "PortalOptions": { + "target": "com.amazonaws.ssoadmin#PortalOptions", "traits": { - "smithy.api#documentation": "The entity type for which the assignment will be deleted.
", - "smithy.api#required": {} + "smithy.api#documentation": "A structure that describes the options for the portal associated with an\n application.
" } }, - "PermissionSetArn": { - "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "Tags": { + "target": "com.amazonaws.ssoadmin#TagList", "traits": { - "smithy.api#documentation": "The ARN of the permission set that will be used to remove access.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies tags to be attached to the application.
" } }, - "PrincipalType": { - "target": "com.amazonaws.ssoadmin#PrincipalType", + "Status": { + "target": "com.amazonaws.ssoadmin#ApplicationStatus", "traits": { - "smithy.api#documentation": "The entity type for which the assignment will be deleted.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies whether the application is enabled or disabled.
" } }, - "PrincipalId": { - "target": "com.amazonaws.ssoadmin#PrincipalId", + "ClientToken": { + "target": "com.amazonaws.ssoadmin#ClientToken", "traits": { - "smithy.api#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.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value.
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
The status object for the account assignment deletion operation.
" + "smithy.api#documentation": "Specifies the ARN of the application.
" } } }, @@ -811,13 +1189,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSet": { + "com.amazonaws.ssoadmin#CreateInstance": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetRequest" + "target": "com.amazonaws.ssoadmin#CreateInstanceRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetResponse" + "target": "com.amazonaws.ssoadmin#CreateInstanceResponse" }, "errors": [ { @@ -830,7 +1208,7 @@ "target": "com.amazonaws.ssoadmin#InternalServerException" }, { - "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.ssoadmin#ThrottlingException" @@ -840,45 +1218,16 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the inline policy from a specified permission set.
" + "smithy.api#documentation": "Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not\n managed by Organizations or a member Amazon Web Services account in an organization. You can\n create only one instance per account and across all Amazon Web Services Regions.
\nThe CreateInstance request is rejected if the following apply:
\nThe instance is created within the organization management account.
\nAn instance already exists in the same account.
\nThe ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", - "smithy.api#required": {} - } - }, - "PermissionSetArn": { - "target": "com.amazonaws.ssoadmin#PermissionSetArn", - "traits": { - "smithy.api#documentation": "The ARN of the permission set that will be used to remove access.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfiguration": { + "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfigurationRequest" + "target": "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfigurationRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfigurationResponse" + "target": "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfigurationResponse" }, "errors": [ { @@ -901,10 +1250,10 @@ } ], "traits": { - "smithy.api#documentation": "Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center\n instance and deletes all of the attribute mappings that have been configured. Once deleted,\n any attributes that are received from an identity source and any custom attributes you have\n previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
" + "smithy.api#documentation": "Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center\n instance. You can also specify new attributes to add to your ABAC configuration during\n the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
\nAfter a successful response, call\n DescribeInstanceAccessControlAttributeConfiguration to validate\n that InstanceAccessControlAttributeConfiguration was created.
The ARN of the IAM Identity Center instance under which the operation will be executed.
", "smithy.api#required": {} } + }, + "InstanceAccessControlAttributeConfiguration": { + "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When\n using an external identity provider as an identity source, you can pass attributes\n through the SAML assertion. Doing so provides an alternative to configuring attributes\n from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center\n will replace the attribute value with the value from the IAM Identity Center identity store.
", + "smithy.api#required": {} + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfigurationResponse": { + "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfigurationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#DeletePermissionSet": { + "com.amazonaws.ssoadmin#CreateInstanceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssoadmin#NameType", + "traits": { + "smithy.api#documentation": "The name of the instance of IAM Identity Center.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.ssoadmin#ClientToken", + "traits": { + "smithy.api#documentation": "Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value.
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies tags to be attached to the instance of IAM Identity Center.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#CreateInstanceResponse": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the instance of IAM Identity Center under which the operation will run.
\nFor more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#CreatePermissionSet": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DeletePermissionSetRequest" + "target": "com.amazonaws.ssoadmin#CreatePermissionSetRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DeletePermissionSetResponse" + "target": "com.amazonaws.ssoadmin#CreatePermissionSetResponse" }, "errors": [ { @@ -947,6 +1344,9 @@ { "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" }, + { + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.ssoadmin#ThrottlingException" }, @@ -955,24 +1355,48 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified permission set.
" + "smithy.api#documentation": "Creates a permission set within a specified IAM Identity Center instance.
\nTo grant users and groups access to Amazon Web Services account resources, use \n CreateAccountAssignment\n .
The name of the PermissionSet.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.ssoadmin#PermissionSetDescription", + "traits": { + "smithy.api#documentation": "The description of the PermissionSet.
" + } + }, "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, - "PermissionSetArn": { - "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "SessionDuration": { + "target": "com.amazonaws.ssoadmin#Duration", "traits": { - "smithy.api#documentation": "The ARN of the permission set that should be deleted.
", - "smithy.api#required": {} + "smithy.api#documentation": "The length of time that the application user sessions are valid in the ISO-8601\n standard.
" + } + }, + "RelayState": { + "target": "com.amazonaws.ssoadmin#RelayState", + "traits": { + "smithy.api#documentation": "Used to redirect users within the application during the federation authentication\n process.
" + } + }, + "Tags": { + "target": "com.amazonaws.ssoadmin#TagList", + "traits": { + "smithy.api#documentation": "The tags to attach to the new PermissionSet.
" } } }, @@ -980,30 +1404,40 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#DeletePermissionSetResponse": { + "com.amazonaws.ssoadmin#CreatePermissionSetResponse": { "type": "structure", - "members": {}, + "members": { + "PermissionSet": { + "target": "com.amazonaws.ssoadmin#PermissionSet", + "traits": { + "smithy.api#documentation": "Defines the level of access on an Amazon Web Services account.
" + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#DeletePermissionsBoundaryFromPermissionSet": { + "com.amazonaws.ssoadmin#CreateTrustedTokenIssuer": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DeletePermissionsBoundaryFromPermissionSetRequest" + "target": "com.amazonaws.ssoadmin#CreateTrustedTokenIssuerRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DeletePermissionsBoundaryFromPermissionSetResponse" + "target": "com.amazonaws.ssoadmin#CreateTrustedTokenIssuerResponse" }, "errors": [ { "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, { "target": "com.amazonaws.ssoadmin#InternalServerException" }, { - "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.ssoadmin#ThrottlingException" @@ -1013,50 +1447,117 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the permissions boundary from a specified PermissionSet.
" + "smithy.api#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.
\nThis trusted token issuer describes an external identity\n provider (IdP) that can generate claims or assertions in the form of access tokens for a\n user. Applications enabled for IAM Identity Center can use these tokens for authentication.
" } }, - "com.amazonaws.ssoadmin#DeletePermissionsBoundaryFromPermissionSetRequest": { + "com.amazonaws.ssoadmin#CreateTrustedTokenIssuerRequest": { "type": "structure", "members": { "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.
", + "smithy.api#documentation": "Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer\n configuration.
", "smithy.api#required": {} } }, - "PermissionSetArn": { - "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "Name": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerName", "traits": { - "smithy.api#documentation": "The ARN of the PermissionSet.
Specifies the name of the new trusted token issuer configuration.
", + "smithy.api#required": {} + } + }, + "TrustedTokenIssuerType": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerType", + "traits": { + "smithy.api#documentation": "Specifies the type of the new trusted token issuer.
", + "smithy.api#required": {} + } + }, + "TrustedTokenIssuerConfiguration": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerConfiguration", + "traits": { + "smithy.api#documentation": "Specifies settings that apply to the new trusted token issuer configuration. The settings that are\n available depend on what TrustedTokenIssuerType you specify.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies tags to be attached to the new trusted token issuer configuration.
" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#DeletePermissionsBoundaryFromPermissionSetResponse": { + "com.amazonaws.ssoadmin#CreateTrustedTokenIssuerResponse": { "type": "structure", - "members": {}, + "members": { + "TrustedTokenIssuerArn": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerArn", + "traits": { + "smithy.api#documentation": "The ARN of the new trusted token issuer configuration.
" + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatus": { + "com.amazonaws.ssoadmin#CustomerManagedPolicyReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssoadmin#ManagedPolicyName", + "traits": { + "smithy.api#documentation": "The name of the IAM policy that you have configured in each account where you want\n to deploy your permission set.
", + "smithy.api#required": {} + } + }, + "Path": { + "target": "com.amazonaws.ssoadmin#ManagedPolicyPath", + "traits": { + "smithy.api#documentation": "The path to the IAM policy that you have configured in each account where you want\n to deploy your permission set. The default is /. For more information, see\n Friendly names and paths in the IAM User\n Guide.
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.
" + } + }, + "com.amazonaws.ssoadmin#CustomerManagedPolicyReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#CustomerManagedPolicyReference" + } + }, + "com.amazonaws.ssoadmin#Date": { + "type": "timestamp" + }, + "com.amazonaws.ssoadmin#DeleteAccountAssignment": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusRequest" + "target": "com.amazonaws.ssoadmin#DeleteAccountAssignmentRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusResponse" + "target": "com.amazonaws.ssoadmin#DeleteAccountAssignmentResponse" }, "errors": [ { "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, { "target": "com.amazonaws.ssoadmin#InternalServerException" }, @@ -1071,23 +1572,51 @@ } ], "traits": { - "smithy.api#documentation": "Describes the status of the assignment creation request.
" + "smithy.api#documentation": "Deletes a principal's access from a specified Amazon Web Services account using a specified\n permission set.
\nAfter a successful response, call\n DescribeAccountAssignmentDeletionStatus to describe the status of\n an assignment deletion request.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, - "AccountAssignmentCreationRequestId": { - "target": "com.amazonaws.ssoadmin#UUId", + "TargetId": { + "target": "com.amazonaws.ssoadmin#TargetId", "traits": { - "smithy.api#documentation": "The identifier that is used to track the request operation progress.
", + "smithy.api#documentation": "TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
", + "smithy.api#required": {} + } + }, + "TargetType": { + "target": "com.amazonaws.ssoadmin#TargetType", + "traits": { + "smithy.api#documentation": "The entity type for which the assignment will be deleted.
", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the permission set that will be used to remove access.
", + "smithy.api#required": {} + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "The entity type for which the assignment will be deleted.
", + "smithy.api#required": {} + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#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.
", "smithy.api#required": {} } } @@ -1096,13 +1625,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusResponse": { + "com.amazonaws.ssoadmin#DeleteAccountAssignmentResponse": { "type": "structure", "members": { - "AccountAssignmentCreationStatus": { + "AccountAssignmentDeletionStatus": { "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus", "traits": { - "smithy.api#documentation": "The status object for the account assignment creation operation.
" + "smithy.api#documentation": "The status object for the account assignment deletion operation.
" } } }, @@ -1110,18 +1639,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatus": { + "com.amazonaws.ssoadmin#DeleteApplication": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusRequest" + "target": "com.amazonaws.ssoadmin#DeleteApplicationRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusResponse" + "target": "com.amazonaws.ssoadmin#DeleteApplicationResponse" }, "errors": [ { "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, { "target": "com.amazonaws.ssoadmin#InternalServerException" }, @@ -1136,57 +1668,79 @@ } ], "traits": { - "smithy.api#documentation": "Describes the status of the assignment deletion request.
" + "smithy.api#documentation": "Deletes the association with the application. The connected service resource still\n exists.
" } }, - "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusRequest": { - "type": "structure", - "members": { - "InstanceArn": { - "target": "com.amazonaws.ssoadmin#InstanceArn", - "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", - "smithy.api#required": {} - } - }, - "AccountAssignmentDeletionRequestId": { - "target": "com.amazonaws.ssoadmin#UUId", - "traits": { - "smithy.api#documentation": "The identifier that is used to track the request operation progress.
", - "smithy.api#required": {} - } - } + "com.amazonaws.ssoadmin#DeleteApplicationAccessScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DeleteApplicationAccessScopeRequest" + }, + "output": { + "target": "smithy.api#Unit" }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Deletes an IAM Identity Center access scope from an application.
", + "smithy.api#idempotent": {} } }, - "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusResponse": { + "com.amazonaws.ssoadmin#DeleteApplicationAccessScopeRequest": { "type": "structure", "members": { - "AccountAssignmentDeletionStatus": { - "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus", + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "The status object for the account assignment deletion operation.
" + "smithy.api#documentation": "Specifies the ARN of the application with the access scope to delete.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.ssoadmin#Scope", + "traits": { + "smithy.api#documentation": "Specifies the name of the access scope to remove from the application.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfiguration": { + "com.amazonaws.ssoadmin#DeleteApplicationAssignment": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfigurationRequest" + "target": "com.amazonaws.ssoadmin#DeleteApplicationAssignmentRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfigurationResponse" + "target": "com.amazonaws.ssoadmin#DeleteApplicationAssignmentResponse" }, "errors": [ { "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, { "target": "com.amazonaws.ssoadmin#InternalServerException" }, @@ -1201,62 +1755,61 @@ } ], "traits": { - "smithy.api#documentation": "Returns the list of IAM Identity Center identity store attributes that have been configured to work\n with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not\n 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.
" + "smithy.api#documentation": "Revoke application access to an application by deleting application assignments for a\n user or group.
", + "smithy.api#idempotent": {} } }, - "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfigurationRequest": { + "com.amazonaws.ssoadmin#DeleteApplicationAssignmentRequest": { "type": "structure", "members": { - "InstanceArn": { - "target": "com.amazonaws.ssoadmin#InstanceArn", + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.
", + "smithy.api#documentation": "Specifies the ARN of the application.
", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfigurationResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfigurationStatus", - "traits": { - "smithy.api#documentation": "The status of the attribute configuration process.
" - } }, - "StatusReason": { - "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfigurationStatusReason", + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", "traits": { - "smithy.api#documentation": "Provides more details about the current status of the specified attribute.
" + "smithy.api#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.
", + "smithy.api#required": {} } }, - "InstanceAccessControlAttributeConfiguration": { - "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfiguration", + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", "traits": { - "smithy.api#documentation": "Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC\n configuration.
" + "smithy.api#documentation": "The entity type for which the assignment will be deleted.
", + "smithy.api#required": {} } } }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DeleteApplicationAssignmentResponse": { + "type": "structure", + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#DescribePermissionSet": { + "com.amazonaws.ssoadmin#DeleteApplicationAuthenticationMethod": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DescribePermissionSetRequest" + "target": "com.amazonaws.ssoadmin#DeleteApplicationAuthenticationMethodRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DescribePermissionSetResponse" + "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, { "target": "com.amazonaws.ssoadmin#InternalServerException" }, @@ -1271,21 +1824,47 @@ } ], "traits": { - "smithy.api#documentation": "Gets the details of the permission set.
" + "smithy.api#documentation": "Deletes an authentication method from an application.
", + "smithy.api#idempotent": {} } }, - "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatus": { + "com.amazonaws.ssoadmin#DeleteApplicationAuthenticationMethodRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application with the authentication method to delete.
", + "smithy.api#required": {} + } + }, + "AuthenticationMethodType": { + "target": "com.amazonaws.ssoadmin#AuthenticationMethodType", + "traits": { + "smithy.api#documentation": "Specifies the authentication method type to delete from the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DeleteApplicationGrant": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusRequest" + "target": "com.amazonaws.ssoadmin#DeleteApplicationGrantRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusResponse" + "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, { "target": "com.amazonaws.ssoadmin#InternalServerException" }, @@ -1300,23 +1879,24 @@ } ], "traits": { - "smithy.api#documentation": "Describes the status for the given permission set provisioning request.
" + "smithy.api#documentation": "Deletes a grant from an application.
", + "smithy.api#idempotent": {} } }, - "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusRequest": { + "com.amazonaws.ssoadmin#DeleteApplicationGrantRequest": { "type": "structure", "members": { - "InstanceArn": { - "target": "com.amazonaws.ssoadmin#InstanceArn", + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "Specifies the ARN of the application with the grant to delete.
", "smithy.api#required": {} } }, - "ProvisionPermissionSetRequestId": { - "target": "com.amazonaws.ssoadmin#UUId", + "GrantType": { + "target": "com.amazonaws.ssoadmin#GrantType", "traits": { - "smithy.api#documentation": "The identifier that is provided by the ProvisionPermissionSet call to\n retrieve the current status of the provisioning workflow.
", + "smithy.api#documentation": "Specifies the type of grant to delete from the application.
", "smithy.api#required": {} } } @@ -1325,34 +1905,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusResponse": { - "type": "structure", - "members": { - "PermissionSetProvisioningStatus": { - "target": "com.amazonaws.ssoadmin#PermissionSetProvisioningStatus", - "traits": { - "smithy.api#documentation": "The status object for the permission set provisioning operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.ssoadmin#DescribePermissionSetRequest": { + "com.amazonaws.ssoadmin#DeleteApplicationRequest": { "type": "structure", "members": { - "InstanceArn": { - "target": "com.amazonaws.ssoadmin#InstanceArn", - "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", - "smithy.api#required": {} - } - }, - "PermissionSetArn": { - "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "The ARN of the permission set.
", + "smithy.api#documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } } @@ -1361,27 +1920,20 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#DescribePermissionSetResponse": { + "com.amazonaws.ssoadmin#DeleteApplicationResponse": { "type": "structure", - "members": { - "PermissionSet": { - "target": "com.amazonaws.ssoadmin#PermissionSet", - "traits": { - "smithy.api#documentation": "Describes the level of access on an Amazon Web Services account.
" - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSet": { + "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSet": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSetRequest" + "target": "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSetResponse" + "target": "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetResponse" }, "errors": [ { @@ -1404,30 +1956,23 @@ } ], "traits": { - "smithy.api#documentation": "Detaches the specified customer managed policy from the specified PermissionSet.
" + "smithy.api#documentation": "Deletes the inline policy from a specified permission set.
" } }, - "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSetRequest": { + "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetRequest": { "type": "structure", "members": { "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "The ARN of the PermissionSet.
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.
", + "smithy.api#documentation": "The ARN of the permission set that will be used to remove access.
", "smithy.api#required": {} } } @@ -1436,20 +1981,49 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSetResponse": { + "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSet": { + "com.amazonaws.ssoadmin#DeleteInstance": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetRequest" + "target": "com.amazonaws.ssoadmin#DeleteInstanceRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetResponse" + "target": "com.amazonaws.ssoadmin#DeleteInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the instance of IAM Identity Center. Only the account that owns the instance can\n call this API. Neither the delegated administrator nor member account can delete the\n organization instance, but those roles can delete their own instance.
" + } + }, + "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfigurationResponse" }, "errors": [ { @@ -1472,30 +2046,16 @@ } ], "traits": { - "smithy.api#documentation": "Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
" + "smithy.api#documentation": "Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center\n instance and deletes all of the attribute mappings that have been configured. Once\n deleted, any attributes that are received from an identity source and any custom\n 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.
" } }, - "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetRequest": { + "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfigurationRequest": { "type": "structure", "members": { "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", - "smithy.api#required": {} - } - }, - "PermissionSetArn": { - "target": "com.amazonaws.ssoadmin#PermissionSetArn", - "traits": { - "smithy.api#documentation": "The ARN of the PermissionSet from which the policy should be\n detached.
", - "smithy.api#required": {} - } - }, - "ManagedPolicyArn": { - "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", - "traits": { - "smithy.api#documentation": "The Amazon Web Services managed policy ARN to be detached from a permission set.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.
", "smithy.api#required": {} } } @@ -1504,35 +2064,50 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetResponse": { + "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfigurationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#Duration": { - "type": "string", + "com.amazonaws.ssoadmin#DeleteInstanceRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the instance of IAM Identity Center under which the operation will run.
", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$" + "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSet": { + "com.amazonaws.ssoadmin#DeleteInstanceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DeletePermissionSet": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetRequest" + "target": "com.amazonaws.ssoadmin#DeletePermissionSetRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetResponse" + "target": "com.amazonaws.ssoadmin#DeletePermissionSetResponse" }, "errors": [ { "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, { "target": "com.amazonaws.ssoadmin#InternalServerException" }, @@ -1547,23 +2122,23 @@ } ], "traits": { - "smithy.api#documentation": "Obtains the inline policy assigned to the permission set.
" + "smithy.api#documentation": "Deletes the specified permission set.
" } }, - "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetRequest": { + "com.amazonaws.ssoadmin#DeletePermissionSetRequest": { "type": "structure", "members": { "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "The ARN of the permission set.
", + "smithy.api#documentation": "The ARN of the permission set that should be deleted.
", "smithy.api#required": {} } } @@ -1572,32 +2147,28 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetResponse": { + "com.amazonaws.ssoadmin#DeletePermissionSetResponse": { "type": "structure", - "members": { - "InlinePolicy": { - "target": "com.amazonaws.ssoadmin#PermissionSetPolicyDocument", - "traits": { - "smithy.api#documentation": "The inline policy that is attached to the permission set.
\nFor Length Constraints, if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned.
Obtains the permissions boundary for a specified PermissionSet.
" + "smithy.api#documentation": "Deletes the permissions boundary from a specified PermissionSet.
" } }, - "com.amazonaws.ssoadmin#GetPermissionsBoundaryForPermissionSetRequest": { + "com.amazonaws.ssoadmin#DeletePermissionsBoundaryFromPermissionSetRequest": { "type": "structure", "members": { "InstanceArn": { @@ -1637,130 +2208,2494 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#GetPermissionsBoundaryForPermissionSetResponse": { + "com.amazonaws.ssoadmin#DeletePermissionsBoundaryFromPermissionSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DeleteTrustedTokenIssuer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DeleteTrustedTokenIssuerRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DeleteTrustedTokenIssuerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
\nDeleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.
\nThe permissions boundary attached to the specified permission set.
" + "smithy.api#documentation": "Specifies the ARN of the trusted token issuer configuration to delete.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#Id": { - "type": "string", + "com.amazonaws.ssoadmin#DeleteTrustedTokenIssuerResponse": { + "type": "structure", + "members": {}, "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, - "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the status of the assignment creation request.
" } }, - "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfiguration": { + "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusRequest": { "type": "structure", "members": { - "AccessControlAttributes": { - "target": "com.amazonaws.ssoadmin#AccessControlAttributeList", + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "AccountAssignmentCreationRequestId": { + "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "Lists the attributes that are configured for ABAC in the specified IAM Identity Center\n instance.
", + "smithy.api#documentation": "The identifier that is used to track the request operation progress.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies the attributes to add to your attribute-based access control (ABAC)\n configuration.
" + "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfigurationStatus": { - "type": "enum", + "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusResponse": { + "type": "structure", "members": { - "ENABLED": { - "target": "smithy.api#Unit", + "AccountAssignmentCreationStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#documentation": "The status object for the account assignment creation operation.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, - "CREATION_IN_PROGRESS": { - "target": "smithy.api#Unit", + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the status of the assignment deletion request.
" + } + }, + "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#enumValue": "CREATION_IN_PROGRESS" + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} } }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", + "AccountAssignmentDeletionRequestId": { + "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#enumValue": "CREATION_FAILED" + "smithy.api#documentation": "The identifier that is used to track the request operation progress.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfigurationStatusReason": { - "type": "string" + "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusResponse": { + "type": "structure", + "members": { + "AccountAssignmentDeletionStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus", + "traits": { + "smithy.api#documentation": "The status object for the account assignment deletion operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "com.amazonaws.ssoadmin#InstanceArn": { - "type": "string", + "com.amazonaws.ssoadmin#DescribeApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribeApplicationRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribeApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "min": 10, - "max": 1224 + "smithy.api#documentation": "Retrieves the details of an application associated with an instance of IAM Identity Center.
" + } + }, + "com.amazonaws.ssoadmin#DescribeApplicationAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribeApplicationAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribeApplicationAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" }, - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#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, \n 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. \n Instead use ListApplicationAssignmentsForPrincipal.
" + } + }, + "com.amazonaws.ssoadmin#DescribeApplicationAssignmentRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "The entity type for which the assignment will be created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DescribeApplicationAssignmentResponse": { + "type": "structure", + "members": { + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "The entity type for which the assignment will be created.
" + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#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.
" + } + }, + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DescribeApplicationProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribeApplicationProviderRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribeApplicationProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.ssoadmin#DescribeApplicationProviderRequest": { + "type": "structure", + "members": { + "ApplicationProviderArn": { + "target": "com.amazonaws.ssoadmin#ApplicationProviderArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application provider for which you want details.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DescribeApplicationProviderResponse": { + "type": "structure", + "members": { + "ApplicationProviderArn": { + "target": "com.amazonaws.ssoadmin#ApplicationProviderArn", + "traits": { + "smithy.api#documentation": "The ARN of the application provider.
", + "smithy.api#required": {} + } + }, + "FederationProtocol": { + "target": "com.amazonaws.ssoadmin#FederationProtocol", + "traits": { + "smithy.api#documentation": "The protocol used to federate to the application provider.
" + } + }, + "DisplayData": { + "target": "com.amazonaws.ssoadmin#DisplayData", + "traits": { + "smithy.api#documentation": "A structure with details about the display data for the application provider.
" + } + }, + "ResourceServerConfig": { + "target": "com.amazonaws.ssoadmin#ResourceServerConfig", + "traits": { + "smithy.api#documentation": "A structure with details about the receiving application.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DescribeApplicationRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DescribeApplicationResponse": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application.
" + } + }, + "ApplicationProviderArn": { + "target": "com.amazonaws.ssoadmin#ApplicationProviderArn", + "traits": { + "smithy.api#documentation": "The ARN of the application provider under which the operation will run.
" + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#NameType", + "traits": { + "smithy.api#documentation": "The application name.
" + } + }, + "ApplicationAccount": { + "target": "com.amazonaws.ssoadmin#AccountId", + "traits": { + "smithy.api#documentation": "The account ID.
" + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + } + }, + "Status": { + "target": "com.amazonaws.ssoadmin#ApplicationStatus", + "traits": { + "smithy.api#documentation": "Specifies whether the application is enabled or disabled.
" + } + }, + "PortalOptions": { + "target": "com.amazonaws.ssoadmin#PortalOptions", + "traits": { + "smithy.api#documentation": "A structure that describes the options for the portal associated with an\n application.
" + } + }, + "Description": { + "target": "com.amazonaws.ssoadmin#Description", + "traits": { + "smithy.api#documentation": "The description of the .
" + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssoadmin#Date", + "traits": { + "smithy.api#documentation": "The date the application was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DescribeInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribeInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribeInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details of an instance of IAM Identity Center. The status can be one of the following:
\n\n CREATE_IN_PROGRESS - The instance is in the process of being created. When the\n instance is ready for use, DescribeInstance returns the status of\n ACTIVE. While the instance is in the\n CREATE_IN_PROGRESS state, you can call only DescribeInstance\n and DeleteInstance operations.
\n DELETE_IN_PROGRESS - The instance is being deleted. Returns AccessDeniedException after the delete operation completes.
\n ACTIVE - The instance is active.
Returns the list of IAM Identity Center identity store attributes that have been configured to work\n with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will\n not return attributes configured and sent by an external identity provider.\n For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
" + } + }, + "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfigurationRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfigurationResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfigurationStatus", + "traits": { + "smithy.api#documentation": "The status of the attribute configuration process.
" + } + }, + "StatusReason": { + "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfigurationStatusReason", + "traits": { + "smithy.api#documentation": "Provides more details about the current status of the specified attribute.
" + } + }, + "InstanceAccessControlAttributeConfiguration": { + "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfiguration", + "traits": { + "smithy.api#documentation": "Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC\n configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DescribeInstanceRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the instance of IAM Identity Center under which the operation will run.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DescribeInstanceResponse": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + } + }, + "IdentityStoreId": { + "target": "com.amazonaws.ssoadmin#Id", + "traits": { + "smithy.api#documentation": "The identifier of the identity store that is connected to the instance of\n IAM Identity Center.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.ssoadmin#AccountId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account for which the instance was created.
" + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#NameType", + "traits": { + "smithy.api#documentation": "Specifies the instance name.
" + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssoadmin#Date", + "traits": { + "smithy.api#documentation": "The date the instance was created.
" + } + }, + "Status": { + "target": "com.amazonaws.ssoadmin#InstanceStatus", + "traits": { + "smithy.api#documentation": "The status of the instance.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribePermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribePermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the details of the permission set.
" + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the status for the given permission set provisioning request.
" + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "ProvisionPermissionSetRequestId": { + "target": "com.amazonaws.ssoadmin#UUId", + "traits": { + "smithy.api#documentation": "The identifier that is provided by the ProvisionPermissionSet call\n to retrieve the current status of the provisioning workflow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusResponse": { + "type": "structure", + "members": { + "PermissionSetProvisioningStatus": { + "target": "com.amazonaws.ssoadmin#PermissionSetProvisioningStatus", + "traits": { + "smithy.api#documentation": "The status object for the permission set provisioning operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the permission set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetResponse": { + "type": "structure", + "members": { + "PermissionSet": { + "target": "com.amazonaws.ssoadmin#PermissionSet", + "traits": { + "smithy.api#documentation": "Describes the level of access on an Amazon Web Services account.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DescribeTrustedTokenIssuer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribeTrustedTokenIssuerRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribeTrustedTokenIssuerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#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.\n
" + } + }, + "com.amazonaws.ssoadmin#DescribeTrustedTokenIssuerRequest": { + "type": "structure", + "members": { + "TrustedTokenIssuerArn": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the trusted token issuer configuration that you want details about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DescribeTrustedTokenIssuerResponse": { + "type": "structure", + "members": { + "TrustedTokenIssuerArn": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerArn", + "traits": { + "smithy.api#documentation": "The ARN of the trusted token issuer configuration.
" + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerName", + "traits": { + "smithy.api#documentation": "The name of the trusted token issuer configuration.
" + } + }, + "TrustedTokenIssuerType": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerType", + "traits": { + "smithy.api#documentation": "The type of the trusted token issuer.
" + } + }, + "TrustedTokenIssuerConfiguration": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerConfiguration", + "traits": { + "smithy.api#documentation": "A structure the describes the settings that apply of this trusted token issuer.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Detaches the specified customer managed policy from the specified PermissionSet.
" + } + }, + "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.
", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the PermissionSet.
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Detaches the attached Amazon Web Services managed policy ARN from the specified permission\n set.
" + } + }, + "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the PermissionSet from which the policy should be\n detached.
", + "smithy.api#required": {} + } + }, + "ManagedPolicyArn": { + "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", + "traits": { + "smithy.api#documentation": "The Amazon Web Services managed policy ARN to be detached from a permission set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#DisplayData": { + "type": "structure", + "members": { + "DisplayName": { + "target": "com.amazonaws.ssoadmin#Name", + "traits": { + "smithy.api#documentation": "The name of the application provider that appears in the portal.
" + } + }, + "IconUrl": { + "target": "com.amazonaws.ssoadmin#IconUrl", + "traits": { + "smithy.api#documentation": "A URL that points to an icon that represents the application provider.
" + } + }, + "Description": { + "target": "com.amazonaws.ssoadmin#Description", + "traits": { + "smithy.api#documentation": "The description of the application provider that appears in the portal.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes how the portal represents an application provider.
" + } + }, + "com.amazonaws.ssoadmin#Duration": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$" + } + }, + "com.amazonaws.ssoadmin#FederationProtocol": { + "type": "enum", + "members": { + "SAML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAML" + } + }, + "OAUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH" + } + } + } + }, + "com.amazonaws.ssoadmin#GetApplicationAccessScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#GetApplicationAccessScopeRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#GetApplicationAccessScopeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the authorized targets for an IAM Identity Center access scope for an application.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationAccessScopeRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application with the access scope that you want to\n retrieve.
", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.ssoadmin#Scope", + "traits": { + "smithy.api#documentation": "Specifies the name of the access scope for which you want the authorized\n targets.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationAccessScopeResponse": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.ssoadmin#Scope", + "traits": { + "smithy.api#documentation": "The name of the access scope that can be used with the authorized targets.
", + "smithy.api#required": {} + } + }, + "AuthorizedTargets": { + "target": "com.amazonaws.ssoadmin#ScopeTargets", + "traits": { + "smithy.api#documentation": "An array of authorized targets associated with this access scope.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationAssignmentConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#GetApplicationAssignmentConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#GetApplicationAssignmentConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the configuration of PutApplicationAssignmentConfiguration.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationAssignmentConfigurationRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationAssignmentConfigurationResponse": { + "type": "structure", + "members": { + "AssignmentRequired": { + "target": "com.amazonaws.ssoadmin#AssignmentRequired", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the \n CreateApplicationAssignment API. If false, all users have access to the application.
Retrieves details about an authentication method used by an application.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationAuthenticationMethodRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application.
", + "smithy.api#required": {} + } + }, + "AuthenticationMethodType": { + "target": "com.amazonaws.ssoadmin#AuthenticationMethodType", + "traits": { + "smithy.api#documentation": "Specifies the type of authentication method for which you want details.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationAuthenticationMethodResponse": { + "type": "structure", + "members": { + "AuthenticationMethod": { + "target": "com.amazonaws.ssoadmin#AuthenticationMethod", + "traits": { + "smithy.api#documentation": "A structure that contains details about the requested authentication method.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#GetApplicationGrantRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#GetApplicationGrantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves details about an application grant.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationGrantRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application that contains the grant.
", + "smithy.api#required": {} + } + }, + "GrantType": { + "target": "com.amazonaws.ssoadmin#GrantType", + "traits": { + "smithy.api#documentation": "Specifies the type of grant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationGrantResponse": { + "type": "structure", + "members": { + "Grant": { + "target": "com.amazonaws.ssoadmin#Grant", + "traits": { + "smithy.api#documentation": "A structure that describes the requested grant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Obtains the inline policy assigned to the permission set.
" + } + }, + "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the permission set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetResponse": { + "type": "structure", + "members": { + "InlinePolicy": { + "target": "com.amazonaws.ssoadmin#PermissionSetPolicyDocument", + "traits": { + "smithy.api#documentation": "The inline policy that is attached to the permission set.
\nFor Length Constraints, if a valid ARN is provided for a permission\n set, it is possible for an empty inline policy to be returned.
Obtains the permissions boundary for a specified PermissionSet.
" + } + }, + "com.amazonaws.ssoadmin#GetPermissionsBoundaryForPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.
", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the PermissionSet.
The permissions boundary attached to the specified permission set.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#Grant": { + "type": "union", + "members": { + "AuthorizationCode": { + "target": "com.amazonaws.ssoadmin#AuthorizationCodeGrant", + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + }, + "JwtBearer": { + "target": "com.amazonaws.ssoadmin#JwtBearerGrant", + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + } + }, + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + }, + "com.amazonaws.ssoadmin#GrantItem": { + "type": "structure", + "members": { + "GrantType": { + "target": "com.amazonaws.ssoadmin#GrantType", + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
", + "smithy.api#required": {} + } + }, + "Grant": { + "target": "com.amazonaws.ssoadmin#Grant", + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + }, + "com.amazonaws.ssoadmin#GrantType": { + "type": "enum", + "members": { + "AUTHORIZATION_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "authorization_code" + } + }, + "REFRESH_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "refresh_token" + } + }, + "JWT_BEARER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "urn:ietf:params:oauth:grant-type:jwt-bearer" + } + }, + "TOKEN_EXCHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "urn:ietf:params:oauth:grant-type:token-exchange" + } + } + } + }, + "com.amazonaws.ssoadmin#Grants": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#GrantItem" + } + }, + "com.amazonaws.ssoadmin#IamAuthenticationMethod": { + "type": "structure", + "members": { + "ActorPolicy": { + "target": "com.amazonaws.ssoadmin#ActorPolicyDocument", + "traits": { + "smithy.api#documentation": "An IAM policy document in JSON.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes details for authentication that uses IAM.
" + } + }, + "com.amazonaws.ssoadmin#IconUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 768 + }, + "smithy.api#pattern": "^(http|https):\\/\\/.*$" + } + }, + "com.amazonaws.ssoadmin#Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfiguration": { + "type": "structure", + "members": { + "AccessControlAttributes": { + "target": "com.amazonaws.ssoadmin#AccessControlAttributeList", + "traits": { + "smithy.api#documentation": "Lists the attributes that are configured for ABAC in the specified IAM Identity Center\n instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the attributes to add to your attribute-based access control (ABAC)\n configuration.
" + } + }, + "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfigurationStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + } + } + }, + "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfigurationStatusReason": { + "type": "string" + }, + "com.amazonaws.ssoadmin#InstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + } + }, + "com.amazonaws.ssoadmin#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#InstanceMetadata" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.ssoadmin#InstanceMetadata": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + } + }, + "IdentityStoreId": { + "target": "com.amazonaws.ssoadmin#Id", + "traits": { + "smithy.api#documentation": "The identifier of the identity store that is connected to the Identity Center\n instance.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.ssoadmin#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID number of the owner of the Identity Center instance.
" + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#NameType", + "traits": { + "smithy.api#documentation": "The name of the Identity Center instance.
" + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssoadmin#Date", + "traits": { + "smithy.api#documentation": "The date and time that the Identity Center instance was created.
" + } + }, + "Status": { + "target": "com.amazonaws.ssoadmin#InstanceStatus", + "traits": { + "smithy.api#documentation": "The current status of this Identity Center instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the IAM Identity Center instance.
" + } + }, + "com.amazonaws.ssoadmin#InstanceStatus": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.ssoadmin#InternalFailureMessage": { + "type": "string" + }, + "com.amazonaws.ssoadmin#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssoadmin#InternalFailureMessage" + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception, or failure\n with an internal server.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.ssoadmin#JMESPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^\\p{L}+(?:\\.\\p{L}+){0,2}$" + } + }, + "com.amazonaws.ssoadmin#JwksRetrievalOption": { + "type": "enum", + "members": { + "OPEN_ID_DISCOVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPEN_ID_DISCOVERY" + } + } + } + }, + "com.amazonaws.ssoadmin#JwtBearerGrant": { + "type": "structure", + "members": { + "AuthorizedTokenIssuers": { + "target": "com.amazonaws.ssoadmin#AuthorizedTokenIssuers", + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + } + }, + "traits": { + "smithy.api#documentation": "~~~[ TODO: ADD DESCRIPTION HERE ]~~~
" + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the status of the Amazon Web Services account assignment creation requests for a specified\n IAM Identity Center instance.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "AccountAssignmentsCreationStatus" + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to display for the assignment.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + } + }, + "Filter": { + "target": "com.amazonaws.ssoadmin#OperationStatusFilter", + "traits": { + "smithy.api#documentation": "Filters results based on the passed attribute value.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusResponse": { + "type": "structure", + "members": { + "AccountAssignmentsCreationStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatusList", + "traits": { + "smithy.api#documentation": "The status object for the account assignment creation operation.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the status of the Amazon Web Services account assignment deletion requests for a specified\n IAM Identity Center instance.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "AccountAssignmentsDeletionStatus" + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatusRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to display for the assignment.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + } + }, + "Filter": { + "target": "com.amazonaws.ssoadmin#OperationStatusFilter", + "traits": { + "smithy.api#documentation": "Filters results based on the passed attribute value.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatusResponse": { + "type": "structure", + "members": { + "AccountAssignmentsDeletionStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatusList", + "traits": { + "smithy.api#documentation": "The status object for the account assignment deletion operation.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentsRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the assignee of the specified Amazon Web Services account with the specified permission\n set.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "AccountAssignments" + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentsFilter": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.ssoadmin#AccountId", + "traits": { + "smithy.api#documentation": "The ID number of an Amazon Web Services account that filters the results in the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes a filter for account assignments.
" + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentsForPrincipal": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentsForPrincipalRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentsForPrincipalResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access\n to.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "AccountAssignments" + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentsForPrincipalRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the instance of IAM Identity Center that contains the principal.
", + "smithy.api#required": {} + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#documentation": "Specifies the principal for which you want to retrieve the list of account\n assignments.
", + "smithy.api#required": {} + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "Specifies the type of the principal.
", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentsFilter", + "traits": { + "smithy.api#documentation": "Specifies an Amazon Web Services account ID number. Results are filtered to only those that match\n this ID number.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
An array list of the account assignments for the principal.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.ssoadmin#TargetId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account from which to list the assignments.
", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the permission set from which to list assignments.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to display for the assignment.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentsResponse": { + "type": "structure", + "members": { + "AccountAssignments": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentList", + "traits": { + "smithy.api#documentation": "The list of assignments that match the input Amazon Web Services account and permission set.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "AccountIds" + } + } + }, + "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the PermissionSet from which the associated Amazon Web Services\n accounts will be listed.
", + "smithy.api#required": {} + } + }, + "ProvisioningStatus": { + "target": "com.amazonaws.ssoadmin#ProvisioningStatus", + "traits": { + "smithy.api#documentation": "The permission set provisioning status for an Amazon Web Services account.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to display for the PermissionSet.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSetResponse": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.ssoadmin#AccountList", + "traits": { + "smithy.api#documentation": "The list of Amazon Web Services AccountIds.
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#ListApplicationAccessScopes": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListApplicationAccessScopesRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListApplicationAccessScopesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the access scopes and authorized targets associated with an application.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Scopes" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssoadmin#ListApplicationAccessScopesRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
An array list of access scopes and their authorized targets that are associated with\n the application.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists Amazon Web Services account users that are assigned to an application.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "ApplicationAssignments" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssoadmin#ListApplicationAssignmentsFilter": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "The ARN of an application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes a filter for application assignments.
" + } + }, + "com.amazonaws.ssoadmin#ListApplicationAssignmentsForPrincipal": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListApplicationAssignmentsForPrincipalRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListApplicationAssignmentsForPrincipalResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the applications to which a specified principal is assigned.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "ApplicationAssignments" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssoadmin#ListApplicationAssignmentsForPrincipalRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "Specifies the instance of IAM Identity Center that contains principal and applications.
", + "smithy.api#required": {} + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#documentation": "Specifies the unique identifier of the principal for which you want to retrieve its\n assignments.
", + "smithy.api#required": {} + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "Specifies the type of the principal for which you want to retrieve its\n assignments.
", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.ssoadmin#ListApplicationAssignmentsFilter", + "traits": { + "smithy.api#documentation": "Filters the output to include only assignments associated with the application that\n has the specified ARN.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
An array list of the application assignments for the specified principal.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + "smithy.api#documentation": "Specifies the ARN of the application.
", + "smithy.api#required": {} } }, - "IdentityStoreId": { - "target": "com.amazonaws.ssoadmin#Id", + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
The identifier of the identity store that is connected to the IAM Identity Center instance.
" + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Provides information about the IAM Identity Center instance.
" + "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#InternalFailureMessage": { - "type": "string" - }, - "com.amazonaws.ssoadmin#InternalServerException": { + "com.amazonaws.ssoadmin#ListApplicationAssignmentsResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.ssoadmin#InternalFailureMessage" + "ApplicationAssignments": { + "target": "com.amazonaws.ssoadmin#ApplicationAssignmentsList", + "traits": { + "smithy.api#documentation": "The list of users assigned to an application.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
The request processing has failed because of an unknown error, exception, or failure with\n an internal server.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#output": {} } }, - "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatus": { + "com.amazonaws.ssoadmin#ListApplicationAuthenticationMethods": { "type": "operation", "input": { - "target": "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusRequest" + "target": "com.amazonaws.ssoadmin#ListApplicationAuthenticationMethodsRequest" }, "output": { - "target": "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusResponse" + "target": "com.amazonaws.ssoadmin#ListApplicationAuthenticationMethodsResponse" }, "errors": [ { @@ -1780,41 +4715,29 @@ } ], "traits": { - "smithy.api#documentation": "Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center\n instance.
", + "smithy.api#documentation": "Lists all of the authentication methods supported by the specified application.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults", - "items": "AccountAssignmentsCreationStatus" - } + "items": "AuthenticationMethods" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusRequest": { + "com.amazonaws.ssoadmin#ListApplicationAuthenticationMethodsRequest": { "type": "structure", "members": { - "InstanceArn": { - "target": "com.amazonaws.ssoadmin#InstanceArn", + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "Specifies the ARN of the application with the authentication methods you want to\n list.
", "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.ssoadmin#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to display for the assignment.
" - } - }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - } - }, - "Filter": { - "target": "com.amazonaws.ssoadmin#OperationStatusFilter", - "traits": { - "smithy.api#documentation": "Filters results based on the passed attribute value.
" + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
The status object for the account assignment creation operation.
" + "smithy.api#documentation": "An array list of authentication methods for the specified application.
" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center\n instance.
", + "smithy.api#documentation": "List the grants associated with an application.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults", - "items": "AccountAssignmentsDeletionStatus" - } + "items": "Grants" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatusRequest": { + "com.amazonaws.ssoadmin#ListApplicationGrantsRequest": { "type": "structure", "members": { - "InstanceArn": { - "target": "com.amazonaws.ssoadmin#InstanceArn", + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "Specifies the ARN of the application whose grants you want to list.
", "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.ssoadmin#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to display for the assignment.
" - } - }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - } - }, - "Filter": { - "target": "com.amazonaws.ssoadmin#OperationStatusFilter", - "traits": { - "smithy.api#documentation": "Filters results based on the passed attribute value.
" + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
The status object for the account assignment deletion operation.
" + "smithy.api#documentation": "An array list of structures that describe the requested grants.
", + "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
", + "smithy.api#documentation": "Lists the application providers configured in the IAM Identity Center identity store.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", - "items": "AccountAssignments" + "items": "ApplicationProviders" } } }, - "com.amazonaws.ssoadmin#ListAccountAssignmentsRequest": { + "com.amazonaws.ssoadmin#ListApplicationProvidersRequest": { "type": "structure", "members": { - "InstanceArn": { - "target": "com.amazonaws.ssoadmin#InstanceArn", - "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", - "smithy.api#required": {} - } - }, - "AccountId": { - "target": "com.amazonaws.ssoadmin#TargetId", - "traits": { - "smithy.api#documentation": "The identifier of the Amazon Web Services account from which to list the assignments.
", - "smithy.api#required": {} - } - }, - "PermissionSetArn": { - "target": "com.amazonaws.ssoadmin#PermissionSetArn", - "traits": { - "smithy.api#documentation": "The ARN of the permission set from which to list assignments.
", - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.ssoadmin#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to display for the assignment.
" + "smithy.api#documentation": "Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
The list of assignments that match the input Amazon Web Services account and permission set.
" + "smithy.api#documentation": "An array list of structures that describe application providers.
" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
", + "smithy.api#documentation": "Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance\n in the management account, member accounts must use the applicationAccount\n parameter to filter the list to only applications created from that account.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", - "smithy.api#required": {} + "smithy.api#documentation": "An Amazon Web Services account ID number that filters the results in the response.
" } }, - "PermissionSetArn": { - "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "ApplicationProvider": { + "target": "com.amazonaws.ssoadmin#ApplicationProviderArn", "traits": { - "smithy.api#documentation": "The ARN of the PermissionSet from which the associated Amazon Web Services accounts\n will be listed.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ARN of an application provider that can filter the results in the response.
" } - }, - "ProvisioningStatus": { - "target": "com.amazonaws.ssoadmin#ProvisioningStatus", + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes a filter for applications.
" + } + }, + "com.amazonaws.ssoadmin#ListApplicationsRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The permission set provisioning status for an Amazon Web Services account.
" + "smithy.api#documentation": "The ARN of the IAM Identity Center application under which the operation will run.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.ssoadmin#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to display for the PermissionSet.
" + "smithy.api#documentation": "Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Filters response results.
" } } }, @@ -2101,19 +4999,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSetResponse": { + "com.amazonaws.ssoadmin#ListApplicationsResponse": { "type": "structure", "members": { - "AccountIds": { - "target": "com.amazonaws.ssoadmin#AccountList", + "Applications": { + "target": "com.amazonaws.ssoadmin#ApplicationList", "traits": { - "smithy.api#documentation": "The list of Amazon Web Services AccountIds.
Retrieves all applications associated with the instance.
" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n 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\n previous API calls to make subsequent calls.
" + "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of\n previous API calls to make subsequent calls.
" } } }, @@ -2196,13 +5094,13 @@ "CustomerManagedPolicyReferences": { "target": "com.amazonaws.ssoadmin#CustomerManagedPolicyReferenceList", "traits": { - "smithy.api#documentation": "Specifies the names and paths of the customer managed policies that you have attached to\n your permission set.
" + "smithy.api#documentation": "Specifies the names and paths of the customer managed policies that you have attached\n to your permission set.
" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of\n previous API calls to make subsequent calls.
" + "smithy.api#documentation": "The pagination token for the list API. Initially the value is null. Use the output of\n previous API calls to make subsequent calls.
" } } }, @@ -2233,7 +5131,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the IAM Identity Center instances that the caller has access to.
", + "smithy.api#documentation": "Lists the details of the organization and account instances of IAM Identity Center that\n were created in or visible to the account calling this API.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2323,14 +5221,14 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "The ARN of the PermissionSet whose managed policies will be\n listed.
", + "smithy.api#documentation": "The ARN of the PermissionSet whose managed policies will be\n listed.
", "smithy.api#required": {} } }, @@ -2397,7 +5295,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the status of the permission set provisioning requests for a specified IAM Identity Center\n instance.
", + "smithy.api#documentation": "Lists the status of the permission set provisioning requests for a specified IAM Identity Center\n instance.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2412,7 +5310,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, @@ -2520,7 +5418,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
", + "smithy.api#documentation": "Lists all the permission sets that are provisioned to a specified Amazon Web Services\n account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2535,7 +5433,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, @@ -2595,7 +5493,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, @@ -2676,8 +5574,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" } }, "ResourceArn": { @@ -2718,6 +5615,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssoadmin#ListTrustedTokenIssuers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListTrustedTokenIssuersRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListTrustedTokenIssuersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the trusted token issuers configured in an instance of IAM Identity Center.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "TrustedTokenIssuers" + } + } + }, + "com.amazonaws.ssoadmin#ListTrustedTokenIssuersRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the instance of IAM Identity Center with the trusted token issuer configurations that you want\n to list.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
An array list of the trusted token issuer configurations.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
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.
", + "smithy.api#required": {} + } + }, + "ClaimAttributePath": { + "target": "com.amazonaws.ssoadmin#ClaimAttributePath", + "traits": { + "smithy.api#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\n 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\n 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\n JWT.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes configuration settings for a trusted token issuer that supports OpenID\n Connect (OIDC) and JSON Web Tokens (JWTs).
" + } + }, + "com.amazonaws.ssoadmin#OidcJwtUpdateConfiguration": { + "type": "structure", + "members": { + "ClaimAttributePath": { + "target": "com.amazonaws.ssoadmin#ClaimAttributePath", + "traits": { + "smithy.api#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\n 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\n 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\n JWT.
" + } } + }, + "traits": { + "smithy.api#documentation": "A structure that describes updated configuration settings for a trusted token issuer that supports\n OpenID Connect (OIDC) and JSON Web Tokens (JWTs).
" } }, "com.amazonaws.ssoadmin#OperationStatusFilter": { @@ -2777,7 +5825,7 @@ } }, "traits": { - "smithy.api#documentation": "Filters he operation status list based on the passed attribute value.
" + "smithy.api#documentation": "Filters the operation status list based on the passed attribute value.
" } }, "com.amazonaws.ssoadmin#PermissionSet": { @@ -2810,13 +5858,13 @@ "SessionDuration": { "target": "com.amazonaws.ssoadmin#Duration", "traits": { - "smithy.api#documentation": "The length of time that the application user sessions are valid for in the ISO-8601\n standard.
" + "smithy.api#documentation": "The length of time that the application user sessions are valid for in the ISO-8601\n standard.
" } }, "RelayState": { "target": "com.amazonaws.ssoadmin#RelayState", "traits": { - "smithy.api#documentation": "Used to redirect users within the application during the federation authentication\n process.
" + "smithy.api#documentation": "Used to redirect users within the application during the federation authentication\n process.
" } } }, @@ -2882,7 +5930,7 @@ "RequestId": { "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.
" + "smithy.api#documentation": "The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.
" } }, "AccountId": { @@ -2900,7 +5948,7 @@ "FailureReason": { "target": "com.amazonaws.ssoadmin#Reason", "traits": { - "smithy.api#documentation": "The message that contains an error or exception in case of an operation failure.
" + "smithy.api#documentation": "The message that contains an error or exception in case of an operation\n failure.
" } }, "CreatedDate": { @@ -2911,7 +5959,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that is used to provide the status of the provisioning operation for a\n specified permission set.
" + "smithy.api#documentation": "A structure that is used to provide the status of the provisioning operation for a\n specified permission set.
" } }, "com.amazonaws.ssoadmin#PermissionSetProvisioningStatusList": { @@ -2932,7 +5980,7 @@ "RequestId": { "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.
" + "smithy.api#documentation": "The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.
" } }, "CreatedDate": { @@ -2958,12 +6006,33 @@ "ManagedPolicyArn": { "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", "traits": { - "smithy.api#documentation": "The Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions\n boundary.
" + "smithy.api#documentation": "The Amazon Web Services managed policy ARN that you want to attach to a permission set as a\n permissions boundary.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the configuration of the Amazon Web Services managed or customer managed policy that you\n want to set as a permissions boundary. Specify either\n CustomerManagedPolicyReference to use the name and path of a customer\n managed policy, or ManagedPolicyArn to use the ARN of an Amazon Web Services managed\n policy. A permissions boundary represents the maximum permissions that any policy can\n grant your role. For more information, see Permissions boundaries\n for IAM entities in the IAM User Guide.
Policies used as permissions boundaries don't provide permissions. You must also\n attach an IAM policy to the role. To learn how the effective permissions for a\n role are evaluated, see IAM JSON\n policy evaluation logic in the IAM User\n Guide.
\nA structure that describes the sign-in options for the access portal.
" + } + }, + "Visibility": { + "target": "com.amazonaws.ssoadmin#ApplicationVisibility", + "traits": { + "smithy.api#default": "ENABLED", + "smithy.api#documentation": "Indicates whether this application is visible in the access portal.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the configuration of the Amazon Web Services managed or customer managed policy that you want\n to set as a permissions boundary. Specify either CustomerManagedPolicyReference\n to use the name and path of a customer managed policy, or ManagedPolicyArn to use\n the ARN of an Amazon Web Services managed policy. A permissions boundary represents the maximum permissions\n that any policy can grant your role. For more information, see Permissions boundaries for IAM\n entities in the IAM User Guide.
Policies used as permissions boundaries don't provide permissions. You must also attach\n an IAM policy to the role. To learn how the effective permissions for a role are\n evaluated, see IAM JSON policy\n evaluation logic in the IAM User Guide.
\nA structure that describes the options for the access portal associated with an\n application.
" } }, "com.amazonaws.ssoadmin#PrincipalId": { @@ -2993,13 +6062,252 @@ } } }, - "com.amazonaws.ssoadmin#ProvisionPermissionSet": { + "com.amazonaws.ssoadmin#ProvisionPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ProvisionPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ProvisionPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "The process by which a specified permission set is provisioned to the specified\n target.
" + } + }, + "com.amazonaws.ssoadmin#ProvisionPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "The ARN of the permission set.
", + "smithy.api#required": {} + } + }, + "TargetId": { + "target": "com.amazonaws.ssoadmin#TargetId", + "traits": { + "smithy.api#documentation": "TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" + } + }, + "TargetType": { + "target": "com.amazonaws.ssoadmin#ProvisionTargetType", + "traits": { + "smithy.api#documentation": "The entity type for which the assignment will be created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#ProvisionPermissionSetResponse": { + "type": "structure", + "members": { + "PermissionSetProvisioningStatus": { + "target": "com.amazonaws.ssoadmin#PermissionSetProvisioningStatus", + "traits": { + "smithy.api#documentation": "The status object for the permission set provisioning operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#ProvisionTargetType": { + "type": "enum", + "members": { + "AWS_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_ACCOUNT" + } + }, + "ALL_PROVISIONED_ACCOUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_PROVISIONED_ACCOUNTS" + } + } + } + }, + "com.amazonaws.ssoadmin#ProvisioningStatus": { + "type": "enum", + "members": { + "LATEST_PERMISSION_SET_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST_PERMISSION_SET_PROVISIONED" + } + }, + "LATEST_PERMISSION_SET_NOT_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST_PERMISSION_SET_NOT_PROVISIONED" + } + } + } + }, + "com.amazonaws.ssoadmin#PutApplicationAccessScope": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#PutApplicationAccessScopeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or updates the list of authorized targets for an IAM Identity Center access scope for an\n application.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssoadmin#PutApplicationAccessScopeRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.ssoadmin#Scope", + "traits": { + "smithy.api#documentation": "Specifies the name of the access scope to be associated with the specified\n targets.
", + "smithy.api#required": {} + } + }, + "AuthorizedTargets": { + "target": "com.amazonaws.ssoadmin#ScopeTargets", + "traits": { + "smithy.api#documentation": "Specifies an array list of ARNs that represent the authorized targets for this access\n scope.
" + } + }, + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application with the access scope with the targets to add or\n update.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#PutApplicationAssignmentConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#PutApplicationAssignmentConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#PutApplicationAssignmentConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#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 \n CreateApplicationAssignment API. If false, all users have access to the application. \n If an assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to true.
Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "AssignmentRequired": { + "target": "com.amazonaws.ssoadmin#AssignmentRequired", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the \n CreateApplicationAssignment API. If false, all users have access to the application.
The process by which a specified permission set is provisioned to the specified\n target.
" + "smithy.api#documentation": "Adds or updates an authentication method for an application.
", + "smithy.api#idempotent": {} } }, - "com.amazonaws.ssoadmin#ProvisionPermissionSetRequest": { + "com.amazonaws.ssoadmin#PutApplicationAuthenticationMethodRequest": { "type": "structure", "members": { - "InstanceArn": { - "target": "com.amazonaws.ssoadmin#InstanceArn", + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "Specifies the ARN of the application with the authentication method to add or\n update.
", "smithy.api#required": {} } }, - "PermissionSetArn": { - "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "AuthenticationMethodType": { + "target": "com.amazonaws.ssoadmin#AuthenticationMethodType", "traits": { - "smithy.api#documentation": "The ARN of the permission set.
", + "smithy.api#documentation": "Specifies the type of the authentication method that you want to add or update.
", "smithy.api#required": {} } }, - "TargetId": { - "target": "com.amazonaws.ssoadmin#TargetId", - "traits": { - "smithy.api#documentation": "TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" - } - }, - "TargetType": { - "target": "com.amazonaws.ssoadmin#ProvisionTargetType", + "AuthenticationMethod": { + "target": "com.amazonaws.ssoadmin#AuthenticationMethod", "traits": { - "smithy.api#documentation": "The entity type for which the assignment will be created.
", + "smithy.api#documentation": "Specifies a structure that describes the authentication method to add or update. The\n structure type you provide is determined by the AuthenticationMethodType\n parameter.
The status object for the permission set provisioning operation.
" - } - } + "com.amazonaws.ssoadmin#PutApplicationGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#PutApplicationGrantRequest" + }, + "output": { + "target": "smithy.api#Unit" }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Adds a grant to an application.
", + "smithy.api#idempotent": {} } }, - "com.amazonaws.ssoadmin#ProvisionTargetType": { - "type": "enum", + "com.amazonaws.ssoadmin#PutApplicationGrantRequest": { + "type": "structure", "members": { - "AWS_ACCOUNT": { - "target": "smithy.api#Unit", + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#enumValue": "AWS_ACCOUNT" + "smithy.api#documentation": "Specifies the ARN of the application to update.
", + "smithy.api#required": {} } }, - "ALL_PROVISIONED_ACCOUNTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_PROVISIONED_ACCOUNTS" - } - } - } - }, - "com.amazonaws.ssoadmin#ProvisioningStatus": { - "type": "enum", - "members": { - "LATEST_PERMISSION_SET_PROVISIONED": { - "target": "smithy.api#Unit", + "GrantType": { + "target": "com.amazonaws.ssoadmin#GrantType", "traits": { - "smithy.api#enumValue": "LATEST_PERMISSION_SET_PROVISIONED" + "smithy.api#documentation": "Specifies the type of grant to update.
", + "smithy.api#required": {} } }, - "LATEST_PERMISSION_SET_NOT_PROVISIONED": { - "target": "smithy.api#Unit", + "Grant": { + "target": "com.amazonaws.ssoadmin#Grant", "traits": { - "smithy.api#enumValue": "LATEST_PERMISSION_SET_NOT_PROVISIONED" + "smithy.api#documentation": "Specifies a structure that describes the grant to update.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSet": { @@ -3140,7 +6457,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches an inline policy to a permission set.
\nIf the permission set is already referenced by one or more account assignments, you will\n need to call \n ProvisionPermissionSet\n after this action to\n apply the corresponding IAM policy updates to all assigned accounts.
Attaches an inline policy to a permission set.
\nIf the permission set is already referenced by one or more account assignments,\n you will need to call \n ProvisionPermissionSet\n after\n this action to apply the corresponding IAM policy updates to all assigned\n accounts.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, @@ -3231,7 +6548,7 @@ "PermissionsBoundary": { "target": "com.amazonaws.ssoadmin#PermissionsBoundary", "traits": { - "smithy.api#documentation": "The permissions boundary that you want to attach to a PermissionSet.
The permissions boundary that you want to attach to a\n PermissionSet.
A list of the IAM Identity Center access scopes that are associated with this resource\n server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes the configuration of a resource server.
" + } + }, + "com.amazonaws.ssoadmin#ResourceServerScope": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 80 + }, + "smithy.api#pattern": "^[^:=\\-\\.\\s][0-9a-zA-Z_:\\-\\.]+$" + } + }, + "com.amazonaws.ssoadmin#ResourceServerScopeDetails": { + "type": "structure", + "members": { + "LongDescription": { + "target": "com.amazonaws.ssoadmin#Description", + "traits": { + "smithy.api#documentation": "The description of an access scope for a resource server.
" + } + }, + "DetailedTitle": { + "target": "com.amazonaws.ssoadmin#Description", + "traits": { + "smithy.api#documentation": "The title of an access scope for a resource server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes details for an IAM Identity Center access scope that is associated with a\n resource server.
" + } + }, + "com.amazonaws.ssoadmin#ResourceServerScopes": { + "type": "map", + "key": { + "target": "com.amazonaws.ssoadmin#ResourceServerScope" + }, + "value": { + "target": "com.amazonaws.ssoadmin#ResourceServerScopeDetails" + } + }, "com.amazonaws.ssoadmin#SWBExternalService": { "type": "service", "version": "2020-07-20", @@ -3292,18 +6674,39 @@ { "target": "com.amazonaws.ssoadmin#CreateAccountAssignment" }, + { + "target": "com.amazonaws.ssoadmin#CreateApplication" + }, + { + "target": "com.amazonaws.ssoadmin#CreateApplicationAssignment" + }, + { + "target": "com.amazonaws.ssoadmin#CreateInstance" + }, { "target": "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfiguration" }, { "target": "com.amazonaws.ssoadmin#CreatePermissionSet" }, + { + "target": "com.amazonaws.ssoadmin#CreateTrustedTokenIssuer" + }, { "target": "com.amazonaws.ssoadmin#DeleteAccountAssignment" }, + { + "target": "com.amazonaws.ssoadmin#DeleteApplication" + }, + { + "target": "com.amazonaws.ssoadmin#DeleteApplicationAssignment" + }, { "target": "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSet" }, + { + "target": "com.amazonaws.ssoadmin#DeleteInstance" + }, { "target": "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfiguration" }, @@ -3313,12 +6716,27 @@ { "target": "com.amazonaws.ssoadmin#DeletePermissionSet" }, + { + "target": "com.amazonaws.ssoadmin#DeleteTrustedTokenIssuer" + }, { "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatus" }, { "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatus" }, + { + "target": "com.amazonaws.ssoadmin#DescribeApplication" + }, + { + "target": "com.amazonaws.ssoadmin#DescribeApplicationAssignment" + }, + { + "target": "com.amazonaws.ssoadmin#DescribeApplicationProvider" + }, + { + "target": "com.amazonaws.ssoadmin#DescribeInstance" + }, { "target": "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfiguration" }, @@ -3328,12 +6746,18 @@ { "target": "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatus" }, + { + "target": "com.amazonaws.ssoadmin#DescribeTrustedTokenIssuer" + }, { "target": "com.amazonaws.ssoadmin#DetachCustomerManagedPolicyReferenceFromPermissionSet" }, { "target": "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSet" }, + { + "target": "com.amazonaws.ssoadmin#GetApplicationAssignmentConfiguration" + }, { "target": "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSet" }, @@ -3349,9 +6773,24 @@ { "target": "com.amazonaws.ssoadmin#ListAccountAssignments" }, + { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentsForPrincipal" + }, { "target": "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSet" }, + { + "target": "com.amazonaws.ssoadmin#ListApplicationAssignments" + }, + { + "target": "com.amazonaws.ssoadmin#ListApplicationAssignmentsForPrincipal" + }, + { + "target": "com.amazonaws.ssoadmin#ListApplicationProviders" + }, + { + "target": "com.amazonaws.ssoadmin#ListApplications" + }, { "target": "com.amazonaws.ssoadmin#ListCustomerManagedPolicyReferencesInPermissionSet" }, @@ -3373,9 +6812,15 @@ { "target": "com.amazonaws.ssoadmin#ListTagsForResource" }, + { + "target": "com.amazonaws.ssoadmin#ListTrustedTokenIssuers" + }, { "target": "com.amazonaws.ssoadmin#ProvisionPermissionSet" }, + { + "target": "com.amazonaws.ssoadmin#PutApplicationAssignmentConfiguration" + }, { "target": "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSet" }, @@ -3388,11 +6833,31 @@ { "target": "com.amazonaws.ssoadmin#UntagResource" }, + { + "target": "com.amazonaws.ssoadmin#UpdateApplication" + }, + { + "target": "com.amazonaws.ssoadmin#UpdateInstance" + }, { "target": "com.amazonaws.ssoadmin#UpdateInstanceAccessControlAttributeConfiguration" }, { "target": "com.amazonaws.ssoadmin#UpdatePermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#UpdateTrustedTokenIssuer" + } + ], + "resources": [ + { + "target": "com.amazonaws.ssoadmin#ApplicationAccessScopeResource" + }, + { + "target": "com.amazonaws.ssoadmin#ApplicationAuthenticationMethodResource" + }, + { + "target": "com.amazonaws.ssoadmin#ApplicationGrantResource" } ], "traits": { @@ -3407,7 +6872,10 @@ "name": "sso" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "IAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage their\n access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended\n approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size\n and type.
\nIAM Identity Center uses the sso and identitystore API namespaces.
This reference guide provides information on single sign-on operations which could be used for\n access management of Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User\n Guide.
\nMany operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as\n principals. For more information about how to work with principals and principal IDs in IAM Identity Center,\n see the Identity Store API\n Reference.
\nAmazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a\n convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more\n information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
\nIAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage\n their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended\n approach for workforce authentication and authorization in Amazon Web Services, for organizations of\n any size and type.
\nIAM Identity Center uses the sso and identitystore API\n namespaces.
This reference guide provides information on single sign-on operations which could be\n used for access management of Amazon Web Services accounts. For information about IAM Identity Center features, see\n the IAM Identity Center\n User Guide.
\nMany operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as\n principals. For more information about how to work with principals and principal IDs in\n IAM Identity Center, see the Identity Store API\n Reference.
\nAmazon Web Services provides SDKs that consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The\n SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services\n services. For more information about the Amazon Web Services SDKs, including how to download and\n install them, see Tools for Amazon Web\n Services.
\nThe name of the access scope.
", + "smithy.api#required": {} + } + }, + "AuthorizedTargets": { + "target": "com.amazonaws.ssoadmin#ScopeTargets", + "traits": { + "smithy.api#documentation": "An array list of ARNs of applications.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes an IAM Identity Center access scope and its authorized targets.
" + } + }, + "com.amazonaws.ssoadmin#ScopeTarget": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#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})$" + } + }, + "com.amazonaws.ssoadmin#ScopeTargets": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#ScopeTarget" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ssoadmin#Scopes": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#ScopeDetails" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.ssoadmin#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -4332,7 +7861,7 @@ } }, "traits": { - "smithy.api#documentation": "Indicates that the principal has crossed the permitted number of resources that can be\n created.
", + "smithy.api#documentation": "Indicates that the principal has crossed the permitted number of resources that can be\n created.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -4340,6 +7869,44 @@ "com.amazonaws.ssoadmin#ServiceQuotaExceededMessage": { "type": "string" }, + "com.amazonaws.ssoadmin#SignInOptions": { + "type": "structure", + "members": { + "Origin": { + "target": "com.amazonaws.ssoadmin#SignInOrigin", + "traits": { + "smithy.api#documentation": "This determines how IAM Identity Center navigates the user to the target application. It can be one\n of the following values:
\n\n APPLICATION: IAM Identity Center redirects the customer to the configured\n ApplicationUrl.
\n IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated\n authentication to sign the customer directly into a SAML-based\n application.
The URL that accepts authentication requests for an application. This is a required\n parameter if the Origin parameter is APPLICATION.
A structure that describes the sign-in options for an application portal.
" + } + }, + "com.amazonaws.ssoadmin#SignInOrigin": { + "type": "enum", + "members": { + "IDENTITY_CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDENTITY_CENTER" + } + }, + "APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION" + } + } + } + }, "com.amazonaws.ssoadmin#StatusValues": { "type": "enum", "members": { @@ -4382,7 +7949,7 @@ } }, "traits": { - "smithy.api#documentation": "A set of key-value pairs that are used to manage the resource. Tags can only be applied to\n permission sets and cannot be applied to corresponding roles that IAM Identity Center creates in Amazon Web Services\n accounts.
" + "smithy.api#documentation": "A set of key-value pairs that are used to manage the resource. Tags can only be\n applied to permission sets and cannot be applied to corresponding roles that IAM Identity Center\n creates in Amazon Web Services accounts.
" } }, "com.amazonaws.ssoadmin#TagKey": { @@ -4403,7 +7970,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 50 + "max": 75 } } }, @@ -4415,7 +7982,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 50 + "max": 75 } } }, @@ -4460,8 +8027,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" } }, "ResourceArn": { @@ -4507,7 +8073,7 @@ "min": 10, "max": 2048 }, - "smithy.api#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}$" + "smithy.api#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}))$" } }, "com.amazonaws.ssoadmin#TargetId": { @@ -4539,7 +8105,7 @@ } }, "traits": { - "smithy.api#documentation": "Indicates that the principal has crossed the throttling limits of the API\n operations.
", + "smithy.api#documentation": "Indicates that the principal has crossed the throttling limits of the API\n operations.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -4557,6 +8123,131 @@ "smithy.api#pattern": "^[-a-zA-Z0-9+=/_]*$" } }, + "com.amazonaws.ssoadmin#TokenIssuerAudience": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.ssoadmin#TokenIssuerAudiences": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#TokenIssuerAudience" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ssoadmin#TrustedTokenIssuerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#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}$" + } + }, + "com.amazonaws.ssoadmin#TrustedTokenIssuerConfiguration": { + "type": "union", + "members": { + "OidcJwtConfiguration": { + "target": "com.amazonaws.ssoadmin#OidcJwtConfiguration", + "traits": { + "smithy.api#documentation": "A structure that describes the settings for a trusted token issuer that works with OpenID Connect\n (OIDC) by using JSON Web Tokens (JWT).
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes the configuration of a trusted token issuer. The structure and available\n settings are determined by the type of the trusted token issuer.
" + } + }, + "com.amazonaws.ssoadmin#TrustedTokenIssuerList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerMetadata" + } + }, + "com.amazonaws.ssoadmin#TrustedTokenIssuerMetadata": { + "type": "structure", + "members": { + "TrustedTokenIssuerArn": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerArn", + "traits": { + "smithy.api#documentation": "The ARN of the trusted token issuer configuration in the instance of IAM Identity Center.
" + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerName", + "traits": { + "smithy.api#documentation": "The name of the trusted token issuer configuration in the instance of IAM Identity Center.
" + } + }, + "TrustedTokenIssuerType": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerType", + "traits": { + "smithy.api#documentation": "The type of trusted token issuer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes a trusted token issuer.
" + } + }, + "com.amazonaws.ssoadmin#TrustedTokenIssuerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.ssoadmin#TrustedTokenIssuerType": { + "type": "enum", + "members": { + "OIDC_JWT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OIDC_JWT" + } + } + } + }, + "com.amazonaws.ssoadmin#TrustedTokenIssuerUpdateConfiguration": { + "type": "union", + "members": { + "OidcJwtConfiguration": { + "target": "com.amazonaws.ssoadmin#OidcJwtUpdateConfiguration", + "traits": { + "smithy.api#documentation": "A structure that describes an updated configuration for a trusted token issuer that uses OpenID\n Connect (OIDC) with JSON web tokens (JWT).
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains details to be updated for a trusted token issuer configuration. The\n structure and settings that you can include depend on the type of the trusted token issuer being\n updated.
" + } + }, + "com.amazonaws.ssoadmin#TrustedTokenIssuerUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^https?:\\/\\/[-a-zA-Z0-9+&@\\/%=~_|!:,.;]*[-a-zA-Z0-9+&@\\/%=~_|]$" + } + }, + "com.amazonaws.ssoadmin#URI": { + "type": "string" + }, "com.amazonaws.ssoadmin#UUId": { "type": "string", "traits": { @@ -4605,8 +8296,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" } }, "ResourceArn": { @@ -4635,6 +8325,124 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssoadmin#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#UpdateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates application properties.
" + } + }, + "com.amazonaws.ssoadmin#UpdateApplicationPortalOptions": { + "type": "structure", + "members": { + "SignInOptions": { + "target": "com.amazonaws.ssoadmin#SignInOptions" + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.ssoadmin#UpdateApplicationRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#NameType", + "traits": { + "smithy.api#documentation": "Specifies the updated name for the application.
" + } + }, + "Description": { + "target": "com.amazonaws.ssoadmin#Description", + "traits": { + "smithy.api#documentation": "The description of the .
" + } + }, + "Status": { + "target": "com.amazonaws.ssoadmin#ApplicationStatus", + "traits": { + "smithy.api#documentation": "Specifies whether the application is enabled or disabled.
" + } + }, + "PortalOptions": { + "target": "com.amazonaws.ssoadmin#UpdateApplicationPortalOptions", + "traits": { + "smithy.api#documentation": "A structure that describes the options for the portal associated with an\n application.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#UpdateApplicationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssoadmin#UpdateInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#UpdateInstanceRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#UpdateInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update the details for the instance of IAM Identity Center that is owned by the\n Amazon Web Services account.
" + } + }, "com.amazonaws.ssoadmin#UpdateInstanceAccessControlAttributeConfiguration": { "type": "operation", "input": { @@ -4664,7 +8472,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance\n for attributes-based access control (ABAC). When using an external identity provider as an\n identity source, you can pass attributes through the SAML assertion as an alternative to\n configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of\n these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center\n identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
" + "smithy.api#documentation": "Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance\n for attributes-based access control (ABAC). When using an external identity provider as\n an identity source, you can pass attributes through the SAML assertion as an alternative\n to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any\n of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center\n identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
" } }, "com.amazonaws.ssoadmin#UpdateInstanceAccessControlAttributeConfigurationRequest": { @@ -4696,6 +8504,35 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssoadmin#UpdateInstanceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssoadmin#NameType", + "traits": { + "smithy.api#documentation": "Updates the instance name.
", + "smithy.api#required": {} + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#UpdateInstanceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssoadmin#UpdatePermissionSet": { "type": "operation", "input": { @@ -4734,7 +8571,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, @@ -4754,13 +8591,13 @@ "SessionDuration": { "target": "com.amazonaws.ssoadmin#Duration", "traits": { - "smithy.api#documentation": "The length of time that the application user sessions are valid for in the ISO-8601\n standard.
" + "smithy.api#documentation": "The length of time that the application user sessions are valid for in the ISO-8601\n standard.
" } }, "RelayState": { "target": "com.amazonaws.ssoadmin#RelayState", "traits": { - "smithy.api#documentation": "Used to redirect users within the application during the federation authentication\n process.
" + "smithy.api#documentation": "Used to redirect users within the application during the federation authentication\n process.
" } } }, @@ -4775,6 +8612,72 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssoadmin#UpdateTrustedTokenIssuer": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#UpdateTrustedTokenIssuerRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#UpdateTrustedTokenIssuerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#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.
\nUpdating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.
\nSpecifies the ARN of the trusted token issuer configuration that you want to update.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerName", + "traits": { + "smithy.api#documentation": "Specifies the updated name to be applied to the trusted token issuer configuration.
" + } + }, + "TrustedTokenIssuerConfiguration": { + "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerUpdateConfiguration", + "traits": { + "smithy.api#documentation": "Specifies a structure with settings to apply to the specified trusted token issuer. The settings that\n you can provide are determined by the type of the trusted token issuer that you are updating.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#UpdateTrustedTokenIssuerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssoadmin#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/transfer.json b/codegen/sdk/aws-models/transfer.json index e4ebf5ee480..e08ad173812 100644 --- a/codegen/sdk/aws-models/transfer.json +++ b/codegen/sdk/aws-models/transfer.json @@ -1,33 +1,5 @@ { "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, "shapes": { "com.amazonaws.transfer#AccessDeniedException": { "type": "structure", @@ -89,7 +61,7 @@ "min": 20, "max": 1600 }, - "smithy.api#pattern": "^arn:" + "smithy.api#pattern": "^arn:\\S+$" } }, "com.amazonaws.transfer#As2ConnectorConfig": { @@ -865,7 +837,7 @@ } }, "LoggingRole": { - "target": "com.amazonaws.transfer#Role", + "target": "com.amazonaws.transfer#NullableRole", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.
" } @@ -917,6 +889,12 @@ "traits": { "smithy.api#documentation": "Specifies the log groups to which your server logs are sent.
\nTo 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:
\n\n arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*\n
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*\n
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\n value for this parameter in an update-server call. For example:
\n update-server --server-id s-1234567890abcdef0 --structured-log-destinations\n
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
\nBy default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry\n Type to FILE if you want a mapping to have a file target.
The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.
\nThe three standard SSH public key format elements are , and an optional
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
\nFor RSA keys, the key type is ssh-rsa.
For ED25519 keys, the key type is ssh-ed25519.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256,\n ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the\n size of the key you generated.
The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.
\nThe three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
\nFor RSA keys, the key type is ssh-rsa.
For ED25519 keys, the key type is ssh-ed25519.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256,\n ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the\n size of the key you generated.
Describes the access that is assigned to the specific file transfer protocol-enabled\n server, as identified by its ServerId property and its\n ExternalId.
The response from this call returns the properties of the access that is associated with\n the ServerId value that was specified.
Describes the access that is assigned to the specific file transfer protocol-enabled\n server, as identified by its ServerId property and its\n ExternalId.
The response from this call returns the properties of the access that is associated with\n the ServerId value that was specified.
Describes the agreement that's identified by the AgreementId.
Describes the agreement that's identified by the AgreementId.
Describes the certificate that's identified by the CertificateId.
Describes the certificate that's identified by the CertificateId.
Describes the connector that's identified by the ConnectorId.\n
Describes the connector that's identified by the ConnectorId.\n
You can use DescribeExecution to check the details of the execution of the specified workflow.
This API call only returns details for in-progress workflows.
\n\n If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a\n ResourceNotFound exception.
You can use DescribeExecution to check the details of the execution of the specified workflow.
This API call only returns details for in-progress workflows.
\n\n If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a\n ResourceNotFound exception.
Returns the details of the host key that's specified by the HostKeyId and ServerId.
Returns the details of the host key that's specified by the HostKeyId and ServerId.
Returns the details of the profile that's specified by the ProfileId.
Returns the details of the profile that's specified by the ProfileId.
Describes the security policy that is attached to your file transfer protocol-enabled\n server. The response contains a description of the security policy's properties. For more\n information about security policies, see Working with security\n policies.
" + "smithy.api#documentation": "Describes the security policy that is attached to your file transfer protocol-enabled\n server. The response contains a description of the security policy's properties. For more\n information about security policies, see Working with security\n policies.
", + "smithy.api#readonly": {} } }, "com.amazonaws.transfer#DescribeSecurityPolicyRequest": { @@ -2249,6 +2235,7 @@ ], "traits": { "smithy.api#documentation": "Describes a file transfer protocol-enabled server that you specify by passing the\n ServerId parameter.
The response contains a description of a server's properties. When you set\n EndpointType to VPC, the response will contain the\n EndpointDetails.
Describes the user assigned to the specific file transfer protocol-enabled server, as\n identified by its ServerId property.
The response from this call returns the properties of the user associated with the\n ServerId value that was specified.
Describes the user assigned to the specific file transfer protocol-enabled server, as\n identified by its ServerId property.
The response from this call returns the properties of the user associated with the\n ServerId value that was specified.
Describes the specified workflow.
" + "smithy.api#documentation": "Describes the specified workflow.
", + "smithy.api#readonly": {} } }, "com.amazonaws.transfer#DescribeWorkflowRequest": { @@ -2978,7 +2969,7 @@ } }, "LoggingRole": { - "target": "com.amazonaws.transfer#Role", + "target": "com.amazonaws.transfer#NullableRole", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in\n your CloudWatch logs.
" } @@ -3042,6 +3033,12 @@ "traits": { "smithy.api#documentation": "Specifies the log groups to which your server logs are sent.
\nTo 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:
\n\n arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*\n
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*\n
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\n value for this parameter in an update-server call. For example:
\n update-server --server-id s-1234567890abcdef0 --structured-log-destinations\n
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
\nBy default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry\n Type to FILE if you want a mapping to have a file target.
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\n set Type to FILE if you want a mapping to have a file\n target.
Returns a list of host keys for the server that's specified by the ServerId\n parameter.
Returns a list of host keys for the server that's specified by the ServerId\n parameter.
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
\nBy default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry\n Type to FILE if you want a mapping to have a file target.
The Amazon S3 storage options that are configured for your server.
" + } + }, "com.amazonaws.transfer#S3Tag": { "type": "structure", "members": { @@ -6379,13 +6445,13 @@ "UserSecretId": { "target": "com.amazonaws.transfer#SecretId", "traits": { - "smithy.api#documentation": "The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
" + "smithy.api#documentation": "The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.
" } }, "TrustedHostKeys": { "target": "com.amazonaws.transfer#SftpConnectorTrustedHostKeyList", "traits": { - "smithy.api#documentation": "The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are , and an optional
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the ssh-rsa.
For ECDSA keys, the ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or\n ecdsa-sha2-nistp521, depending on the size of the key you generated.
The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.\n You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.
The three standard SSH public key format elements are <key type>,\n <body base64>, and an optional <comment>, with spaces\n between each element. Specify only the <key type> and <body\n base64>: do not enter the <comment> portion of the key.
For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
\nFor RSA keys, the <key type> string is ssh-rsa.
For ECDSA keys, the <key type> string is either\n ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or\n ecdsa-sha2-nistp521, depending on the size of the key you generated.
Specifies the log groups to which your server logs are sent.
\nTo 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:
\n\n arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*\n
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*\n
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\n value for this parameter in an update-server call. For example:
\n update-server --server-id s-1234567890abcdef0 --structured-log-destinations\n
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
\nBy default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry\n Type to FILE if you want a mapping to have a file target.