diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.json b/codegen/sdk-codegen/aws-models/auto-scaling.json index 273f7da8208..1486e91c8d0 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.json @@ -3571,6 +3571,12 @@ "smithy.api#documentation": "

The unit of the metric. For a complete list of the units that CloudWatch supports, see the\n MetricDatum\n data type in the Amazon CloudWatch API Reference.

" } }, + "Period": { + "target": "com.amazonaws.autoscaling#MetricGranularityInSeconds", + "traits": { + "smithy.api#documentation": "

\n The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see\n Create a target tracking policy using high-resolution metrics for faster response.\n

" + } + }, "Metrics": { "target": "com.amazonaws.autoscaling#TargetTrackingMetricDataQueries", "traits": { @@ -8151,6 +8157,14 @@ "target": "com.amazonaws.autoscaling#MetricDimension" } }, + "com.amazonaws.autoscaling#MetricGranularityInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.autoscaling#MetricGranularityType": { "type": "structure", "members": { @@ -10859,6 +10873,12 @@ "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.

" } }, + "Period": { + "target": "com.amazonaws.autoscaling#MetricGranularityInSeconds", + "traits": { + "smithy.api#documentation": "

\n The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see\n Create a target tracking policy using high-resolution metrics for faster response.\n

" + } + }, "ReturnData": { "target": "com.amazonaws.autoscaling#ReturnData", "traits": { @@ -10894,6 +10914,12 @@ "traits": { "smithy.api#documentation": "

The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum\n data type in the Amazon CloudWatch API Reference.

" } + }, + "Period": { + "target": "com.amazonaws.autoscaling#MetricGranularityInSeconds", + "traits": { + "smithy.api#documentation": "

\n The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see\n Create a target tracking policy using high-resolution metrics for faster response.\n

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/bcm-pricing-calculator.json b/codegen/sdk-codegen/aws-models/bcm-pricing-calculator.json new file mode 100644 index 00000000000..459da874ef5 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/bcm-pricing-calculator.json @@ -0,0 +1,7093 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bcmpricingcalculator#AWSBCMPricingCalculator": { + "type": "service", + "version": "2024-06-19", + "operations": [ + { + "target": "com.amazonaws.bcmpricingcalculator#GetPreferences" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ListTagsForResource" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#TagResource" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#UntagResource" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#UpdatePreferences" + } + ], + "resources": [ + { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimate" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BillScenario" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimate" + } + ], + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#AccessDeniedException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#InternalServerException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ValidationException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "BCM Pricing Calculator", + "arnNamespace": "bcm-pricing-calculator" + }, + "aws.api#tagEnabled": {}, + "aws.auth#sigv4": { + "name": "bcm-pricing-calculator" + }, + "aws.endpoints#dualStackOnlyEndpoints": {}, + "aws.endpoints#standardPartitionalEndpoints": { + "endpointPatternType": "service_region_dnsSuffix" + }, + "aws.iam#defineConditionKeys": { + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tags that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tags associated with the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by the tag keys that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "

\n You can use the Pricing Calculator API to programmatically create estimates for your planned cloud use. You can model usage and commitments such as Savings Plans and \n Reserved Instances, and generate estimated costs using your discounts and benefit sharing preferences.\n

\n

The Pricing Calculator API provides the following endpoint:

\n ", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#title": "AWS Billing and Cost Management Pricing Calculator", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "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" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the 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": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://bcm-pricing-calculator-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://bcm-pricing-calculator.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For custom endpoint with region not set and fips disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bcm-pricing-calculator-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bcm-pricing-calculator.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://bcm-pricing-calculator-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://bcm-pricing-calculator.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://bcm-pricing-calculator-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://bcm-pricing-calculator.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://bcm-pricing-calculator-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://bcm-pricing-calculator.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://bcm-pricing-calculator-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://bcm-pricing-calculator.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "url": "https://bcm-pricing-calculator-fips.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "url": "https://bcm-pricing-calculator.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://bcm-pricing-calculator-fips.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://bcm-pricing-calculator.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.bcmpricingcalculator#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessDeniedCode", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

\n You do not have sufficient access to perform this action.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bcmpricingcalculator#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.bcmpricingcalculator#AddReservedInstanceAction": { + "type": "structure", + "members": { + "reservedInstancesOfferingId": { + "target": "com.amazonaws.bcmpricingcalculator#Uuid", + "traits": { + "smithy.api#documentation": "

\n The ID of the Reserved Instance offering to add. For more information, see \n \n DescribeReservedInstancesOfferings.\n

" + } + }, + "instanceCount": { + "target": "com.amazonaws.bcmpricingcalculator#ReservedInstanceInstanceCount", + "traits": { + "smithy.api#documentation": "

\n The number of instances to add for this Reserved Instance offering.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an action to add a Reserved Instance to a bill scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#AddSavingsPlanAction": { + "type": "structure", + "members": { + "savingsPlanOfferingId": { + "target": "com.amazonaws.bcmpricingcalculator#Uuid", + "traits": { + "smithy.api#documentation": "

\n The ID of the Savings Plan offering to add. For more information, see \n \n DescribeSavingsPlansOfferings.\n

" + } + }, + "commitment": { + "target": "com.amazonaws.bcmpricingcalculator#SavingsPlanCommitment", + "traits": { + "smithy.api#documentation": "

\n The hourly commitment, in the same currency of the savingsPlanOfferingId. \n This is a value between 0.001 and 1 million. You cannot specify more than five digits\n after the decimal point.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an action to add a Savings Plan to a bill scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#Arn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.bcmpricingcalculator#AWSBCMPricingCalculator" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z0-9]*:bcm-pricing-calculator:[-a-z0-9]*:[0-9]{12}:[-a-z0-9/:_]+$" + } + }, + "com.amazonaws.bcmpricingcalculator#AvailabilityZone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9\\.\\-_:,]*$" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModification": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ConflictException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "CreateBillScenarioCommitmentModification", + "documentation": "Grants permission to create new commitments or remove existing commitment from a specified bill scenario" + }, + "smithy.api#documentation": "

\n Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationEntry": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bcmpricingcalculator#Key", + "traits": { + "smithy.api#documentation": "

\n A unique identifier for this entry in the batch operation. This can be any valid string. \n This key is useful to identify errors associated with any commitment entry as any error is \n returned with this key.\n

", + "smithy.api#required": {} + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n An optional group identifier for the commitment modification.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID to which this commitment will be applied to.\n

", + "smithy.api#required": {} + } + }, + "commitmentAction": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationAction", + "traits": { + "smithy.api#documentation": "

\n The specific commitment action to be taken (e.g., adding a Reserved Instance or Savings Plan).\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an entry object in the batch operation to create bill scenario commitment modifications.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationError": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bcmpricingcalculator#Key", + "traits": { + "smithy.api#documentation": "

\n The key of the entry that caused the error.\n

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n A descriptive message for the error that occurred.\n

" + } + }, + "errorCode": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationErrorCode", + "traits": { + "smithy.api#documentation": "

\n The error code associated with the failed operation.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an error that occurred during a batch create operation for bill scenario commitment modifications.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationErrorCode": { + "type": "enum", + "members": { + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + }, + "INVALID_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ACCOUNT" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationError" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationItem": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bcmpricingcalculator#Key", + "traits": { + "smithy.api#documentation": "

\n The key of the successfully created entry. This can be any valid string. This key is useful to \n identify errors associated with any commitment entry as any error is returned with this key.\n

" + } + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier assigned to the created commitment modification.\n

" + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The group identifier for the created commitment modification.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with the created commitment modification.\n

" + } + }, + "commitmentAction": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationAction", + "traits": { + "smithy.api#documentation": "

\n The specific commitment action that was taken.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a successfully created item in a batch operation for bill scenario commitment modifications.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationItem" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationRequest": { + "type": "structure", + "members": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Bill Scenario for which you want to create the modeled commitment.\n

", + "smithy.api#required": {} + } + }, + "commitmentModifications": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationEntries", + "traits": { + "smithy.api#documentation": "

\n List of commitments that you want to model in the Bill Scenario.\n

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bcmpricingcalculator#ClientToken", + "traits": { + "smithy.api#documentation": "

\n A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {}, + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationItems", + "traits": { + "smithy.api#documentation": "

\n Returns the list of successful commitment line items that were created for the Bill Scenario.\n

" + } + }, + "errors": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModificationErrors", + "traits": { + "smithy.api#documentation": "

\n Returns the list of errors reason and the commitment item keys that cannot be created in the Bill Scenario.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModification": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ConflictException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "CreateBillScenarioUsageModification", + "documentation": "Grants permission to create usage in the specified bill scenario" + }, + "smithy.api#documentation": "

\n Create Amazon Web Services service usage that you want to model in a Bill Scenario.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationEntry": { + "type": "structure", + "members": { + "serviceCode": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCode", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services service code for this usage modification.\n This identifies the specific Amazon Web Services service to the customer as \n a unique short abbreviation. For example, AmazonEC2 \n and AWSKMS.\n

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.bcmpricingcalculator#UsageType", + "traits": { + "smithy.api#documentation": "

\n Describes the usage details of the usage line item.\n

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.bcmpricingcalculator#Operation", + "traits": { + "smithy.api#documentation": "

\n The specific operation associated with this usage modification.\n Describes the specific Amazon Web Services operation that this usage line models. \n For example, RunInstances indicates the operation of an Amazon EC2 instance.\n

", + "smithy.api#required": {} + } + }, + "availabilityZone": { + "target": "com.amazonaws.bcmpricingcalculator#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

\n The Availability Zone that this usage line uses.\n

" + } + }, + "key": { + "target": "com.amazonaws.bcmpricingcalculator#Key", + "traits": { + "smithy.api#documentation": "

\n A unique identifier for this entry in the batch operation.\n This can be any valid string. This key is useful to identify errors \n associated with any usage entry as any error is returned with this key.\n

", + "smithy.api#required": {} + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n An optional group identifier for the usage modification.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID to which this usage will be applied to.\n

", + "smithy.api#required": {} + } + }, + "amounts": { + "target": "com.amazonaws.bcmpricingcalculator#UsageAmounts", + "traits": { + "smithy.api#documentation": "

\n The amount of usage you want to create for the service use you are modeling.\n

" + } + }, + "historicalUsage": { + "target": "com.amazonaws.bcmpricingcalculator#HistoricalUsageEntity", + "traits": { + "smithy.api#documentation": "

\n Historical usage data associated with this modification, if available.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an entry in a batch operation to create bill scenario usage modifications.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationError": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bcmpricingcalculator#Key", + "traits": { + "smithy.api#documentation": "

\n The key of the entry that caused the error.\n

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n A descriptive message for the error that occurred.\n

" + } + }, + "errorCode": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationErrorCode", + "traits": { + "smithy.api#documentation": "

\n The error code associated with the failed operation.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an error that occurred during a batch create operation for bill scenario usage modifications.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationErrorCode": { + "type": "enum", + "members": { + "BAD_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_REQUEST" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + }, + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationError" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationItem": { + "type": "structure", + "members": { + "serviceCode": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCode", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services service code for this usage modification.\n

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.bcmpricingcalculator#UsageType", + "traits": { + "smithy.api#documentation": "

\n The type of usage that was modified.\n

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.bcmpricingcalculator#Operation", + "traits": { + "smithy.api#documentation": "

\n The specific operation associated with this usage modification.\n

", + "smithy.api#required": {} + } + }, + "location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The location associated with this usage modification.\n

" + } + }, + "availabilityZone": { + "target": "com.amazonaws.bcmpricingcalculator#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

\n The availability zone associated with this usage modification, if applicable.\n

" + } + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier assigned to the created usage modification.\n

" + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The group identifier for the created usage modification.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with the created usage modification.\n

" + } + }, + "quantities": { + "target": "com.amazonaws.bcmpricingcalculator#UsageQuantities", + "traits": { + "smithy.api#documentation": "

\n The modified usage quantities.\n

" + } + }, + "historicalUsage": { + "target": "com.amazonaws.bcmpricingcalculator#HistoricalUsageEntity", + "traits": { + "smithy.api#documentation": "

\n Historical usage data associated with this modification, if available.\n

" + } + }, + "key": { + "target": "com.amazonaws.bcmpricingcalculator#Key", + "traits": { + "smithy.api#documentation": "

\n The key of the successfully created entry.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a successfully created item in a batch operation for bill scenario usage modifications.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationItem" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationRequest": { + "type": "structure", + "members": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Bill Scenario for which you want to create the modeled usage.\n

", + "smithy.api#required": {} + } + }, + "usageModifications": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationEntries", + "traits": { + "smithy.api#documentation": "

\n List of usage that you want to model in the Bill Scenario.\n

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bcmpricingcalculator#ClientToken", + "traits": { + "smithy.api#documentation": "

\n A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {}, + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationItems", + "traits": { + "smithy.api#documentation": "

\n Returns the list of successful usage line items that were created for the Bill Scenario.\n

" + } + }, + "errors": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModificationErrors", + "traits": { + "smithy.api#documentation": "

\n Returns the list of errors reason and the usage item keys that cannot be created in the Bill Scenario.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ConflictException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "CreateWorkloadEstimateUsage", + "documentation": "Grants permission to create usage in the specified workload estimate" + }, + "smithy.api#documentation": "

\n Create Amazon Web Services service usage that you want to model in a Workload Estimate.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageCode": { + "type": "enum", + "members": { + "BAD_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_REQUEST" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + }, + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageEntry": { + "type": "structure", + "members": { + "serviceCode": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCode", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services service code for this usage estimate.\n

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.bcmpricingcalculator#UsageType", + "traits": { + "smithy.api#documentation": "

\n The type of usage being estimated.\n

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.bcmpricingcalculator#Operation", + "traits": { + "smithy.api#documentation": "

\n The specific operation associated with this usage estimate.\n

", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.bcmpricingcalculator#Key", + "traits": { + "smithy.api#documentation": "

\n A unique identifier for this entry in the batch operation.\n

", + "smithy.api#required": {} + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n An optional group identifier for the usage estimate.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with this usage estimate.\n

", + "smithy.api#required": {} + } + }, + "amount": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The estimated usage amount.\n

", + "smithy.api#required": {} + } + }, + "historicalUsage": { + "target": "com.amazonaws.bcmpricingcalculator#HistoricalUsageEntity", + "traits": { + "smithy.api#documentation": "

\n Historical usage data associated with this estimate, if available.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an entry in a batch operation to create workload estimate usage.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageError": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bcmpricingcalculator#Key", + "traits": { + "smithy.api#documentation": "

\n The key of the entry that caused the error.\n

" + } + }, + "errorCode": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageCode", + "traits": { + "smithy.api#documentation": "

\n The error code associated with the failed operation.\n

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n A descriptive message for the error that occurred.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an error that occurred during a batch create operation for workload estimate usage.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageError" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageItem": { + "type": "structure", + "members": { + "serviceCode": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCode", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services service code for this usage estimate.\n

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.bcmpricingcalculator#UsageType", + "traits": { + "smithy.api#documentation": "

\n The type of usage that was estimated.\n

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.bcmpricingcalculator#Operation", + "traits": { + "smithy.api#documentation": "

\n The specific operation associated with this usage estimate.\n

", + "smithy.api#required": {} + } + }, + "location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The location associated with this usage estimate.\n

" + } + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier assigned to the created usage estimate.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with the created usage estimate.\n

" + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The group identifier for the created usage estimate.\n

" + } + }, + "quantity": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsageQuantity", + "traits": { + "smithy.api#documentation": "

\n The estimated usage quantity.\n

" + } + }, + "cost": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The estimated cost associated with this usage.\n

" + } + }, + "currency": { + "target": "com.amazonaws.bcmpricingcalculator#CurrencyCode", + "traits": { + "smithy.api#documentation": "

\n The currency of the estimated cost.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateCostStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the created usage estimate.\n

" + } + }, + "historicalUsage": { + "target": "com.amazonaws.bcmpricingcalculator#HistoricalUsageEntity", + "traits": { + "smithy.api#documentation": "

\n Historical usage data associated with this estimate, if available.\n

" + } + }, + "key": { + "target": "com.amazonaws.bcmpricingcalculator#Key", + "traits": { + "smithy.api#documentation": "

\n The key of the successfully created entry.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a successfully created item in a batch operation for workload estimate usage.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageItem" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageRequest": { + "type": "structure", + "members": { + "workloadEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Workload estimate for which you want to create the modeled usage.\n

", + "smithy.api#required": {} + } + }, + "usage": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageEntries", + "traits": { + "smithy.api#documentation": "

\n List of usage that you want to model in the Workload estimate.\n

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bcmpricingcalculator#ClientToken", + "traits": { + "smithy.api#documentation": "

\n A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {}, + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageItems", + "traits": { + "smithy.api#documentation": "

\n Returns the list of successful usage line items that were created for the Workload estimate.\n

" + } + }, + "errors": { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsageErrors", + "traits": { + "smithy.api#documentation": "

\n Returns the list of errors reason and the usage item keys that cannot be created in the Workload estimate.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModification": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "DeleteBillScenarioCommitmentModification", + "documentation": "Grants permission to delete newly added commitments from the specified bill scenario" + }, + "smithy.api#documentation": "

\n Delete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had \n added and cannot model deletion (or removal) of a existing commitment. If you want model deletion of an existing \n commitment, see the negate \n BillScenarioCommitmentModificationAction of \n \n BatchCreateBillScenarioCommitmentModification operation.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationError": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the error.\n

" + } + }, + "errorCode": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationErrorCode", + "traits": { + "smithy.api#documentation": "

\n The code associated with the error.\n

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The message that describes the error.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an error that occurred when deleting a commitment in a Bill Scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationErrorCode": { + "type": "enum", + "members": { + "BAD_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_REQUEST" + } + }, + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationError" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationRequest": { + "type": "structure", + "members": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Bill Scenario for which you want to delete the modeled commitment.\n

", + "smithy.api#required": {} + } + }, + "ids": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationEntries", + "traits": { + "smithy.api#documentation": "

\n List of commitments that you want to delete from the Bill Scenario.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModificationErrors", + "traits": { + "smithy.api#documentation": "

\n Returns the list of errors reason and the commitment item keys that cannot be deleted from the Bill Scenario.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModification": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "DeleteBillScenarioUsageModification", + "documentation": "Grants permission to delete newly added usage from the specified bill scenario" + }, + "smithy.api#documentation": "

\n Delete usage that you have created in a Bill Scenario. You can only delete usage that you had added and cannot model \n deletion (or removal) of a existing usage. If you want model removal of an existing usage, see \n \n BatchUpdateBillScenarioUsageModification.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationError": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the error.\n

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The message that describes the error.\n

" + } + }, + "errorCode": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationErrorCode", + "traits": { + "smithy.api#documentation": "

\n The code associated with the error.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an error that occurred when deleting usage in a Bill Scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationErrorCode": { + "type": "enum", + "members": { + "BAD_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_REQUEST" + } + }, + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationError" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationRequest": { + "type": "structure", + "members": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Bill Scenario for which you want to delete the modeled usage.\n

", + "smithy.api#required": {} + } + }, + "ids": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationEntries", + "traits": { + "smithy.api#documentation": "

\n List of usage that you want to delete from the Bill Scenario.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModificationErrors", + "traits": { + "smithy.api#documentation": "

\n Returns the list of errors reason and the usage item keys that cannot be deleted from the Bill Scenario.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "DeleteWorkloadEstimateUsage", + "documentation": "Grants permission to delete newly added usage from the specified workload estimate" + }, + "smithy.api#documentation": "

\n Delete usage that you have created in a Workload estimate. You can only delete usage that you had added and cannot model deletion \n (or removal) of a existing usage. If you want model removal of an existing usage, see \n \n BatchUpdateWorkloadEstimateUsage.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageError": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the error.\n

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The message that describes the error.\n

" + } + }, + "errorCode": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUpdateUsageErrorCode", + "traits": { + "smithy.api#documentation": "

\n The code associated with the error.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an error that occurred when deleting usage in a workload estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageError" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageRequest": { + "type": "structure", + "members": { + "workloadEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Workload estimate for which you want to delete the modeled usage.\n

", + "smithy.api#required": {} + } + }, + "ids": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageEntries", + "traits": { + "smithy.api#documentation": "

\n List of usage that you want to delete from the Workload estimate.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsageErrors", + "traits": { + "smithy.api#documentation": "

\n Returns the list of errors reason and the usage item keys that cannot be deleted from the Workload estimate.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModification": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "UpdateBillScenarioCommitmentModification", + "documentation": "Grants permission to update commitment group of commitments in the specified bill scenario" + }, + "smithy.api#documentation": "

\n Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationEntry": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the commitment modification to update.\n

", + "smithy.api#required": {} + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The updated group identifier for the commitment modification.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an entry in a batch operation to update bill scenario commitment modifications.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationError": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the error.\n

" + } + }, + "errorCode": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationErrorCode", + "traits": { + "smithy.api#documentation": "

\n The code associated with the error.\n

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The message that describes the error.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an error that occurred when updating a commitment in a Bill Scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationErrorCode": { + "type": "enum", + "members": { + "BAD_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_REQUEST" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + }, + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationError" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationRequest": { + "type": "structure", + "members": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Bill Scenario for which you want to modify the commitment group of a modeled commitment.\n

", + "smithy.api#required": {} + } + }, + "commitmentModifications": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationEntries", + "traits": { + "smithy.api#documentation": "

\n List of commitments that you want to update in a Bill Scenario.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationItems", + "traits": { + "smithy.api#documentation": "

\n Returns the list of successful commitment line items that were updated for a Bill Scenario.\n

" + } + }, + "errors": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModificationErrors", + "traits": { + "smithy.api#documentation": "

\n Returns the list of error reasons and commitment line item IDs that could not be updated for the Bill Scenario.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModification": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "UpdateBillScenarioUsageModification", + "documentation": "Grants permission to update usage amount, usage hour, and usage group in the specified bill scenario" + }, + "smithy.api#documentation": "

\n Update a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group based on a usage ID and a Bill scenario ID.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationEntry": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the usage modification to update.\n

", + "smithy.api#required": {} + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The updated group identifier for the usage modification.\n

" + } + }, + "amounts": { + "target": "com.amazonaws.bcmpricingcalculator#UsageAmounts", + "traits": { + "smithy.api#documentation": "

\n The updated usage amounts for the modification.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an entry in a batch operation to update bill scenario usage modifications.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationError": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the error.\n

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The message that describes the error.\n

" + } + }, + "errorCode": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationErrorCode", + "traits": { + "smithy.api#documentation": "

\n The code associated with the error.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an error that occurred when updating usage in a Bill Scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationErrorCode": { + "type": "enum", + "members": { + "BAD_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_REQUEST" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + }, + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationError" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationRequest": { + "type": "structure", + "members": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Bill Scenario for which you want to modify the usage lines.\n

", + "smithy.api#required": {} + } + }, + "usageModifications": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationEntries", + "traits": { + "smithy.api#documentation": "

\n List of usage lines that you want to update in a Bill Scenario identified by the usage ID.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioUsageModificationItems", + "traits": { + "smithy.api#documentation": "

\n Returns the list of successful usage line items that were updated for a Bill Scenario.\n

" + } + }, + "errors": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModificationErrors", + "traits": { + "smithy.api#documentation": "

\n Returns the list of error reasons and usage line item IDs that could not be updated for the Bill Scenario.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "UpdateWorkloadEstimateUsage", + "documentation": "Grants permission to update usage amount and usage group in the specified workload estimate based on the usage id" + }, + "smithy.api#documentation": "

\n Update a newly added or existing usage lines. You can update the usage amounts and usage group based on a usage ID and a Workload estimate ID.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageEntry": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the usage estimate to update.\n

", + "smithy.api#required": {} + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The updated group identifier for the usage estimate.\n

" + } + }, + "amount": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The updated estimated usage amount.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an entry in a batch operation to update workload estimate usage.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageError": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the error.\n

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The message that describes the error.\n

" + } + }, + "errorCode": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUpdateUsageErrorCode", + "traits": { + "smithy.api#documentation": "

\n The code associated with the error.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an error that occurred when updating usage in a workload estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageError" + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageRequest": { + "type": "structure", + "members": { + "workloadEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Workload estimate for which you want to modify the usage lines.\n

", + "smithy.api#required": {} + } + }, + "usage": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageEntries", + "traits": { + "smithy.api#documentation": "

\n List of usage line amounts and usage group that you want to update in a Workload estimate identified by the usage ID.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsageItems", + "traits": { + "smithy.api#documentation": "

\n Returns the list of successful usage line items that were updated for a Workload estimate.\n

" + } + }, + "errors": { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsageErrors", + "traits": { + "smithy.api#documentation": "

\n Returns the list of error reasons and usage line item IDs that could not be updated for the Workload estimate.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimate": { + "type": "resource", + "identifiers": { + "billEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "properties": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateName" + }, + "costSummary": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateCostSummary" + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateStatus" + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval" + }, + "failureMessage": { + "target": "smithy.api#String" + }, + "createdAt": { + "target": "smithy.api#Timestamp" + }, + "expiresAt": { + "target": "smithy.api#Timestamp" + } + }, + "create": { + "target": "com.amazonaws.bcmpricingcalculator#CreateBillEstimate" + }, + "read": { + "target": "com.amazonaws.bcmpricingcalculator#GetBillEstimate" + }, + "update": { + "target": "com.amazonaws.bcmpricingcalculator#UpdateBillEstimate" + }, + "delete": { + "target": "com.amazonaws.bcmpricingcalculator#DeleteBillEstimate" + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimates" + }, + "resources": [ + { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateCommitment" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateInputCommitmentModification" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateInputUsageModification" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateLineItem" + } + ], + "traits": { + "aws.api#arn": { + "template": "bill-estimate/{billEstimateId}" + }, + "aws.api#taggable": {}, + "aws.iam#iamResource": { + "name": "bill-estimate" + }, + "smithy.api#documentation": "Represents a bill estimate that is created from a bill scenario" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateCommitment": { + "type": "resource", + "identifiers": { + "billEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "resultCommitmentId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateCommitments" + }, + "traits": { + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateCommitmentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateCommitmentSummary" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateCommitmentSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the commitment.\n

" + } + }, + "purchaseAgreementType": { + "target": "com.amazonaws.bcmpricingcalculator#PurchaseAgreementType", + "traits": { + "smithy.api#documentation": "

\n The type of purchase agreement (e.g., Reserved Instance, Savings Plan).\n

" + } + }, + "offeringId": { + "target": "com.amazonaws.bcmpricingcalculator#Uuid", + "traits": { + "smithy.api#documentation": "

\n The identifier of the specific offering associated with this commitment.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with this commitment.\n

" + } + }, + "region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services region associated with this commitment.\n

" + } + }, + "termLength": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The length of the commitment term.\n

" + } + }, + "paymentOption": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The payment option chosen for this commitment (e.g., All Upfront, Partial Upfront, No Upfront).\n

" + } + }, + "upfrontPayment": { + "target": "com.amazonaws.bcmpricingcalculator#CostAmount", + "traits": { + "smithy.api#documentation": "

\n The upfront payment amount for this commitment, if applicable.\n

" + } + }, + "monthlyPayment": { + "target": "com.amazonaws.bcmpricingcalculator#CostAmount", + "traits": { + "smithy.api#documentation": "

\n The monthly payment amount for this commitment, if applicable.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides a summary of commitment-related information for a bill estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateCostSummary": { + "type": "structure", + "members": { + "totalCostDifference": { + "target": "com.amazonaws.bcmpricingcalculator#CostDifference", + "traits": { + "smithy.api#documentation": "

\n The total difference in cost between the estimated and historical costs.\n

" + } + }, + "serviceCostDifferences": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCostDifferenceMap", + "traits": { + "smithy.api#documentation": "

\n A breakdown of cost differences by Amazon Web Services service.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides a summary of cost-related information for a bill estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateInputCommitmentModification": { + "type": "resource", + "identifiers": { + "billEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputCommitmentModifications" + }, + "traits": { + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateInputCommitmentModificationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateInputCommitmentModificationSummary" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateInputCommitmentModificationSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the commitment modification.\n

" + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The group identifier for the commitment modification.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with this commitment modification.\n

" + } + }, + "commitmentAction": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationAction", + "traits": { + "smithy.api#documentation": "

\n The specific commitment action taken in this modification.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Summarizes an input commitment modification for a bill estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateInputUsageModification": { + "type": "resource", + "identifiers": { + "billEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputUsageModifications" + }, + "traits": { + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateInputUsageModificationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateInputUsageModificationSummary" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateInputUsageModificationSummary": { + "type": "structure", + "members": { + "serviceCode": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCode", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services service code for this usage modification.\n

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.bcmpricingcalculator#UsageType", + "traits": { + "smithy.api#documentation": "

\n The type of usage being modified.\n

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.bcmpricingcalculator#Operation", + "traits": { + "smithy.api#documentation": "

\n The specific operation associated with this usage modification.\n

", + "smithy.api#required": {} + } + }, + "location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The location associated with this usage modification.\n

" + } + }, + "availabilityZone": { + "target": "com.amazonaws.bcmpricingcalculator#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

\n The availability zone associated with this usage modification, if applicable.\n

" + } + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the usage modification.\n

" + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The group identifier for the usage modification.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with this usage modification.\n

" + } + }, + "quantities": { + "target": "com.amazonaws.bcmpricingcalculator#UsageQuantities", + "traits": { + "smithy.api#documentation": "

\n The modified usage quantities.\n

" + } + }, + "historicalUsage": { + "target": "com.amazonaws.bcmpricingcalculator#HistoricalUsageEntity", + "traits": { + "smithy.api#documentation": "

\n Historical usage data associated with this modification, if available.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Summarizes an input usage modification for a bill estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateLineItem": { + "type": "resource", + "identifiers": { + "billEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItems" + }, + "traits": { + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateLineItemSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateLineItemSummary" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateLineItemSummary": { + "type": "structure", + "members": { + "serviceCode": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCode", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services service code associated with this line item.\n

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.bcmpricingcalculator#UsageType", + "traits": { + "smithy.api#documentation": "

\n The type of usage for this line item.\n

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.bcmpricingcalculator#Operation", + "traits": { + "smithy.api#documentation": "

\n The specific operation associated with this line item.\n

", + "smithy.api#required": {} + } + }, + "location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The location associated with this line item.\n

" + } + }, + "availabilityZone": { + "target": "com.amazonaws.bcmpricingcalculator#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

\n The availability zone associated with this line item, if applicable.\n

" + } + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of this line item.\n

" + } + }, + "lineItemId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The line item identifier from the original bill.\n

" + } + }, + "lineItemType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The type of this line item (e.g., Usage, Tax, Credit).\n

" + } + }, + "payerAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID of the payer for this line item.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with the usage for this line item.\n

" + } + }, + "estimatedUsageQuantity": { + "target": "com.amazonaws.bcmpricingcalculator#UsageQuantityResult", + "traits": { + "smithy.api#documentation": "

\n The estimated usage quantity for this line item.\n

" + } + }, + "estimatedCost": { + "target": "com.amazonaws.bcmpricingcalculator#CostAmount", + "traits": { + "smithy.api#documentation": "

\n The estimated cost for this line item.\n

" + } + }, + "historicalUsageQuantity": { + "target": "com.amazonaws.bcmpricingcalculator#UsageQuantityResult", + "traits": { + "smithy.api#documentation": "

\n The historical usage quantity for this line item.\n

" + } + }, + "historicalCost": { + "target": "com.amazonaws.bcmpricingcalculator#CostAmount", + "traits": { + "smithy.api#documentation": "

\n The historical cost for this line item.\n

" + } + }, + "savingsPlanArns": { + "target": "com.amazonaws.bcmpricingcalculator#SavingsPlanArns", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Names (ARNs) of any Savings Plans applied to this line item.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides a summary of a line item in a bill estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateSummary" + } + }, + "com.amazonaws.bcmpricingcalculator#BillEstimateSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill estimate.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateName", + "traits": { + "smithy.api#documentation": "

\n The name of the bill estimate.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the bill estimate.\n

" + } + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval", + "traits": { + "smithy.api#documentation": "

\n The time period covered by the bill estimate.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill estimate was created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill estimate will expire.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides a summary of a bill estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillInterval": { + "type": "structure", + "members": { + "start": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The start date and time of the interval.\n

" + } + }, + "end": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The end date and time of the interval.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a time interval for a bill or estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenario": { + "type": "resource", + "identifiers": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "properties": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioName" + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval" + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioStatus" + }, + "createdAt": { + "target": "smithy.api#Timestamp" + }, + "expiresAt": { + "target": "smithy.api#Timestamp" + }, + "failureMessage": { + "target": "smithy.api#String" + } + }, + "create": { + "target": "com.amazonaws.bcmpricingcalculator#CreateBillScenario" + }, + "read": { + "target": "com.amazonaws.bcmpricingcalculator#GetBillScenario" + }, + "update": { + "target": "com.amazonaws.bcmpricingcalculator#UpdateBillScenario" + }, + "delete": { + "target": "com.amazonaws.bcmpricingcalculator#DeleteBillScenario" + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenarios" + }, + "resources": [ + { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModification" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioUsageModification" + } + ], + "traits": { + "aws.api#arn": { + "template": "bill-scenario/{billScenarioId}" + }, + "aws.api#taggable": {}, + "aws.iam#iamResource": { + "name": "bill-scenario" + }, + "smithy.api#documentation": "Represents a bill scenario that allows usage and commitment modeling" + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModification": { + "type": "resource", + "identifiers": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenarioCommitmentModifications" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioCommitmentModification" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioCommitmentModification" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioCommitmentModification" + } + ], + "traits": { + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationAction": { + "type": "union", + "members": { + "addReservedInstanceAction": { + "target": "com.amazonaws.bcmpricingcalculator#AddReservedInstanceAction", + "traits": { + "smithy.api#documentation": "

\n Action to add a Reserved Instance to the scenario.\n

" + } + }, + "addSavingsPlanAction": { + "target": "com.amazonaws.bcmpricingcalculator#AddSavingsPlanAction", + "traits": { + "smithy.api#documentation": "

\n Action to add a Savings Plan to the scenario.\n

" + } + }, + "negateReservedInstanceAction": { + "target": "com.amazonaws.bcmpricingcalculator#NegateReservedInstanceAction", + "traits": { + "smithy.api#documentation": "

\n Action to remove a Reserved Instance from the scenario.\n

" + } + }, + "negateSavingsPlanAction": { + "target": "com.amazonaws.bcmpricingcalculator#NegateSavingsPlanAction", + "traits": { + "smithy.api#documentation": "

\n Action to remove a Savings Plan from the scenario.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an action to modify commitments in a bill scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationItem": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the commitment modification.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with this commitment modification.\n

" + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The group identifier for the commitment modification.\n

" + } + }, + "commitmentAction": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationAction", + "traits": { + "smithy.api#documentation": "

\n The specific commitment action taken in this modification.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a commitment modification item in a bill scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationItem" + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "LOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCKED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioSummary" + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill scenario.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billScenarioId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioName", + "traits": { + "smithy.api#documentation": "

\n The name of the bill scenario.\n

" + } + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval", + "traits": { + "smithy.api#documentation": "

\n The time period covered by the bill scenario.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the bill scenario.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill scenario was created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill scenario will expire.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the bill scenario creation or processing failed.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides a summary of a bill scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioUsageModification": { + "type": "resource", + "identifiers": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenarioUsageModifications" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateBillScenarioUsageModification" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteBillScenarioUsageModification" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateBillScenarioUsageModification" + } + ], + "traits": { + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioUsageModificationItem": { + "type": "structure", + "members": { + "serviceCode": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCode", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services service code for this usage modification.\n

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.bcmpricingcalculator#UsageType", + "traits": { + "smithy.api#documentation": "

\n The type of usage being modified.\n

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.bcmpricingcalculator#Operation", + "traits": { + "smithy.api#documentation": "

\n The specific operation associated with this usage modification.\n

", + "smithy.api#required": {} + } + }, + "location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The location associated with this usage modification.\n

" + } + }, + "availabilityZone": { + "target": "com.amazonaws.bcmpricingcalculator#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

\n The availability zone associated with this usage modification, if applicable.\n

" + } + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the usage modification.\n

" + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The group identifier for the usage modification.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with this usage modification.\n

" + } + }, + "quantities": { + "target": "com.amazonaws.bcmpricingcalculator#UsageQuantities", + "traits": { + "smithy.api#documentation": "

\n The modified usage quantities.\n

" + } + }, + "historicalUsage": { + "target": "com.amazonaws.bcmpricingcalculator#HistoricalUsageEntity", + "traits": { + "smithy.api#documentation": "

\n Historical usage data associated with this modification, if available.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a usage modification item in a bill scenario.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#BillScenarioUsageModificationItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioUsageModificationItem" + } + }, + "com.amazonaws.bcmpricingcalculator#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\u0021-\\u007E]+$" + } + }, + "com.amazonaws.bcmpricingcalculator#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The identifier of the resource that was not found.\n

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The type of the resource that was not found.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConflictCode", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

\n The request could not be processed because of conflict in the current state of the resource.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bcmpricingcalculator#CostAmount": { + "type": "structure", + "members": { + "amount": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The numeric value of the cost.\n

" + } + }, + "currency": { + "target": "com.amazonaws.bcmpricingcalculator#CurrencyCode", + "traits": { + "smithy.api#documentation": "

\n The currency code for the cost amount.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a monetary amount with associated currency.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#CostDifference": { + "type": "structure", + "members": { + "historicalCost": { + "target": "com.amazonaws.bcmpricingcalculator#CostAmount", + "traits": { + "smithy.api#documentation": "

\n The historical cost amount.\n

" + } + }, + "estimatedCost": { + "target": "com.amazonaws.bcmpricingcalculator#CostAmount", + "traits": { + "smithy.api#documentation": "

\n The estimated cost amount.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents the difference between historical and estimated costs.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#CreateBillEstimate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#CreateBillEstimateRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#CreateBillEstimateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ConflictException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create a new bill estimate. Charge is incurred for successful bill estimates" + }, + "smithy.api#documentation": "

\n Create a Bill estimate from a Bill scenario. In the Bill scenario you can model usage addition, usage changes, and usage removal. You can also model commitment addition and commitment removal. After all changes in a Bill scenario is made satisfactorily, you can call this API with a Bill scenario ID to generate the Bill estimate. Bill estimate calculates the pre-tax cost for your consolidated billing family, incorporating all modeled usage and commitments alongside existing usage and commitments from your most recent completed anniversary bill, with any applicable discounts applied.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#CreateBillEstimateRequest": { + "type": "structure", + "members": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Bill Scenario for which you want to create a Bill estimate.\n

", + "smithy.api#notProperty": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateName", + "traits": { + "smithy.api#documentation": "

\n The name of the Bill estimate that will be created. Names must be unique for an account.\n

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bcmpricingcalculator#ClientToken", + "traits": { + "smithy.api#documentation": "

\n A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {}, + "smithy.api#notProperty": {} + } + }, + "tags": { + "target": "com.amazonaws.bcmpricingcalculator#Tags", + "traits": { + "smithy.api#documentation": "

\n An optional list of tags to associate with the specified BillEstimate. You can use resource tags to control access to your \n BillEstimate using IAM policies. Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:\n

\n ", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bcmpricingcalculator#BillScenario" + } + ] + } + }, + "com.amazonaws.bcmpricingcalculator#CreateBillEstimateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of your newly created Bill estimate.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateName", + "traits": { + "smithy.api#documentation": "

The name of your newly created Bill estimate.

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateStatus", + "traits": { + "smithy.api#documentation": "

The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. \n The status will allow you to identify when the Bill estimate is complete or has failed.

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This attribute provides the reason if a Bill estimate result generation fails.

" + } + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval", + "traits": { + "smithy.api#documentation": "

The bill month start and end \n timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

" + } + }, + "costSummary": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateCostSummary", + "traits": { + "smithy.api#documentation": "

Returns summary-level cost information once a Bill estimate is \n successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated \n billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing \n the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the Bill estimate create process \n was started (not when it successfully completed or failed).

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the Bill estimate will \n expire. A Bill estimate becomes inaccessible after expiration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#CreateBillScenario": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#CreateBillScenarioRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#CreateBillScenarioResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ConflictException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create a new bill scenario" + }, + "smithy.api#documentation": "

\n Creates a new bill scenario to model potential changes to Amazon Web Services usage and costs.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#CreateBillScenarioRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioName", + "traits": { + "smithy.api#documentation": "

\n A descriptive name for the bill scenario.\n

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bcmpricingcalculator#ClientToken", + "traits": { + "smithy.api#documentation": "

\n A unique, case-sensitive identifier to ensure idempotency of the request.\n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {}, + "smithy.api#notProperty": {} + } + }, + "tags": { + "target": "com.amazonaws.bcmpricingcalculator#Tags", + "traits": { + "smithy.api#documentation": "

\n The tags to apply to the bill scenario.\n

", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#CreateBillScenarioResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for the created bill scenario.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billScenarioId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioName", + "traits": { + "smithy.api#documentation": "

\n The name of the created bill scenario.\n

" + } + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval", + "traits": { + "smithy.api#documentation": "

\n The time period covered by the bill scenario.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the bill scenario.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill scenario was created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill scenario will expire.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the bill scenario creation failed.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#CreateWorkloadEstimate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#CreateWorkloadEstimateRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#CreateWorkloadEstimateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ConflictException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create a new Workload estimate" + }, + "smithy.api#documentation": "

\n Creates a new workload estimate to model costs for a specific workload.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#CreateWorkloadEstimateRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateName", + "traits": { + "smithy.api#documentation": "

\n A descriptive name for the workload estimate.\n

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bcmpricingcalculator#ClientToken", + "traits": { + "smithy.api#documentation": "

\n A unique, case-sensitive identifier to ensure idempotency of the request.\n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {}, + "smithy.api#notProperty": {} + } + }, + "rateType": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateRateType", + "traits": { + "smithy.api#documentation": "

\n The type of pricing rates to use for the estimate.\n

", + "smithy.api#notProperty": {} + } + }, + "tags": { + "target": "com.amazonaws.bcmpricingcalculator#Tags", + "traits": { + "smithy.api#documentation": "

\n The tags to apply to the workload estimate.\n

", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#CreateWorkloadEstimateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for the created workload estimate.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workloadEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateName", + "traits": { + "smithy.api#documentation": "

\n The name of the created workload estimate.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the workload estimate was created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the workload estimate will expire.\n

" + } + }, + "rateType": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateRateType", + "traits": { + "smithy.api#documentation": "

\n The type of pricing rates used for the estimate.\n

" + } + }, + "rateTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp of the pricing rates used for the estimate.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the workload estimate.\n

" + } + }, + "totalCost": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The total estimated cost for the workload.\n

" + } + }, + "costCurrency": { + "target": "com.amazonaws.bcmpricingcalculator#CurrencyCode", + "traits": { + "smithy.api#documentation": "

\n The currency of the estimated cost.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the workload estimate creation failed.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "Mixin for common fields returned by CRUD APIs", + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#CurrencyCode": { + "type": "enum", + "members": { + "USD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USD" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#DataUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The requested data is currently unavailable.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bcmpricingcalculator#DeleteBillEstimate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#DeleteBillEstimateRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#DeleteBillEstimateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete bill estimate" + }, + "smithy.api#documentation": "

\n Deletes an existing bill estimate.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#DeleteBillEstimateRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill estimate to delete.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billEstimateId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#DeleteBillEstimateResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#DeleteBillScenario": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#DeleteBillScenarioRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#DeleteBillScenarioResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a bill scenario" + }, + "smithy.api#documentation": "

\n Deletes an existing bill scenario.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#DeleteBillScenarioRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill scenario to delete.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billScenarioId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#DeleteBillScenarioResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#DeleteWorkloadEstimate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#DeleteWorkloadEstimateRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#DeleteWorkloadEstimateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete the specified workload estimate" + }, + "smithy.api#documentation": "

\n Deletes an existing workload estimate.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#DeleteWorkloadEstimateRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the workload estimate to delete.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workloadEstimateId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#DeleteWorkloadEstimateResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#Expression": { + "type": "structure", + "members": { + "and": { + "target": "com.amazonaws.bcmpricingcalculator#ExpressionList", + "traits": { + "smithy.api#documentation": "

\n A list of expressions to be combined with AND logic.\n

" + } + }, + "or": { + "target": "com.amazonaws.bcmpricingcalculator#ExpressionList", + "traits": { + "smithy.api#documentation": "

\n A list of expressions to be combined with OR logic.\n

" + } + }, + "not": { + "target": "com.amazonaws.bcmpricingcalculator#Expression", + "traits": { + "smithy.api#documentation": "

\n An expression to be negated.\n

" + } + }, + "costCategories": { + "target": "com.amazonaws.bcmpricingcalculator#ExpressionFilter", + "traits": { + "smithy.api#documentation": "

\n Filters based on cost categories.\n

" + } + }, + "dimensions": { + "target": "com.amazonaws.bcmpricingcalculator#ExpressionFilter", + "traits": { + "smithy.api#documentation": "

\n Filters based on dimensions (e.g., service, operation).\n

" + } + }, + "tags": { + "target": "com.amazonaws.bcmpricingcalculator#ExpressionFilter", + "traits": { + "smithy.api#documentation": "

\n Filters based on resource tags.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a complex filtering expression for cost and usage data.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#ExpressionFilter": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The key or attribute to filter on.\n

" + } + }, + "matchOptions": { + "target": "com.amazonaws.bcmpricingcalculator#StringList", + "traits": { + "smithy.api#documentation": "

\n The match options for the filter (e.g., equals, contains).\n

" + } + }, + "values": { + "target": "com.amazonaws.bcmpricingcalculator#StringList", + "traits": { + "smithy.api#documentation": "

\n The values to match against.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a filter used within an expression.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#ExpressionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#Expression" + } + }, + "com.amazonaws.bcmpricingcalculator#FilterTimestamp": { + "type": "structure", + "members": { + "afterTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n Include results after this timestamp.\n

" + } + }, + "beforeTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n Include results before this timestamp.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a time-based filter.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#GetBillEstimate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#GetBillEstimateRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#GetBillEstimateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve details of a bill estimate including estimated cost" + }, + "smithy.api#documentation": "

\n Retrieves details of a specific bill estimate.\n

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetBillEstimateRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill estimate to retrieve.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billEstimateId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetBillEstimateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the retrieved bill estimate.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateName", + "traits": { + "smithy.api#documentation": "

\n The name of the retrieved bill estimate.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the bill estimate.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the bill estimate retrieval failed.\n

" + } + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval", + "traits": { + "smithy.api#documentation": "

\n The time period covered by the bill estimate.\n

" + } + }, + "costSummary": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateCostSummary", + "traits": { + "smithy.api#documentation": "

\n A summary of the estimated costs.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill estimate was created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill estimate will expire.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetBillScenario": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#GetBillScenarioRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#GetBillScenarioResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve information associated with a bill scenario" + }, + "smithy.api#documentation": "

\n Retrieves details of a specific bill scenario.\n

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetBillScenarioRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill scenario to retrieve.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billScenarioId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetBillScenarioResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the retrieved bill scenario.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billScenarioId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioName", + "traits": { + "smithy.api#documentation": "

\n The name of the retrieved bill scenario.\n

" + } + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval", + "traits": { + "smithy.api#documentation": "

\n The time period covered by the bill scenario.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the bill scenario.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill scenario was created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill scenario will expire.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the bill scenario retrieval failed.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#GetPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#GetPreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve applicable rate type preferences for the account" + }, + "smithy.api#documentation": "

\n Retrieves the current preferences for the Amazon Web Services Cost Explorer service.\n

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetPreferencesRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetPreferencesResponse": { + "type": "structure", + "members": { + "managementAccountRateTypeSelections": { + "target": "com.amazonaws.bcmpricingcalculator#RateTypes", + "traits": { + "smithy.api#documentation": "

\n The preferred rate types for the management account.\n

" + } + }, + "memberAccountRateTypeSelections": { + "target": "com.amazonaws.bcmpricingcalculator#RateTypes", + "traits": { + "smithy.api#documentation": "

\n The preferred rate types for member accounts.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetWorkloadEstimate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#GetWorkloadEstimateRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#GetWorkloadEstimateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve information associated with a workload estimate" + }, + "smithy.api#documentation": "

\n Retrieves details of a specific workload estimate.\n

", + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetWorkloadEstimate", + "params": { + "identifier": "9bb1df8b-5978-4fcb-9c5c-99f5b2670076" + }, + "expect": { + "failure": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams" + } + ] + } + }, + "com.amazonaws.bcmpricingcalculator#GetWorkloadEstimateRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the workload estimate to retrieve.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workloadEstimateId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#GetWorkloadEstimateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the retrieved workload estimate.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workloadEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateName", + "traits": { + "smithy.api#documentation": "

\n The name of the retrieved workload estimate.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the workload estimate was created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the workload estimate will expire.\n

" + } + }, + "rateType": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateRateType", + "traits": { + "smithy.api#documentation": "

\n The type of pricing rates used for the estimate.\n

" + } + }, + "rateTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp of the pricing rates used for the estimate.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the workload estimate.\n

" + } + }, + "totalCost": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The total estimated cost for the workload.\n

" + } + }, + "costCurrency": { + "target": "com.amazonaws.bcmpricingcalculator#CurrencyCode", + "traits": { + "smithy.api#documentation": "

\n The currency of the estimated cost.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the workload estimate retrieval failed.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "Mixin for common fields returned by CRUD APIs", + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#HistoricalUsageEntity": { + "type": "structure", + "members": { + "serviceCode": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCode", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services service code associated with the usage.\n

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.bcmpricingcalculator#UsageType", + "traits": { + "smithy.api#documentation": "

\n The type of usage.\n

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.bcmpricingcalculator#Operation", + "traits": { + "smithy.api#documentation": "

\n The specific operation associated with the usage.\n

", + "smithy.api#required": {} + } + }, + "location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The location associated with the usage.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with the usage.\n

", + "smithy.api#required": {} + } + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval", + "traits": { + "smithy.api#documentation": "

\n The time interval for the historical usage data.\n

", + "smithy.api#required": {} + } + }, + "filterExpression": { + "target": "com.amazonaws.bcmpricingcalculator#Expression", + "traits": { + "smithy.api#documentation": "

\n An optional filter expression to apply to the historical usage data.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents historical usage data for a specific entity.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

\n An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web Services support.\n

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web Services support.\n

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bcmpricingcalculator#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateCommitments": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateCommitmentsRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateCommitmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list commitments associated with the specified bill estimate" + }, + "smithy.api#documentation": "

\n Lists the commitments associated with a bill estimate.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateCommitmentsRequest": { + "type": "structure", + "members": { + "billEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill estimate to list commitments for.\n

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateCommitmentsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateCommitmentSummaries", + "traits": { + "smithy.api#documentation": "

\n The list of commitments associated with the bill estimate.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputCommitmentModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputCommitmentModificationsRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputCommitmentModificationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list added or removed commitments for a specified bill estimate" + }, + "smithy.api#documentation": "

\n Lists the input commitment modifications associated with a bill estimate.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputCommitmentModificationsRequest": { + "type": "structure", + "members": { + "billEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill estimate to list input commitment modifications for.\n

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputCommitmentModificationsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateInputCommitmentModificationSummaries", + "traits": { + "smithy.api#documentation": "

\n The list of input commitment modifications associated with the bill estimate.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputUsageModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputUsageModificationsRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputUsageModificationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list added or modified usage for a specified bill estimate" + }, + "smithy.api#documentation": "

\n Lists the input usage modifications associated with a bill estimate.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputUsageModificationsRequest": { + "type": "structure", + "members": { + "billEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill estimate to list input usage modifications for.\n

", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.bcmpricingcalculator#ListUsageFilters", + "traits": { + "smithy.api#documentation": "

\n Filters to apply to the list of input usage modifications.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateInputUsageModificationsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateInputUsageModificationSummaries", + "traits": { + "smithy.api#documentation": "

\n The list of input usage modifications associated with the bill estimate.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list result line items for a specified bill estimate" + }, + "smithy.api#documentation": "

\n Lists the line items associated with a bill estimate.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsFilterName", + "traits": { + "smithy.api#documentation": "

\n The name of the filter attribute.\n

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsFilterValues", + "traits": { + "smithy.api#documentation": "

\n The values to filter by.\n

", + "smithy.api#required": {} + } + }, + "matchOption": { + "target": "com.amazonaws.bcmpricingcalculator#MatchOption", + "traits": { + "smithy.api#documentation": "

\n The match option for the filter (e.g., equals, contains).\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a filter for listing bill estimate line items.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsFilterName": { + "type": "enum", + "members": { + "USAGE_ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_ACCOUNT_ID" + } + }, + "SERVICE_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_CODE" + } + }, + "USAGE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_TYPE" + } + }, + "OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATION" + } + }, + "LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCATION" + } + }, + "LINE_ITEM_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE_ITEM_TYPE" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsFilter" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsRequest": { + "type": "structure", + "members": { + "billEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill estimate to list line items for.\n

", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsFilters", + "traits": { + "smithy.api#documentation": "

\n Filters to apply to the list of line items.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimateLineItemsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateLineItemSummaries", + "traits": { + "smithy.api#documentation": "

\n The list of line items associated with the bill estimate.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimates": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimatesRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list bill estimates" + }, + "smithy.api#documentation": "

\n Lists all bill estimates for the account.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimatesFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimatesFilterName", + "traits": { + "smithy.api#documentation": "

\n The name of the filter attribute.\n

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimatesFilterValues", + "traits": { + "smithy.api#documentation": "

\n The values to filter by.\n

", + "smithy.api#required": {} + } + }, + "matchOption": { + "target": "com.amazonaws.bcmpricingcalculator#MatchOption", + "traits": { + "smithy.api#documentation": "

\n The match option for the filter (e.g., equals, contains).\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a filter for listing bill estimates.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimatesFilterName": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimatesFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimatesFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimatesFilter" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimatesRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillEstimatesFilters", + "traits": { + "smithy.api#documentation": "

\n Filters to apply to the list of bill estimates.\n

" + } + }, + "createdAtFilter": { + "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", + "traits": { + "smithy.api#documentation": "

\n Filter bill estimates based on their creation date.\n

" + } + }, + "expiresAtFilter": { + "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", + "traits": { + "smithy.api#documentation": "

\n Filter bill estimates based on their expiration date.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillEstimatesResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateSummaries", + "traits": { + "smithy.api#documentation": "

\n The list of bill estimates for the account.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenarioCommitmentModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenarioCommitmentModificationsRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenarioCommitmentModificationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list commitments included in a bill scenario" + }, + "smithy.api#documentation": "

\n Lists the commitment modifications associated with a bill scenario.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenarioCommitmentModificationsRequest": { + "type": "structure", + "members": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill scenario to list commitment modifications for.\n

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenarioCommitmentModificationsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioCommitmentModificationItems", + "traits": { + "smithy.api#documentation": "

\n The list of commitment modifications associated with the bill scenario.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenarioUsageModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenarioUsageModificationsRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenarioUsageModificationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list usage lines of a specified bill scenario" + }, + "smithy.api#documentation": "

\n Lists the usage modifications associated with a bill scenario.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenarioUsageModificationsRequest": { + "type": "structure", + "members": { + "billScenarioId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill scenario to list usage modifications for.\n

", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.bcmpricingcalculator#ListUsageFilters", + "traits": { + "smithy.api#documentation": "

\n Filters to apply to the list of usage modifications.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenarioUsageModificationsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioUsageModificationItems", + "traits": { + "smithy.api#documentation": "

\n The list of usage modifications associated with the bill scenario.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenarios": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenariosRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenariosResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list bill scenarios" + }, + "smithy.api#documentation": "

\n Lists all bill scenarios for the account.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenariosFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenariosFilterName", + "traits": { + "smithy.api#documentation": "

\n The name of the filter attribute.\n

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenariosFilterValues", + "traits": { + "smithy.api#documentation": "

\n The values to filter by.\n

", + "smithy.api#required": {} + } + }, + "matchOption": { + "target": "com.amazonaws.bcmpricingcalculator#MatchOption", + "traits": { + "smithy.api#documentation": "

\n The match option for the filter (e.g., equals, contains).\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a filter for listing bill scenarios.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenariosFilterName": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenariosFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenariosFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenariosFilter" + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenariosRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bcmpricingcalculator#ListBillScenariosFilters", + "traits": { + "smithy.api#documentation": "

\n Filters to apply to the list of bill scenarios.\n

" + } + }, + "createdAtFilter": { + "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", + "traits": { + "smithy.api#documentation": "

\n Filter bill scenarios based on their creation date.\n

" + } + }, + "expiresAtFilter": { + "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", + "traits": { + "smithy.api#documentation": "

\n Filter bill scenarios based on their expiration date.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListBillScenariosResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioSummaries", + "traits": { + "smithy.api#documentation": "

\n The list of bill scenarios for the account.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to return a list of tags for a resource" + }, + "smithy.api#documentation": "

\n Lists all tags associated with a specified resource.\n

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmpricingcalculator#Arn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource to list tags for.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bcmpricingcalculator#Tags", + "traits": { + "smithy.api#documentation": "

\n The list of tags associated with the specified resource.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListUsageFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#ListUsageFilterName", + "traits": { + "smithy.api#documentation": "

\n The name of the filter attribute.\n

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bcmpricingcalculator#ListUsageFilterValues", + "traits": { + "smithy.api#documentation": "

\n The values to filter by.\n

", + "smithy.api#required": {} + } + }, + "matchOption": { + "target": "com.amazonaws.bcmpricingcalculator#MatchOption", + "traits": { + "smithy.api#documentation": "

\n The match option for the filter (e.g., equals, contains).\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a filter for listing usage data.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#ListUsageFilterName": { + "type": "enum", + "members": { + "USAGE_ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_ACCOUNT_ID" + } + }, + "SERVICE_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_CODE" + } + }, + "USAGE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_TYPE" + } + }, + "OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATION" + } + }, + "LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCATION" + } + }, + "USAGE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_GROUP" + } + }, + "HISTORICAL_USAGE_ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HISTORICAL_USAGE_ACCOUNT_ID" + } + }, + "HISTORICAL_SERVICE_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HISTORICAL_SERVICE_CODE" + } + }, + "HISTORICAL_USAGE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HISTORICAL_USAGE_TYPE" + } + }, + "HISTORICAL_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HISTORICAL_OPERATION" + } + }, + "HISTORICAL_LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HISTORICAL_LOCATION" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#ListUsageFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bcmpricingcalculator#ListUsageFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ListUsageFilter" + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimateUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimateUsageRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimateUsageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list usage lines for the specified workload estimate" + }, + "smithy.api#documentation": "

\n Lists the usage associated with a workload estimate.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimateUsageRequest": { + "type": "structure", + "members": { + "workloadEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the workload estimate to list usage for.\n

", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.bcmpricingcalculator#ListUsageFilters", + "traits": { + "smithy.api#documentation": "

\n Filters to apply to the list of usage items.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimateUsageResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsageItems", + "traits": { + "smithy.api#documentation": "

\n The list of usage items associated with the workload estimate.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimates": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list workload estimates" + }, + "smithy.api#documentation": "

\n Lists all workload estimates for the account.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesFilterName", + "traits": { + "smithy.api#documentation": "

\n The name of the filter attribute.\n

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesFilterValues", + "traits": { + "smithy.api#documentation": "

\n The values to filter by.\n

", + "smithy.api#required": {} + } + }, + "matchOption": { + "target": "com.amazonaws.bcmpricingcalculator#MatchOption", + "traits": { + "smithy.api#documentation": "

\n The match option for the filter (e.g., equals, contains).\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a filter for listing workload estimates.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesFilterName": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesFilter" + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesRequest": { + "type": "structure", + "members": { + "createdAtFilter": { + "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", + "traits": { + "smithy.api#documentation": "

\n Filter workload estimates based on their creation date.\n

" + } + }, + "expiresAtFilter": { + "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", + "traits": { + "smithy.api#documentation": "

\n Filter workload estimates based on their expiration date.\n

" + } + }, + "filters": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesFilters", + "traits": { + "smithy.api#documentation": "

\n Filters to apply to the list of workload estimates.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.bcmpricingcalculator#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimatesResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateSummaries", + "traits": { + "smithy.api#documentation": "

\n The list of workload estimates for the account.\n

" + } + }, + "nextToken": { + "target": "com.amazonaws.bcmpricingcalculator#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n A token to retrieve the next page of results, if any.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#MatchOption": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 25 + } + } + }, + "com.amazonaws.bcmpricingcalculator#NegateReservedInstanceAction": { + "type": "structure", + "members": { + "reservedInstancesId": { + "target": "com.amazonaws.bcmpricingcalculator#Uuid", + "traits": { + "smithy.api#documentation": "

\n The ID of the Reserved Instance to remove.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an action to remove a Reserved Instance from a bill scenario.\n

\n

\n This is the ID of an existing Reserved Instance in your account.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#NegateSavingsPlanAction": { + "type": "structure", + "members": { + "savingsPlanId": { + "target": "com.amazonaws.bcmpricingcalculator#Uuid", + "traits": { + "smithy.api#documentation": "

\n The ID of the Savings Plan to remove.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents an action to remove a Savings Plan from a bill scenario.\n

\n

\n This is the ID of an existing Savings Plan in your account.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#NextPageToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmpricingcalculator#Operation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9\\.\\-_:,]*$" + } + }, + "com.amazonaws.bcmpricingcalculator#PurchaseAgreementType": { + "type": "enum", + "members": { + "SAVINGS_PLANS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLANS" + } + }, + "RESERVED_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVED_INSTANCE" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#RateType": { + "type": "enum", + "members": { + "BEFORE_DISCOUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEFORE_DISCOUNTS" + } + }, + "AFTER_DISCOUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_DISCOUNTS" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#RateTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#RateType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bcmpricingcalculator#ReservedInstanceInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.bcmpricingcalculator#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The identifier of the resource that was not found.\n

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The type of the resource that was not found.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundCode", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n The specified resource was not found.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bcmpricingcalculator#ResourceTagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w\\s:+=@/-]+$" + } + }, + "com.amazonaws.bcmpricingcalculator#ResourceTagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceTagKey" + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bcmpricingcalculator#ResourceTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\w\\s:+=@/-]*$" + } + }, + "com.amazonaws.bcmpricingcalculator#SavingsPlanArns": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bcmpricingcalculator#SavingsPlanCommitment": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0.001, + "max": 1000000 + } + } + }, + "com.amazonaws.bcmpricingcalculator#ServiceCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9\\.\\-_:, \\/()]*$" + } + }, + "com.amazonaws.bcmpricingcalculator#ServiceCostDifferenceMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.bcmpricingcalculator#CostDifference" + } + }, + "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The identifier of the resource that exceeded quota.\n

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The type of the resource that exceeded quota.\n

", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The service code that exceeded quota.\n

" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The quota code that was exceeded.\n

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceQuotaCode", + "httpResponseCode": 402 + }, + "smithy.api#documentation": "

\n The request would cause you to exceed your service quota.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bcmpricingcalculator#StringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bcmpricingcalculator#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to add a tag to a resource" + }, + "smithy.api#documentation": "

\n Adds one or more tags to a specified resource.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#TagResourceRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmpricingcalculator#Arn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource to add tags to.\n

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bcmpricingcalculator#Tags", + "traits": { + "smithy.api#documentation": "

\n The tags to add to the resource.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceTagKey" + }, + "value": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceTagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bcmpricingcalculator#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The service code that exceeded the throttling limit.

" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The quota code that exceeded the throttling limit.

" + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The service code that exceeded the throttling limit. Retry your \n request, but if the problem persists, contact Amazon Web Services support.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ThrottlingCode", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

\n The request was denied due to request throttling.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bcmpricingcalculator#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to remove a tag from a resource" + }, + "smithy.api#documentation": "

\n Removes one or more tags from a specified resource.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#UntagResourceRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmpricingcalculator#Arn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource to remove tags from.\n

", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceTagKeys", + "traits": { + "smithy.api#documentation": "

\n The keys of the tags to remove from the resource.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdateBillEstimate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#UpdateBillEstimateRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#UpdateBillEstimateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ConflictException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update bill estimate name and expiration date time" + }, + "smithy.api#documentation": "

\n Updates an existing bill estimate.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdateBillEstimateRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill estimate to update.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateName", + "traits": { + "smithy.api#documentation": "

\n The new name for the bill estimate.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The new expiration date for the bill estimate.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdateBillEstimateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the updated bill estimate.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateName", + "traits": { + "smithy.api#documentation": "

\n The updated name of the bill estimate.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the updated bill estimate.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the bill estimate update failed.\n

" + } + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval", + "traits": { + "smithy.api#documentation": "

\n The time period covered by the updated bill estimate.\n

" + } + }, + "costSummary": { + "target": "com.amazonaws.bcmpricingcalculator#BillEstimateCostSummary", + "traits": { + "smithy.api#documentation": "

\n A summary of the updated estimated costs.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill estimate was originally created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The updated expiration timestamp for the bill estimate.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdateBillScenario": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#UpdateBillScenarioRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#UpdateBillScenarioResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ConflictException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update name and expiration date time of the specified bill scenario" + }, + "smithy.api#documentation": "

\n Updates an existing bill scenario.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdateBillScenarioRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the bill scenario to update.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billScenarioId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioName", + "traits": { + "smithy.api#documentation": "

\n The new name for the bill scenario.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The new expiration date for the bill scenario.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdateBillScenarioResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the updated bill scenario.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "billScenarioId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioName", + "traits": { + "smithy.api#documentation": "

\n The updated name of the bill scenario.\n

" + } + }, + "billInterval": { + "target": "com.amazonaws.bcmpricingcalculator#BillInterval", + "traits": { + "smithy.api#documentation": "

\n The time period covered by the updated bill scenario.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#BillScenarioStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the updated bill scenario.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the bill scenario was originally created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The updated expiration timestamp for the bill scenario.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the bill scenario update failed.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdatePreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#UpdatePreferencesRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#UpdatePreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update rate type preferences for the account" + }, + "smithy.api#documentation": "

\n Updates the preferences for the Amazon Web Services Cost Explorer service.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdatePreferencesRequest": { + "type": "structure", + "members": { + "managementAccountRateTypeSelections": { + "target": "com.amazonaws.bcmpricingcalculator#RateTypes", + "traits": { + "smithy.api#documentation": "

\n The updated preferred rate types for the management account.\n

" + } + }, + "memberAccountRateTypeSelections": { + "target": "com.amazonaws.bcmpricingcalculator#RateTypes", + "traits": { + "smithy.api#documentation": "

\n The updated preferred rate types for member accounts.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdatePreferencesResponse": { + "type": "structure", + "members": { + "managementAccountRateTypeSelections": { + "target": "com.amazonaws.bcmpricingcalculator#RateTypes", + "traits": { + "smithy.api#documentation": "

\n The updated preferred rate types for the management account.\n

" + } + }, + "memberAccountRateTypeSelections": { + "target": "com.amazonaws.bcmpricingcalculator#RateTypes", + "traits": { + "smithy.api#documentation": "

\n The updated preferred rate types for member accounts.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdateWorkloadEstimate": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmpricingcalculator#UpdateWorkloadEstimateRequest" + }, + "output": { + "target": "com.amazonaws.bcmpricingcalculator#UpdateWorkloadEstimateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmpricingcalculator#ConflictException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#DataUnavailableException" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update name and expiration date time of the specified workload estimate" + }, + "smithy.api#documentation": "

\n Updates an existing workload estimate.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdateWorkloadEstimateRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the workload estimate to update.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workloadEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateName", + "traits": { + "smithy.api#documentation": "

\n The new name for the workload estimate.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The new expiration date for the workload estimate.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UpdateWorkloadEstimateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the updated workload estimate.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workloadEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateName", + "traits": { + "smithy.api#documentation": "

\n The updated name of the workload estimate.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the workload estimate was originally created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The updated expiration timestamp for the workload estimate.\n

" + } + }, + "rateType": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateRateType", + "traits": { + "smithy.api#documentation": "

\n The type of pricing rates used for the updated estimate.\n

" + } + }, + "rateTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp of the pricing rates used for the updated estimate.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the updated workload estimate.\n

" + } + }, + "totalCost": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The updated total estimated cost for the workload.\n

" + } + }, + "costCurrency": { + "target": "com.amazonaws.bcmpricingcalculator#CurrencyCode", + "traits": { + "smithy.api#documentation": "

\n The currency of the updated estimated cost.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the workload estimate update failed.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "Mixin for common fields returned by CRUD APIs", + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmpricingcalculator#UsageAmount": { + "type": "structure", + "members": { + "startHour": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The start hour of the usage period.\n

", + "smithy.api#required": {} + } + }, + "amount": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The usage amount for the period.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a usage amount for a specific time period.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#UsageAmounts": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#UsageAmount" + } + }, + "com.amazonaws.bcmpricingcalculator#UsageGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.bcmpricingcalculator#UsageQuantities": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#UsageQuantity" + } + }, + "com.amazonaws.bcmpricingcalculator#UsageQuantity": { + "type": "structure", + "members": { + "startHour": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The start hour of the usage period.\n

" + } + }, + "unit": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The unit of measurement for the usage quantity.\n

" + } + }, + "amount": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The numeric value of the usage quantity.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a usage quantity with associated unit and time period.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#UsageQuantityResult": { + "type": "structure", + "members": { + "amount": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The numeric value of the usage quantity result.\n

" + } + }, + "unit": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The unit of measurement for the usage quantity result.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents the result of a usage quantity calculation.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#UsageType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9\\.\\-_:,]*$" + } + }, + "com.amazonaws.bcmpricingcalculator#Uuid": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.bcmpricingcalculator#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.bcmpricingcalculator#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

\n The reason for the validation exception.\n

" + } + }, + "fieldList": { + "target": "com.amazonaws.bcmpricingcalculator#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

\n The list of fields that are invalid.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The input provided fails to satisfy the constraints specified by an Amazon Web Services service.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bcmpricingcalculator#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The name of the field that failed validation.\n

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The error message describing why the field failed validation.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a field that failed validation in a request.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#ValidationExceptionField" + } + }, + "com.amazonaws.bcmpricingcalculator#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "INVALID_REQUEST_FROM_MEMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "invalidRequestFromMember" + } + }, + "DISALLOWED_RATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disallowedRate" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimate": { + "type": "resource", + "identifiers": { + "workloadEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "properties": { + "name": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateName" + }, + "createdAt": { + "target": "smithy.api#Timestamp" + }, + "expiresAt": { + "target": "smithy.api#Timestamp" + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateStatus" + }, + "failureMessage": { + "target": "smithy.api#String" + }, + "rateType": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateRateType" + }, + "rateTimestamp": { + "target": "smithy.api#Timestamp" + }, + "totalCost": { + "target": "smithy.api#Double" + }, + "costCurrency": { + "target": "com.amazonaws.bcmpricingcalculator#CurrencyCode" + } + }, + "create": { + "target": "com.amazonaws.bcmpricingcalculator#CreateWorkloadEstimate" + }, + "read": { + "target": "com.amazonaws.bcmpricingcalculator#GetWorkloadEstimate" + }, + "update": { + "target": "com.amazonaws.bcmpricingcalculator#UpdateWorkloadEstimate" + }, + "delete": { + "target": "com.amazonaws.bcmpricingcalculator#DeleteWorkloadEstimate" + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimates" + }, + "resources": [ + { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsage" + } + ], + "traits": { + "aws.api#arn": { + "template": "workload-estimate/{workloadEstimateId}" + }, + "aws.api#taggable": {}, + "aws.iam#iamResource": { + "name": "workload-estimate" + }, + "smithy.api#documentation": "Represents a workload estimate that allows usage modeling" + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateCostStatus": { + "type": "enum", + "members": { + "VALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALID" + } + }, + "INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID" + } + }, + "STALE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STALE" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateRateType": { + "type": "enum", + "members": { + "BEFORE_DISCOUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEFORE_DISCOUNTS" + } + }, + "AFTER_DISCOUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_DISCOUNTS" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateStatus": { + "type": "enum", + "members": { + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "VALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALID" + } + }, + "INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID" + } + }, + "ACTION_NEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_NEEDED" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateSummary" + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the workload estimate.\n

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "workloadEstimateId" + } + }, + "name": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateName", + "traits": { + "smithy.api#documentation": "

\n The name of the workload estimate.\n

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the workload estimate was created.\n

" + } + }, + "expiresAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the workload estimate will expire.\n

" + } + }, + "rateType": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateRateType", + "traits": { + "smithy.api#documentation": "

\n The type of pricing rates used for the estimate.\n

" + } + }, + "rateTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The timestamp of the pricing rates used for the estimate.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the workload estimate.\n

" + } + }, + "totalCost": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The total estimated cost for the workload.\n

" + } + }, + "costCurrency": { + "target": "com.amazonaws.bcmpricingcalculator#CurrencyCode", + "traits": { + "smithy.api#documentation": "

\n The currency of the estimated cost.\n

" + } + }, + "failureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n An error message if the workload estimate creation or processing failed.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides a summary of a workload estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUpdateUsageErrorCode": { + "type": "enum", + "members": { + "BAD_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_REQUEST" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + }, + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsage": { + "type": "resource", + "identifiers": { + "workloadEstimateId": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId" + } + }, + "list": { + "target": "com.amazonaws.bcmpricingcalculator#ListWorkloadEstimateUsage" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.bcmpricingcalculator#BatchCreateWorkloadEstimateUsage" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BatchDeleteWorkloadEstimateUsage" + }, + { + "target": "com.amazonaws.bcmpricingcalculator#BatchUpdateWorkloadEstimateUsage" + } + ], + "traits": { + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsageItem": { + "type": "structure", + "members": { + "serviceCode": { + "target": "com.amazonaws.bcmpricingcalculator#ServiceCode", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services service code associated with this usage item.\n

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.bcmpricingcalculator#UsageType", + "traits": { + "smithy.api#documentation": "

\n The type of usage for this item.\n

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.bcmpricingcalculator#Operation", + "traits": { + "smithy.api#documentation": "

\n The specific operation associated with this usage item.\n

", + "smithy.api#required": {} + } + }, + "location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The location associated with this usage item.\n

" + } + }, + "id": { + "target": "com.amazonaws.bcmpricingcalculator#ResourceId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of this usage item.\n

" + } + }, + "usageAccountId": { + "target": "com.amazonaws.bcmpricingcalculator#AccountId", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID associated with this usage item.\n

" + } + }, + "group": { + "target": "com.amazonaws.bcmpricingcalculator#UsageGroup", + "traits": { + "smithy.api#documentation": "

\n The group identifier for this usage item.\n

" + } + }, + "quantity": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsageQuantity", + "traits": { + "smithy.api#documentation": "

\n The estimated usage quantity for this item.\n

" + } + }, + "cost": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The estimated cost for this usage item.\n

" + } + }, + "currency": { + "target": "com.amazonaws.bcmpricingcalculator#CurrencyCode", + "traits": { + "smithy.api#documentation": "

\n The currency of the estimated cost.\n

" + } + }, + "status": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateCostStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of this usage item.\n

" + } + }, + "historicalUsage": { + "target": "com.amazonaws.bcmpricingcalculator#HistoricalUsageEntity", + "traits": { + "smithy.api#documentation": "

\n Historical usage data associated with this item, if available.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a usage item in a workload estimate.\n

" + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsageItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsageItem" + } + }, + "com.amazonaws.bcmpricingcalculator#WorkloadEstimateUsageQuantity": { + "type": "structure", + "members": { + "unit": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The unit of measurement for the usage quantity.\n

" + } + }, + "amount": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n The numeric value of the usage quantity.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a usage quantity for a workload estimate.\n

" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json index ffd2c867315..56708dc1846 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json @@ -1,6 +1,26 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.bedrockagentruntime#APISchema": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagentruntime#S3Identifier", + "traits": { + "smithy.api#documentation": "

\n Contains details about the S3 object containing the OpenAPI schema for the action group.\n

" + } + }, + "payload": { + "target": "com.amazonaws.bedrockagentruntime#Payload", + "traits": { + "smithy.api#documentation": "

\n The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.\n You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.\n

" + } + }, "com.amazonaws.bedrockagentruntime#AccessDeniedException": { "type": "structure", "members": { @@ -14,6 +34,26 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.bedrockagentruntime#ActionGroupExecutor": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagentruntime#LambdaResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.\n

" + } + }, + "customControl": { + "target": "com.amazonaws.bedrockagentruntime#CustomControlMethod", + "traits": { + "smithy.api#documentation": "

\n To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the \n custom control method for handling the information elicited from the user.\n

" + } + }, "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput": { "type": "structure", "members": { @@ -96,6 +136,23 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#ActionGroupSignature": { + "type": "enum", + "members": { + "AMAZON_USERINPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.UserInput" + } + }, + "AMAZON_CODEINTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.CodeInterpreter" + } + } + } + }, "com.amazonaws.bedrockagentruntime#ActionInvocationType": { "type": "enum", "members": { @@ -140,6 +197,57 @@ "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFieldsValue": { "type": "document" }, + "com.amazonaws.bedrockagentruntime#AgentActionGroup": { + "type": "structure", + "members": { + "actionGroupName": { + "target": "com.amazonaws.bedrockagentruntime#ResourceName", + "traits": { + "smithy.api#documentation": "

\n The name of the action group.\n

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentruntime#ResourceDescription", + "traits": { + "smithy.api#documentation": "

\n A description of the action group.\n

" + } + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "

\n To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. \n You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.\n

\n

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. You must \n leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

\n

During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request,\n it will invoke this action group instead and return an Observation reprompting the user for more information.

" + } + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking \n the action or the custom control method for handling the information elicited from the user.\n

" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagentruntime#APISchema", + "traits": { + "smithy.api#documentation": "

\n Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted \n payload defining the schema. For more information, see Action group OpenAPI schemas.\n

" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagentruntime#FunctionSchema", + "traits": { + "smithy.api#documentation": "

\n Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Contains details of the inline agent's action group.\n

" + } + }, + "com.amazonaws.bedrockagentruntime#AgentActionGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#AgentActionGroup" + } + }, "com.amazonaws.bedrockagentruntime#AgentAliasId": { "type": "string", "traits": { @@ -178,6 +286,9 @@ { "target": "com.amazonaws.bedrockagentruntime#InferenceResource" }, + { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentResource" + }, { "target": "com.amazonaws.bedrockagentruntime#MemoryResource" }, @@ -1075,6 +1186,16 @@ "smithy.api#httpError": 502 } }, + "com.amazonaws.bedrockagentruntime#BasePromptTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#BedrockModelArn": { "type": "string", "traits": { @@ -1300,6 +1421,17 @@ } } }, + "com.amazonaws.bedrockagentruntime#CustomControlMethod": { + "type": "enum", + "members": { + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, "com.amazonaws.bedrockagentruntime#DateTimestamp": { "type": "timestamp", "traits": { @@ -2214,6 +2346,48 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#FunctionDefinition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentruntime#ResourceName", + "traits": { + "smithy.api#documentation": "

\n A name for the function.\n

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentruntime#FunctionDescription", + "traits": { + "smithy.api#documentation": "

\n A description of the function and its purpose.\n

" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#ParameterMap", + "traits": { + "smithy.api#documentation": "

\n The parameters that the agent elicits from the user to fulfill the function.\n

" + } + }, + "requireConfirmation": { + "target": "com.amazonaws.bedrockagentruntime#RequireConfirmation", + "traits": { + "smithy.api#documentation": "

\n Contains information if user confirmation is required to invoke the function.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.\n

" + } + }, + "com.amazonaws.bedrockagentruntime#FunctionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1200 + } + } + }, "com.amazonaws.bedrockagentruntime#FunctionInvocationInput": { "type": "structure", "members": { @@ -2318,6 +2492,26 @@ "smithy.api#documentation": "

Contains information about the function that was called from the action group and the response that was returned.

\n

This data type is used in the following API operations:

\n " } }, + "com.amazonaws.bedrockagentruntime#FunctionSchema": { + "type": "union", + "members": { + "functions": { + "target": "com.amazonaws.bedrockagentruntime#Functions", + "traits": { + "smithy.api#documentation": "

\n A list of functions that each define an action in the action group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.\n

" + } + }, + "com.amazonaws.bedrockagentruntime#Functions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FunctionDefinition" + } + }, "com.amazonaws.bedrockagentruntime#GeneratedResponsePart": { "type": "structure", "members": { @@ -2595,6 +2789,28 @@ "smithy.api#documentation": "

The configuration details for the guardrail.

" } }, + "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailIdentifierWithArn", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for the guardrail.\n

", + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

\n The version of the guardrail.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The configuration details for the guardrail.\n

" + } + }, "com.amazonaws.bedrockagentruntime#GuardrailContentFilter": { "type": "structure", "members": { @@ -2757,6 +2973,15 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#GuardrailIdentifierWithArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, "com.amazonaws.bedrockagentruntime#GuardrailManagedWord": { "type": "structure", "members": { @@ -3217,6 +3442,16 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + } + }, "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction": { "type": "enum", "members": { @@ -3319,111 +3554,330 @@ } ] }, - "com.amazonaws.bedrockagentruntime#InputFile": { + "com.amazonaws.bedrockagentruntime#InlineAgentFilePart": { "type": "structure", "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The name of the source file.

", - "smithy.api#required": {} - } - }, - "source": { - "target": "com.amazonaws.bedrockagentruntime#FileSource", - "traits": { - "smithy.api#documentation": "

Specifies where the files are located.

", - "smithy.api#required": {} - } - }, - "useCase": { - "target": "com.amazonaws.bedrockagentruntime#FileUseCase", + "files": { + "target": "com.amazonaws.bedrockagentruntime#OutputFiles", "traits": { - "smithy.api#documentation": "

Specifies how the source files will be used by the code interpreter.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Files containing intermediate response for the user.

" } } }, "traits": { - "smithy.api#documentation": "

Contains details of the source files.

" - } - }, - "com.amazonaws.bedrockagentruntime#InputFiles": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagentruntime#InputFile" + "smithy.api#documentation": "

Contains intermediate response for code interpreter if any files have been generated.

" } }, - "com.amazonaws.bedrockagentruntime#InputPrompt": { - "type": "union", + "com.amazonaws.bedrockagentruntime#InlineAgentPayloadPart": { + "type": "structure", "members": { - "textPrompt": { - "target": "com.amazonaws.bedrockagentruntime#TextPrompt", + "bytes": { + "target": "com.amazonaws.bedrockagentruntime#PartBody", "traits": { - "smithy.api#documentation": "

Contains information about the text prompt to optimize.

" + "smithy.api#documentation": "

A part of the agent response in bytes.

" + } + }, + "attribution": { + "target": "com.amazonaws.bedrockagentruntime#Attribution", + "traits": { + "smithy.api#documentation": "

Contains citations for a part of an agent response.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information about the prompt to optimize.

" - } - }, - "com.amazonaws.bedrockagentruntime#InputText": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 25000000 - }, + "smithy.api#documentation": "

Contains a part of an agent response and citations for it.

", "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagentruntime#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + "com.amazonaws.bedrockagentruntime#InlineAgentResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#InvokeInlineAgent" } - }, - "traits": { - "smithy.api#documentation": "

An internal server error occurred. Retry your request.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } + ] }, - "com.amazonaws.bedrockagentruntime#InvocationInput": { - "type": "structure", + "com.amazonaws.bedrockagentruntime#InlineAgentResponseStream": { + "type": "union", "members": { - "traceId": { - "target": "com.amazonaws.bedrockagentruntime#TraceId", + "chunk": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentPayloadPart", "traits": { - "smithy.api#documentation": "

The unique identifier of the trace.

" + "smithy.api#documentation": "

Contains a part of an agent response and citations for it.

" } }, - "invocationType": { - "target": "com.amazonaws.bedrockagentruntime#InvocationType", + "trace": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentTracePart", "traits": { - "smithy.api#documentation": "

Specifies whether the agent is invoking an action group or a knowledge base.

" + "smithy.api#documentation": "

Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying \n knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. \n For more information, see Trace events. \n

" } }, - "actionGroupInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput", + "returnControl": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentReturnControlPayload", "traits": { - "smithy.api#documentation": "

Contains information about the action group to be invoked.

" + "smithy.api#documentation": "

Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system \n and can be used in your own setup for fulfilling the action.

" } }, - "knowledgeBaseLookupInput": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput", + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", "traits": { - "smithy.api#documentation": "

Contains details about the knowledge base to look up and the query to be made.

" + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

" } }, - "codeInterpreterInvocationInput": { - "target": "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationInput", + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException", "traits": { - "smithy.api#documentation": "

Contains information about the code interpreter to be invoked.

" + "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

" } - } - }, + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + "traits": { + "smithy.api#documentation": "

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

" + } + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

" + } + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "

The request is denied because of missing access permissions. Check your permissions and retry your request.

" + } + }, + "conflictException": { + "target": "com.amazonaws.bedrockagentruntime#ConflictException", + "traits": { + "smithy.api#documentation": "

There was a conflict performing an operation. Resolve the conflict and retry your request.

" + } + }, + "dependencyFailedException": { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "

There was an issue with a dependency. Check the resource configurations and retry the request.

" + } + }, + "badGatewayException": { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "

There was an issue with a dependency due to a server issue. Retry your request.

" + } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentFilePart", + "traits": { + "smithy.api#documentation": "

Contains intermediate response for code interpreter if any files have been generated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response from invoking the agent and associated citations and trace information.

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentruntime#InlineAgentReturnControlPayload": { + "type": "structure", + "members": { + "invocationInputs": { + "target": "com.amazonaws.bedrockagentruntime#InvocationInputs", + "traits": { + "smithy.api#documentation": "

A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent \n determines from its session with the user.

" + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the action group invocation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information to return from the action group that the agent has predicted to invoke.

\n

This data type is used in the InvokeAgent response API operation.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InlineAgentTracePart": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the session with the agent.

" + } + }, + "trace": { + "target": "com.amazonaws.bedrockagentruntime#Trace", + "traits": { + "smithy.api#documentation": "

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the \n agent arrived at the response it provided the customer. For more information, see Trace enablement.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases \n and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. \n For more information, see Trace enablement.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InlineSessionState": { + "type": "structure", + "members": { + "sessionAttributes": { + "target": "com.amazonaws.bedrockagentruntime#SessionAttributesMap", + "traits": { + "smithy.api#documentation": "

\n Contains attributes that persist across a session and the values of those attributes.\n

" + } + }, + "promptSessionAttributes": { + "target": "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap", + "traits": { + "smithy.api#documentation": "

\n Contains attributes that persist across a session and the values of those attributes.\n

" + } + }, + "returnControlInvocationResults": { + "target": "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults", + "traits": { + "smithy.api#documentation": "

\n Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.\n

\n \n

If you include this field in the sessionState field, the inputText field will be ignored.

\n " + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeInlineAgent response for the action \n whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer.\n

" + } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#InputFiles", + "traits": { + "smithy.api#documentation": "

\n Contains information about the files used by code interpreter.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Contains parameters that specify various attributes that persist across a session or prompt. You can define session state \n attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. \n Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. \n For more information, see Control session context\n

" + } + }, + "com.amazonaws.bedrockagentruntime#InputFile": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the source file.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#FileSource", + "traits": { + "smithy.api#documentation": "

Specifies where the files are located.

", + "smithy.api#required": {} + } + }, + "useCase": { + "target": "com.amazonaws.bedrockagentruntime#FileUseCase", + "traits": { + "smithy.api#documentation": "

Specifies how the source files will be used by the code interpreter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of the source files.

" + } + }, + "com.amazonaws.bedrockagentruntime#InputFiles": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#InputFile" + } + }, + "com.amazonaws.bedrockagentruntime#InputPrompt": { + "type": "union", + "members": { + "textPrompt": { + "target": "com.amazonaws.bedrockagentruntime#TextPrompt", + "traits": { + "smithy.api#documentation": "

Contains information about the text prompt to optimize.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the prompt to optimize.

" + } + }, + "com.amazonaws.bedrockagentruntime#InputText": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 25000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#Instruction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 40 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagentruntime#InvocationInput": { + "type": "structure", + "members": { + "traceId": { + "target": "com.amazonaws.bedrockagentruntime#TraceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the trace.

" + } + }, + "invocationType": { + "target": "com.amazonaws.bedrockagentruntime#InvocationType", + "traits": { + "smithy.api#documentation": "

Specifies whether the agent is invoking an action group or a knowledge base.

" + } + }, + "actionGroupInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput", + "traits": { + "smithy.api#documentation": "

Contains information about the action group to be invoked.

" + } + }, + "knowledgeBaseLookupInput": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput", + "traits": { + "smithy.api#documentation": "

Contains details about the knowledge base to look up and the query to be made.

" + } + }, + "codeInterpreterInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationInput", + "traits": { + "smithy.api#documentation": "

Contains information about the code interpreter to be invoked.

" + } + } + }, "traits": { "smithy.api#documentation": "

Contains information pertaining to the action group or knowledge base that is being invoked.

", "smithy.api#sensitive": {} @@ -3746,24 +4200,220 @@ "responseStream": { "target": "com.amazonaws.bedrockagentruntime#FlowResponseStream", "traits": { - "smithy.api#documentation": "

The output of the flow, returned as a stream. If there's an error, the error is returned.

", - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

The output of the flow, returned as a stream. If there's an error, the error is returned.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeInlineAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#InvokeInlineAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#InvokeInlineAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.\n

\n \n \n

The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeInlineAgent.

\n ", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{sessionId}" + } + } + }, + "com.amazonaws.bedrockagentruntime#InvokeInlineAgentRequest": { + "type": "structure", + "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the session. Use the same value across requests to continue the same conversation.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent. \n

" + } + }, + "endSession": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

\n Specifies whether to end the session with the inline agent or not.\n

" + } + }, + "enableTrace": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

\n Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.\n \n

" + } + }, + "inputText": { + "target": "com.amazonaws.bedrockagentruntime#InputText", + "traits": { + "smithy.api#documentation": "

\n The prompt text to send to the agent.\n

\n \n

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

\n " + } + }, + "inlineSessionState": { + "target": "com.amazonaws.bedrockagentruntime#InlineSessionState", + "traits": { + "smithy.api#documentation": "

\n Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an \n action group to return control, results from invocation of the action group. For more information, see Control session context.\n

\n \n

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

\n " + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagentruntime#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

\n The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.\n

", + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagentruntime#Instruction", + "traits": { + "smithy.api#documentation": "

\n The instructions that tell the inline agent what it should do and how it should interact with users.\n

", + "smithy.api#required": {} + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagentruntime#SessionTTL", + "traits": { + "smithy.api#documentation": "

\n The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.\n

\n

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.

" + } + }, + "actionGroups": { + "target": "com.amazonaws.bedrockagentruntime#AgentActionGroups", + "traits": { + "smithy.api#documentation": "

\n A list of action groups with each action group defining the action the inline agent needs to carry out.\n

" + } + }, + "knowledgeBases": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBases", + "traits": { + "smithy.api#documentation": "

\n Contains information of the knowledge bases to associate with. \n

" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn", + "traits": { + "smithy.api#documentation": "

\n The guardrails to assign to the inline agent.\n

" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "

\n Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeInlineAgentResponse": { + "type": "structure", + "members": { + "completion": { + "target": "com.amazonaws.bedrockagentruntime#InlineAgentResponseStream", + "traits": { + "smithy.api#documentation": "

\n \n

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrockagentruntime#MimeType", + "traits": { + "smithy.api#documentation": "

\n The MIME type of the input data in the request. The default value is application/json.\n

", + "smithy.api#httpHeader": "x-amzn-bedrock-agent-content-type", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the session with the agent.\n

", + "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBase": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for a knowledge base associated with the inline agent.\n

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagentruntime#ResourceDescription", + "traits": { + "smithy.api#documentation": "

\n The description of the knowledge base associated with the inline agent.\n

", "smithy.api#required": {} } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configurations to apply to the knowledge base during query. For more information, see Query configurations.\n

" + } } }, "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagentruntime#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + "smithy.api#documentation": "

\n Details of the knowledge base associated withe inline agent.\n

" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfiguration": { @@ -3996,9 +4646,24 @@ "smithy.api#documentation": "

Configurations for how to perform the search query and return results. For more information, see Query configurations.

\n

This data type is used in the following API operations:

\n " } }, + "com.amazonaws.bedrockagentruntime#KnowledgeBases": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBase" + } + }, "com.amazonaws.bedrockagentruntime#LambdaArn": { "type": "string" }, + "com.amazonaws.bedrockagentruntime#LambdaResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, "com.amazonaws.bedrockagentruntime#MaxResults": { "type": "integer", "traits": { @@ -4135,6 +4800,16 @@ "com.amazonaws.bedrockagentruntime#MimeType": { "type": "string" }, + "com.amazonaws.bedrockagentruntime#ModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)$" + } + }, "com.amazonaws.bedrockagentruntime#ModelInvocationInput": { "type": "structure", "members": { @@ -4661,12 +5336,98 @@ "smithy.api#documentation": "

A parameter for the API request or function.

" } }, + "com.amazonaws.bedrockagentruntime#ParameterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagentruntime#ParameterDetail": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.bedrockagentruntime#ParameterDescription", + "traits": { + "smithy.api#documentation": "

\n A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.\n

" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#ParameterType", + "traits": { + "smithy.api#documentation": "

\n The data type of the parameter.\n

", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

\n Whether the parameter is required for the agent to complete the function for action group invocation.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Contains details about a parameter in a function for an action group.\n

" + } + }, "com.amazonaws.bedrockagentruntime#ParameterList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Parameter" } }, + "com.amazonaws.bedrockagentruntime#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentruntime#ParameterName" + }, + "value": { + "target": "com.amazonaws.bedrockagentruntime#ParameterDetail" + } + }, + "com.amazonaws.bedrockagentruntime#ParameterName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagentruntime#ParameterType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "number" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "integer" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "array" + } + } + } + }, "com.amazonaws.bedrockagentruntime#Parameters": { "type": "list", "member": { @@ -4682,6 +5443,12 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#Payload": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#PayloadPart": { "type": "structure", "members": { @@ -4847,6 +5614,83 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#PromptConfiguration": { + "type": "structure", + "members": { + "promptType": { + "target": "com.amazonaws.bedrockagentruntime#PromptType", + "traits": { + "smithy.api#documentation": "

\n The step in the agent sequence that this prompt configuration applies to.\n

" + } + }, + "promptCreationMode": { + "target": "com.amazonaws.bedrockagentruntime#CreationMode", + "traits": { + "smithy.api#documentation": "

Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

" + } + }, + "promptState": { + "target": "com.amazonaws.bedrockagentruntime#PromptState", + "traits": { + "smithy.api#documentation": "

Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

\n " + } + }, + "basePromptTemplate": { + "target": "com.amazonaws.bedrockagentruntime#BasePromptTemplate", + "traits": { + "smithy.api#documentation": "

Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.

" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

" + } + }, + "parserMode": { + "target": "com.amazonaws.bedrockagentruntime#CreationMode", + "traits": { + "smithy.api#documentation": "

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.\n

" + } + }, + "com.amazonaws.bedrockagentruntime#PromptConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#PromptConfiguration" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentruntime#PromptOverrideConfiguration": { + "type": "structure", + "members": { + "promptConfigurations": { + "target": "com.amazonaws.bedrockagentruntime#PromptConfigurations", + "traits": { + "smithy.api#documentation": "

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

", + "smithy.api#required": {} + } + }, + "overrideLambda": { + "target": "com.amazonaws.bedrockagentruntime#LambdaResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. \n If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is \n set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap": { "type": "map", "key": { @@ -4856,6 +5700,23 @@ "target": "smithy.api#String" } }, + "com.amazonaws.bedrockagentruntime#PromptState": { + "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.bedrockagentruntime#PromptTemplate": { "type": "structure", "members": { @@ -4902,6 +5763,12 @@ "traits": { "smithy.api#enumValue": "POST_PROCESSING" } + }, + "ROUTING_CLASSIFIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUTING_CLASSIFIER" + } } } }, @@ -5040,6 +5907,41 @@ "smithy.api#documentation": "

The parameters in the API request body.

" } }, + "com.amazonaws.bedrockagentruntime#RequireConfirmation": { + "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.bedrockagentruntime#ResourceDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "/ @documentation(\"Description of the using the resource.\")", + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ResourceName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#ResourceNotFoundException": { "type": "structure", "members": { @@ -5854,6 +6756,36 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagentruntime#S3Identifier": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.bedrockagentruntime#S3BucketName", + "traits": { + "smithy.api#documentation": "

\n The name of the S3 bucket.\n

" + } + }, + "s3ObjectKey": { + "target": "com.amazonaws.bedrockagentruntime#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

\n The S3 object key for the S3 resource.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The identifier information for an Amazon S3 bucket.\n

" + } + }, "com.amazonaws.bedrockagentruntime#S3ObjectDoc": { "type": "structure", "members": { @@ -5884,6 +6816,16 @@ "smithy.api#documentation": "

Contains details of the s3 object where the source file is located.

" } }, + "com.amazonaws.bedrockagentruntime#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + } + }, "com.amazonaws.bedrockagentruntime#S3Uri": { "type": "string", "traits": { @@ -5987,6 +6929,15 @@ "smithy.api#documentation": "

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.

" } }, + "com.amazonaws.bedrockagentruntime#SessionTTL": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, "com.amazonaws.bedrockagentruntime#Source": { "type": "enum", "members": { @@ -6240,6 +7191,18 @@ "com.amazonaws.bedrockagentruntime#TracePart": { "type": "structure", "members": { + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the session with the agent.

" + } + }, + "trace": { + "target": "com.amazonaws.bedrockagentruntime#Trace", + "traits": { + "smithy.api#documentation": "

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

" + } + }, "agentId": { "target": "com.amazonaws.bedrockagentruntime#AgentId", "traits": { @@ -6252,23 +7215,11 @@ "smithy.api#documentation": "

The unique identifier of the alias of the agent.

" } }, - "sessionId": { - "target": "com.amazonaws.bedrockagentruntime#SessionId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the session with the agent.

" - } - }, "agentVersion": { "target": "com.amazonaws.bedrockagentruntime#AgentVersion", "traits": { "smithy.api#documentation": "

The version of the agent.

" } - }, - "trace": { - "target": "com.amazonaws.bedrockagentruntime#Trace", - "traits": { - "smithy.api#documentation": "

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/chatbot.json b/codegen/sdk-codegen/aws-models/chatbot.json index 6b634fabe6d..ab9d3deb099 100644 --- a/codegen/sdk-codegen/aws-models/chatbot.json +++ b/codegen/sdk-codegen/aws-models/chatbot.json @@ -41,6 +41,105 @@ "smithy.api#pattern": "^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" } }, + "com.amazonaws.chatbot#AssociateToConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#AssociateToConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#AssociateToConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InternalServiceError" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#UnauthorizedException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to associate a resource with a configuration", + "resources": { + "required": { + "ChatbotConfiguration": {}, + "custom-action": {} + } + } + }, + "smithy.api#documentation": "

Links a resource (for example, a custom action) to a channel configuration.

", + "smithy.api#examples": [ + { + "title": "Associate a custom action to a configuration", + "documentation": "Associate a custom action to a channel configuration, allowing it to be used in that channel", + "input": { + "Resource": "arn:aws:chatbot::1234567890:custom-action/my-custom-action", + "ChatConfiguration": "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel" + }, + "output": {} + } + ], + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/associate-to-configuration" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.chatbot#AssociateToConfigurationRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.chatbot#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "

The resource Amazon Resource Name (ARN) to link.

", + "smithy.api#required": {} + } + }, + "ChatConfiguration": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "

The channel configuration to associate with the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#AssociateToConfigurationResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#AssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#AssociationListing" + } + }, + "com.amazonaws.chatbot#AssociationListing": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource (for example, a custom action).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A listing of an association with a channel configuration.

" + } + }, "com.amazonaws.chatbot#AwsUserIdentity": { "type": "string", "traits": { @@ -77,7 +176,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration.

", "smithy.api#required": {} } }, @@ -157,6 +256,16 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chatbot#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 33, + "max": 126 + }, + "smithy.api#pattern": "^[\\x21-\\x7F]+$" + } + }, "com.amazonaws.chatbot#ConfigurationName": { "type": "string", "traits": { @@ -252,6 +361,12 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create an AWS Chatbot Chime Webhook Configuration", + "createsResources": [ + "ChatbotConfiguration" + ] + }, "smithy.api#documentation": "

Creates an AWS Chatbot configuration for Amazon Chime.

", "smithy.api#http": { "method": "POST", @@ -342,6 +457,142 @@ "smithy.api#output": {} } }, + "com.amazonaws.chatbot#CreateCustomAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#CreateCustomActionRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#CreateCustomActionResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#ConflictException" + }, + { + "target": "com.amazonaws.chatbot#InternalServiceError" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#LimitExceededException" + }, + { + "target": "com.amazonaws.chatbot#UnauthorizedException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create a custom action" + }, + "smithy.api#documentation": "

Creates a custom action that can be invoked as an alias or as a button on a notification.

", + "smithy.api#examples": [ + { + "title": "Create an alias that invokes a Lambda function", + "documentation": "Creates an alias that invokes a Lambda function from chat channels. You can use this alias by entering 'run invoke', after which you're prompted for the function name.", + "input": { + "ActionName": "my-custom-action", + "Definition": { + "CommandText": "lambda invoke $functionName" + }, + "AliasName": "invoke" + }, + "output": { + "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" + } + }, + { + "title": "Create a custom action to list alarms", + "documentation": "Creates a button on all Cloudwatch notifications that lists alarms in the ‘ALARM’ state.", + "input": { + "ActionName": "describe-alarms", + "Definition": { + "CommandText": "cloudwatch describe-alarms --state-value ALARM" + }, + "Attachments": [ + { + "NotificationType": "CloudWatch", + "ButtonText": "List alarms" + } + ] + }, + "output": { + "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/describe-alarms" + } + } + ], + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/create-custom-action" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.chatbot#CreateCustomActionRequest": { + "type": "structure", + "members": { + "Definition": { + "target": "com.amazonaws.chatbot#CustomActionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the command to run when invoked as an alias or as an action button.

", + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.chatbot#CustomActionAliasName", + "traits": { + "smithy.api#documentation": "

The name used to invoke this action in a chat channel. For example, @aws run my-alias.

" + } + }, + "Attachments": { + "target": "com.amazonaws.chatbot#CustomActionAttachmentList", + "traits": { + "smithy.api#documentation": "

Defines when this custom action button should be attached to a notification.

" + } + }, + "Tags": { + "target": "com.amazonaws.chatbot#TagList", + "traits": { + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.chatbot#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the SDK.

", + "smithy.api#idempotencyToken": {} + } + }, + "ActionName": { + "target": "com.amazonaws.chatbot#CustomActionName", + "traits": { + "smithy.api#documentation": "

The name of the custom action. This name is included in the Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#CreateCustomActionResult": { + "type": "structure", + "members": { + "CustomActionArn": { + "target": "com.amazonaws.chatbot#CustomActionArn", + "traits": { + "smithy.api#documentation": "

The fully defined ARN of the custom action.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CustomActionArn" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.chatbot#CreateMicrosoftTeamsChannelConfiguration": { "type": "operation", "input": { @@ -368,6 +619,12 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create an AWS Chatbot Microsoft Teams Channel Configuration", + "createsResources": [ + "ChatbotConfiguration" + ] + }, "smithy.api#documentation": "

Creates an AWS Chatbot configuration for Microsoft Teams.

", "smithy.api#http": { "method": "POST", @@ -406,6 +663,12 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create an AWS Chatbot Slack Channel Configuration", + "createsResources": [ + "ChatbotConfiguration" + ] + }, "smithy.api#documentation": "

Creates an AWS Chatbot confugration for Slack.

", "smithy.api#http": { "method": "POST", @@ -625,6 +888,313 @@ "smithy.api#output": {} } }, + "com.amazonaws.chatbot#CustomAction": { + "type": "structure", + "members": { + "CustomActionArn": { + "target": "com.amazonaws.chatbot#CustomActionArn", + "traits": { + "smithy.api#documentation": "

The fully defined Amazon Resource Name (ARN) of the custom action.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CustomActionArn" + } + }, + "Definition": { + "target": "com.amazonaws.chatbot#CustomActionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the command to run when invoked an alias or as an action button.

", + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.chatbot#CustomActionAliasName", + "traits": { + "smithy.api#documentation": "

The name used to invoke this action in the chat channel. For example, @aws run my-alias.

" + } + }, + "Attachments": { + "target": "com.amazonaws.chatbot#CustomActionAttachmentList", + "traits": { + "smithy.api#documentation": "

Defines when this custom action button should be attached to a notification.

" + } + }, + "ActionName": { + "target": "com.amazonaws.chatbot#CustomActionName", + "traits": { + "smithy.api#documentation": "

The name of the custom action that is included in the ARN.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a parameterized command that can be invoked as an alias or as a notification button in the chat client.

" + } + }, + "com.amazonaws.chatbot#CustomActionAliasName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_]+$" + } + }, + "com.amazonaws.chatbot#CustomActionArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::Chatbot::CustomAction", + "service": "com.amazonaws.chatbot#WheatleyOrchestration_20171011", + "resource": "com.amazonaws.chatbot#CustomActionResource" + }, + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$" + } + }, + "com.amazonaws.chatbot#CustomActionArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#CustomActionArn" + } + }, + "com.amazonaws.chatbot#CustomActionAttachment": { + "type": "structure", + "members": { + "NotificationType": { + "target": "com.amazonaws.chatbot#CustomActionAttachmentNotificationType", + "traits": { + "smithy.api#documentation": "

The type of notification that the custom action should be attached to.

" + } + }, + "ButtonText": { + "target": "com.amazonaws.chatbot#CustomActionButtonText", + "traits": { + "smithy.api#documentation": "

The text of the button that appears on the notification.

" + } + }, + "Criteria": { + "target": "com.amazonaws.chatbot#CustomActionAttachmentCriteriaList", + "traits": { + "smithy.api#documentation": "

The criteria for when a button should be shown based on values in the notification.

" + } + }, + "Variables": { + "target": "com.amazonaws.chatbot#CustomActionAttachmentVariables", + "traits": { + "smithy.api#documentation": "

The variables to extract from the notification.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines when a custom action button should be attached to a notification.

" + } + }, + "com.amazonaws.chatbot#CustomActionAttachmentCriteria": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.chatbot#CustomActionAttachmentCriteriaOperator", + "traits": { + "smithy.api#documentation": "

The operation to perform on the named variable.

", + "smithy.api#required": {} + } + }, + "VariableName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the variable to operate on.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_]+$", + "smithy.api#required": {} + } + }, + "Value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A value that is compared with the actual value of the variable based on the behavior of the operator.

", + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + } + }, + "traits": { + "smithy.api#documentation": "

A criteria for when a button should be shown based on values in the notification

" + } + }, + "com.amazonaws.chatbot#CustomActionAttachmentCriteriaList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#CustomActionAttachmentCriteria" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.chatbot#CustomActionAttachmentCriteriaOperator": { + "type": "enum", + "members": { + "HAS_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HAS_VALUE" + } + }, + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + } + } + }, + "com.amazonaws.chatbot#CustomActionAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#CustomActionAttachment" + } + }, + "com.amazonaws.chatbot#CustomActionAttachmentNotificationType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.chatbot#CustomActionAttachmentVariables": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_]+$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\x21-\\x7F]+$" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.chatbot#CustomActionButtonText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.chatbot#CustomActionDefinition": { + "type": "structure", + "members": { + "CommandText": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The command string to run which may include variables by prefixing with a dollar sign ($).

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\S\\s]+$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of the command to run when invoked as an alias or as an action button.

" + } + }, + "com.amazonaws.chatbot#CustomActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,64}$" + } + }, + "com.amazonaws.chatbot#CustomActionResource": { + "type": "resource", + "identifiers": { + "CustomActionArn": { + "target": "com.amazonaws.chatbot#CustomActionArn" + } + }, + "properties": { + "ActionName": { + "target": "com.amazonaws.chatbot#CustomActionName" + }, + "Definition": { + "target": "com.amazonaws.chatbot#CustomActionDefinition" + }, + "AliasName": { + "target": "com.amazonaws.chatbot#CustomActionAliasName" + }, + "Attachments": { + "target": "com.amazonaws.chatbot#CustomActionAttachmentList" + }, + "Tags": { + "target": "com.amazonaws.chatbot#TagList" + } + }, + "create": { + "target": "com.amazonaws.chatbot#CreateCustomAction" + }, + "read": { + "target": "com.amazonaws.chatbot#GetCustomAction" + }, + "update": { + "target": "com.amazonaws.chatbot#UpdateCustomAction" + }, + "delete": { + "target": "com.amazonaws.chatbot#DeleteCustomAction" + }, + "list": { + "target": "com.amazonaws.chatbot#ListCustomActions" + }, + "traits": { + "aws.api#arn": { + "template": "{CustomActionArn}", + "absolute": true + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "custom-action", + "relativeDocumentation": "what-is.html" + } + } + }, "com.amazonaws.chatbot#CustomerCwLogLevel": { "type": "string", "traits": { @@ -658,6 +1228,14 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Chatbot Chime Webhook Configuration", + "resources": { + "required": { + "ChatbotConfiguration": {} + } + } + }, "smithy.api#documentation": "

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

", "smithy.api#http": { "method": "POST", @@ -701,6 +1279,73 @@ "smithy.api#output": {} } }, + "com.amazonaws.chatbot#DeleteCustomAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DeleteCustomActionRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DeleteCustomActionResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InternalServiceError" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.chatbot#UnauthorizedException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a custom action" + }, + "smithy.api#documentation": "

Deletes a custom action.

", + "smithy.api#examples": [ + { + "title": "Delete a custom action", + "input": { + "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" + }, + "output": {} + } + ], + "smithy.api#http": { + "code": 204, + "method": "POST", + "uri": "/delete-custom-action" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.chatbot#DeleteCustomActionRequest": { + "type": "structure", + "members": { + "CustomActionArn": { + "target": "com.amazonaws.chatbot#CustomActionArn", + "traits": { + "smithy.api#documentation": "

The fully defined ARN of the custom action.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CustomActionArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DeleteCustomActionResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.chatbot#DeleteMicrosoftTeamsChannelConfiguration": { "type": "operation", "input": { @@ -724,6 +1369,14 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Chatbot Microsoft Teams Channel Configuration", + "resources": { + "required": { + "ChatbotConfiguration": {} + } + } + }, "smithy.api#documentation": "

Deletes a Microsoft Teams channel configuration for AWS Chatbot

", "smithy.api#http": { "method": "POST", @@ -753,6 +1406,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete the Microsoft Teams configured with AWS Chatbot in an AWS account" + }, "smithy.api#documentation": "

Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.\n

", "smithy.api#http": { "method": "POST", @@ -785,6 +1441,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Chatbot Microsoft Teams User Identity" + }, "smithy.api#documentation": "

Identifes a user level permission for a channel configuration.

", "smithy.api#http": { "method": "POST", @@ -858,6 +1517,14 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Chatbot Slack Channel Configuration", + "resources": { + "required": { + "ChatbotConfiguration": {} + } + } + }, "smithy.api#documentation": "

Deletes a Slack channel configuration for AWS Chatbot

", "smithy.api#http": { "method": "POST", @@ -921,6 +1588,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Chatbot Slack User Identity" + }, "smithy.api#documentation": "

Deletes a user level permission for a Slack channel configuration.

", "smithy.api#http": { "method": "POST", @@ -995,6 +1665,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete the Slack workspace authorization with AWS Chatbot, associated with an AWS account" + }, "smithy.api#documentation": "

Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.\n

", "smithy.api#http": { "method": "POST", @@ -1128,6 +1801,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list all AWS Chatbot Chime Webhook Configurations in an AWS Account" + }, "smithy.api#documentation": "

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

", "smithy.api#http": { "method": "POST", @@ -1174,7 +1850,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

An optional Amazon Resource Number (ARN) of a ChimeWebhookConfiguration to describe.

" + "smithy.api#documentation": "

An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration to describe.

" } } }, @@ -1222,6 +1898,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list all AWS Chatbot Slack Channel Configurations in an AWS account" + }, "smithy.api#documentation": "

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

", "smithy.api#http": { "method": "POST", @@ -1268,7 +1947,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

An optional Amazon Resource Number (ARN) of a SlackChannelConfiguration to describe.

" + "smithy.api#documentation": "

An optional Amazon Resource Name (ARN) of a SlackChannelConfiguration to describe.

" } } }, @@ -1316,6 +1995,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to describe AWS Chatbot Slack User Identities" + }, "smithy.api#documentation": "

Lists all Slack user identities with a mapped role.

", "smithy.api#http": { "method": "POST", @@ -1350,7 +2032,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identities to describe.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identities to describe.

" } }, "NextToken": { @@ -1410,6 +2092,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot service" + }, "smithy.api#documentation": "

List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.

", "smithy.api#http": { "method": "POST", @@ -1478,6 +2163,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.chatbot#DisassociateFromConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DisassociateFromConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DisassociateFromConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InternalServiceError" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#UnauthorizedException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to disassociate a resource from a configuration", + "resources": { + "required": { + "ChatbotConfiguration": {}, + "custom-action": {} + } + } + }, + "smithy.api#documentation": "

Unlink a resource, for example a custom action, from a channel configuration.

", + "smithy.api#examples": [ + { + "title": "Disassociate a custom action from a configuration", + "input": { + "Resource": "arn:aws:chatbot::1234567890:custom-action/my-custom-action", + "ChatConfiguration": "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel" + }, + "output": {} + } + ], + "smithy.api#http": { + "code": 204, + "method": "POST", + "uri": "/disassociate-from-configuration" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.chatbot#DisassociateFromConfigurationRequest": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.chatbot#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "

The resource (for example, a custom action) Amazon Resource Name (ARN) to unlink.

", + "smithy.api#required": {} + } + }, + "ChatConfiguration": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "

The channel configuration the resource is being disassociated from.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DisassociateFromConfigurationResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.chatbot#ErrorMessage": { "type": "string" }, @@ -1498,42 +2260,128 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve AWS Chatbot account preferences" + }, "smithy.api#documentation": "

Returns AWS Chatbot account preferences.

", "smithy.api#http": { "method": "POST", - "uri": "/get-account-preferences", - "code": 200 + "uri": "/get-account-preferences", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.chatbot#GetAccountPreferencesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#GetAccountPreferencesRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#GetAccountPreferencesResult": { + "type": "structure", + "members": { + "AccountPreferences": { + "target": "com.amazonaws.chatbot#AccountPreferences", + "traits": { + "smithy.api#documentation": "

The preferences related to AWS Chatbot usage in the calling AWS account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#GetCustomAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#GetCustomActionRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#GetCustomActionResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InternalServiceError" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.chatbot#UnauthorizedException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get a custom action" + }, + "smithy.api#documentation": "

Returns a custom action.

", + "smithy.api#examples": [ + { + "title": "Get a custom action", + "input": { + "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" + }, + "output": { + "CustomAction": { + "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action", + "ActionName": "my-custom-action", + "Definition": { + "CommandText": "lambda invoke $functionName" + } + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-custom-action" }, "smithy.api#readonly": {} } }, - "com.amazonaws.chatbot#GetAccountPreferencesException": { + "com.amazonaws.chatbot#GetCustomActionRequest": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.chatbot#ErrorMessage" + "CustomActionArn": { + "target": "com.amazonaws.chatbot#CustomActionArn", + "traits": { + "smithy.api#documentation": "

Returns the fully defined Amazon Resource Name (ARN) of the custom action.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CustomActionArn" + } } }, - "traits": { - "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.chatbot#GetAccountPreferencesRequest": { - "type": "structure", - "members": {}, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.chatbot#GetAccountPreferencesResult": { + "com.amazonaws.chatbot#GetCustomActionResult": { "type": "structure", "members": { - "AccountPreferences": { - "target": "com.amazonaws.chatbot#AccountPreferences", + "CustomAction": { + "target": "com.amazonaws.chatbot#CustomAction", "traits": { - "smithy.api#documentation": "

The preferences related to AWS Chatbot usage in the calling AWS account.

" + "smithy.api#documentation": "

Returns the custom action.

", + "smithy.api#nestedProperties": {} } } }, @@ -1561,6 +2409,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get a single AWS Chatbot Microsoft Teams Channel Configurations in an AWS account" + }, "smithy.api#documentation": "

Returns a Microsoft Teams channel configuration in an AWS account.

", "smithy.api#http": { "method": "POST", @@ -1593,7 +2444,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.

", "smithy.api#required": {} } } @@ -1684,6 +2535,219 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.chatbot#ListAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#ListAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#ListAssociationsResult" + }, + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list resources associated with a configuration", + "resources": { + "required": { + "ChatbotConfiguration": {} + } + } + }, + "smithy.api#documentation": "

Lists resources associated with a channel configuration.

", + "smithy.api#examples": [ + { + "title": "List custom actions associated with a configuration", + "input": { + "ChatConfiguration": "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel" + }, + "output": { + "Associations": [ + { + "Resource": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-associations" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Associations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.chatbot#ListAssociationsRequest": { + "type": "structure", + "members": { + "ChatConfiguration": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "

The channel configuration to list associations for.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#String", + "traits": { + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\x20-\\x7F]+$" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#ListAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.chatbot#AssociationList", + "traits": { + "smithy.api#documentation": "

The resources associated with this channel configuration.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#String", + "traits": { + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\x20-\\x7F]+$" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#ListCustomActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#ListCustomActionsRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#ListCustomActionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InternalServiceError" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#UnauthorizedException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list custom actions" + }, + "smithy.api#documentation": "

Lists custom actions defined in this account.

", + "smithy.api#examples": [ + { + "title": "List custom actions", + "input": {}, + "output": { + "CustomActions": [ + "arn:aws:chatbot::1234567890:custom-action/my-custom-action" + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-custom-actions" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "CustomActions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.chatbot#ListCustomActionsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\x20-\\x7F]+$" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#ListCustomActionsResult": { + "type": "structure", + "members": { + "CustomActions": { + "target": "com.amazonaws.chatbot#CustomActionArnList", + "traits": { + "smithy.api#documentation": "

A list of custom actions.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\x20-\\x7F]+$" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.chatbot#ListMicrosoftTeamsChannelConfigurations": { "type": "operation", "input": { @@ -1704,6 +2768,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list all AWS Chatbot Microsoft Teams Channel Configurations in an AWS account" + }, "smithy.api#documentation": "

Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.

", "smithy.api#http": { "method": "POST", @@ -1743,6 +2810,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list all Microsoft Teams connected to the AWS Account onboarded with AWS Chatbot service" + }, "smithy.api#documentation": "

Lists all authorized Microsoft Teams for an AWS Account

", "smithy.api#http": { "method": "POST", @@ -1831,6 +2901,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to describe AWS Chatbot Microsoft Teams User Identities" + }, "smithy.api#documentation": "

A list all Microsoft Teams user identities with a mapped role.

", "smithy.api#http": { "method": "POST", @@ -1865,7 +2938,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.

" } }, "NextToken": { @@ -1925,6 +2998,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to List all tags associated with the AWS Chatbot Channel Configuration" + }, "smithy.api#documentation": "

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

", "smithy.api#http": { "method": "POST", @@ -1940,7 +3016,7 @@ "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN you specified to list the tags of.

", + "smithy.api#documentation": "

The ARN of the resource to list tags for.

", "smithy.api#required": {} } } @@ -2041,6 +3117,16 @@ "smithy.api#pattern": "^[a-zA-Z0-9=\\/+_.\\-,#:\\\\\"{}]{4,1276}$" } }, + "com.amazonaws.chatbot#ResourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$" + } + }, "com.amazonaws.chatbot#ResourceNotFoundException": { "type": "structure", "members": { @@ -2107,7 +3193,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SlackChannelConfiguration.

", "smithy.api#required": {} } }, @@ -2246,7 +3332,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identity to delete.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SlackChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, @@ -2361,6 +3447,7 @@ "target": "com.amazonaws.chatbot#TagKey" }, "traits": { + "aws.api#data": "tagging", "smithy.api#length": { "min": 0, "max": 200 @@ -2402,6 +3489,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create tags on AWS Chatbot Channel Configuration" + }, "smithy.api#documentation": "

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

", "smithy.api#http": { "method": "POST", @@ -2423,6 +3513,7 @@ "Tags": { "target": "com.amazonaws.chatbot#TagList", "traits": { + "aws.api#data": "tagging", "smithy.api#documentation": "

A list of tags to apply to the configuration.

", "smithy.api#required": {} } @@ -2678,6 +3769,19 @@ "smithy.api#pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$" } }, + "com.amazonaws.chatbot#UnauthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because it doesn't have valid credentials for the target resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.chatbot#UntagResource": { "type": "operation", "input": { @@ -2698,6 +3802,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to remove tags on AWS Chatbot Channel Configuration" + }, "smithy.api#documentation": "

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

", "smithy.api#http": { "method": "POST", @@ -2719,6 +3826,7 @@ "TagKeys": { "target": "com.amazonaws.chatbot#TagKeyList", "traits": { + "aws.api#data": "tagging", "smithy.api#documentation": "

TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

", "smithy.api#required": {} } @@ -2755,6 +3863,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update AWS Chatbot account preferences" + }, "smithy.api#documentation": "

Updates AWS Chatbot account preferences.

", "smithy.api#http": { "method": "POST", @@ -2833,6 +3944,14 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update an AWS Chatbot Chime Webhook Configuration", + "resources": { + "required": { + "ChatbotConfiguration": {} + } + } + }, "smithy.api#documentation": "

Updates a Amazon Chime webhook configuration.

", "smithy.api#http": { "method": "POST", @@ -2860,7 +3979,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to update.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to update.

", "smithy.api#required": {} } }, @@ -2913,6 +4032,106 @@ "smithy.api#output": {} } }, + "com.amazonaws.chatbot#UpdateCustomAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#UpdateCustomActionRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#UpdateCustomActionResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InternalServiceError" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.chatbot#UnauthorizedException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update a custom action" + }, + "smithy.api#documentation": "

Updates a custom action.

", + "smithy.api#examples": [ + { + "title": "Update the command definition of an existing action", + "documentation": "Updates the command text of a custom action without altering the existing alias name or attachment criteria", + "input": { + "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action", + "Definition": { + "CommandText": "lambda invoke MyNewFunction" + } + }, + "output": { + "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/update-custom-action" + } + } + }, + "com.amazonaws.chatbot#UpdateCustomActionRequest": { + "type": "structure", + "members": { + "CustomActionArn": { + "target": "com.amazonaws.chatbot#CustomActionArn", + "traits": { + "smithy.api#documentation": "

The fully defined Amazon Resource Name (ARN) of the custom action.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CustomActionArn" + } + }, + "Definition": { + "target": "com.amazonaws.chatbot#CustomActionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the command to run when invoked as an alias or as an action button.

", + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.chatbot#CustomActionAliasName", + "traits": { + "smithy.api#documentation": "

The name used to invoke this action in the chat channel. For example, @aws run my-alias.

" + } + }, + "Attachments": { + "target": "com.amazonaws.chatbot#CustomActionAttachmentList", + "traits": { + "smithy.api#documentation": "

Defines when this custom action button should be attached to a notification.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#UpdateCustomActionResult": { + "type": "structure", + "members": { + "CustomActionArn": { + "target": "com.amazonaws.chatbot#CustomActionArn", + "traits": { + "smithy.api#documentation": "

The fully defined ARN of the custom action.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CustomActionArn" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.chatbot#UpdateMicrosoftTeamsChannelConfiguration": { "type": "operation", "input": { @@ -2936,6 +4155,14 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update an AWS Chatbot Microsoft Teams Channel Configuration", + "resources": { + "required": { + "ChatbotConfiguration": {} + } + } + }, "smithy.api#documentation": "

Updates an Microsoft Teams channel configuration.

", "smithy.api#http": { "method": "POST", @@ -2971,6 +4198,14 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update an AWS Chatbot Slack Channel Configuration", + "resources": { + "required": { + "ChatbotConfiguration": {} + } + } + }, "smithy.api#documentation": "

Updates a Slack channel configuration.

", "smithy.api#http": { "method": "POST", @@ -2998,7 +4233,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration to update.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SlackChannelConfiguration to update.

", "smithy.api#required": {} } }, @@ -3083,7 +4318,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to update.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the TeamsChannelConfiguration to update.

", "smithy.api#required": {} } }, @@ -3153,6 +4388,9 @@ "type": "service", "version": "2017-10-11", "operations": [ + { + "target": "com.amazonaws.chatbot#AssociateToConfiguration" + }, { "target": "com.amazonaws.chatbot#CreateChimeWebhookConfiguration" }, @@ -3195,12 +4433,18 @@ { "target": "com.amazonaws.chatbot#DescribeSlackWorkspaces" }, + { + "target": "com.amazonaws.chatbot#DisassociateFromConfiguration" + }, { "target": "com.amazonaws.chatbot#GetAccountPreferences" }, { "target": "com.amazonaws.chatbot#GetMicrosoftTeamsChannelConfiguration" }, + { + "target": "com.amazonaws.chatbot#ListAssociations" + }, { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsChannelConfigurations" }, @@ -3232,6 +4476,11 @@ "target": "com.amazonaws.chatbot#UpdateSlackChannelConfiguration" } ], + "resources": [ + { + "target": "com.amazonaws.chatbot#CustomActionResource" + } + ], "traits": { "aws.api#service": { "sdkId": "chatbot", @@ -3243,6 +4492,12 @@ "aws.auth#sigv4": { "name": "chatbot" }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], "aws.protocols#restJson1": {}, "smithy.api#auth": [ "aws.auth#sigv4" diff --git a/codegen/sdk-codegen/aws-models/codepipeline.json b/codegen/sdk-codegen/aws-models/codepipeline.json index b82aaef79fe..2181eea8e1c 100644 --- a/codegen/sdk-codegen/aws-models/codepipeline.json +++ b/codegen/sdk-codegen/aws-models/codepipeline.json @@ -567,6 +567,12 @@ "traits": { "smithy.api#documentation": "

The details of an error returned by a URL external to Amazon Web Services.

" } + }, + "logStreamARN": { + "target": "com.amazonaws.codepipeline#LogStreamARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log stream for the action compute.

" + } } }, "traits": { @@ -772,6 +778,12 @@ }, "errorDetails": { "target": "com.amazonaws.codepipeline#ErrorDetails" + }, + "logStreamARN": { + "target": "com.amazonaws.codepipeline#LogStreamARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log stream for the action compute.

" + } } }, "traits": { @@ -5834,6 +5846,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.codepipeline#LogStreamARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + } + } + }, "com.amazonaws.codepipeline#MatchEquals": { "type": "string", "traits": { @@ -7130,7 +7151,7 @@ "token": { "target": "com.amazonaws.codepipeline#ApprovalToken", "traits": { - "smithy.api#documentation": "

The system-generated token used to identify a unique approval request. The token\n for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval\n request corresponding to this token is still valid.

", + "smithy.api#documentation": "

The system-generated token used to identify a unique approval request. The token\n for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval\n request corresponding to this token is still valid.

\n \n

For a pipeline where the execution mode is set to PARALLEL, the token required to\n approve/reject approval request as detailed above is not available. Instead, use the\n externalExecutionId from the GetPipelineState action\n as the token in the approval request.

\n ", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/cognito-identity-provider.json b/codegen/sdk-codegen/aws-models/cognito-identity-provider.json index ebcc9143f37..bcbe261af93 100644 --- a/codegen/sdk-codegen/aws-models/cognito-identity-provider.json +++ b/codegen/sdk-codegen/aws-models/cognito-identity-provider.json @@ -130,6 +130,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#ChangePassword" }, + { + "target": "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistration" + }, { "target": "com.amazonaws.cognitoidentityprovider#ConfirmDevice" }, @@ -145,6 +148,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#CreateIdentityProvider" }, + { + "target": "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBranding" + }, { "target": "com.amazonaws.cognitoidentityprovider#CreateResourceServer" }, @@ -166,6 +172,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#DeleteIdentityProvider" }, + { + "target": "com.amazonaws.cognitoidentityprovider#DeleteManagedLoginBranding" + }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteResourceServer" }, @@ -184,9 +193,18 @@ { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolDomain" }, + { + "target": "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredential" + }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeIdentityProvider" }, + { + "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBranding" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClient" + }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeResourceServer" }, @@ -238,6 +256,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#GetUserAttributeVerificationCode" }, + { + "target": "com.amazonaws.cognitoidentityprovider#GetUserAuthFactors" + }, { "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfig" }, @@ -277,6 +298,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#ListUsersInGroup" }, + { + "target": "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentials" + }, { "target": "com.amazonaws.cognitoidentityprovider#ResendConfirmationCode" }, @@ -310,6 +334,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#StartUserImportJob" }, + { + "target": "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistration" + }, { "target": "com.amazonaws.cognitoidentityprovider#StopUserImportJob" }, @@ -331,6 +358,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#UpdateIdentityProvider" }, + { + "target": "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBranding" + }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateResourceServer" }, @@ -1289,12 +1319,12 @@ "RecoveryMechanisms": { "target": "com.amazonaws.cognitoidentityprovider#RecoveryMechanismsType", "traits": { - "smithy.api#documentation": "

The list of RecoveryOptionTypes.

" + "smithy.api#documentation": "

The list of options and priorities for user message delivery in forgot-password\n operations. Sets or displays user pool preferences for email or SMS message priority,\n whether users should fall back to a second delivery method, and whether passwords should\n only be reset by administrators.

" } } }, "traits": { - "smithy.api#documentation": "

The data type for AccountRecoverySetting.

" + "smithy.api#documentation": "

The settings for user message delivery in forgot-password operations. Contains\n preference for email or SMS message delivery of password reset codes, or for admin-only\n password reset.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionNotifyType": { @@ -1310,20 +1340,20 @@ "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionNotifyType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Flag specifying whether to send a notification.

", + "smithy.api#documentation": "

Determines whether Amazon Cognito sends a user a notification message when your user pools\n assesses a user's session at the associated risk level.

", "smithy.api#required": {} } }, "EventAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverEventActionType", "traits": { - "smithy.api#documentation": "

The action to take in response to the account takeover action. Valid values are as\n follows:

\n ", + "smithy.api#documentation": "

The action to take for the attempted account takeover action for the associated risk\n level. Valid values are as follows:

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Account takeover action type.

" + "smithy.api#documentation": "

The automated response to a risk level for adaptive authentication in full-function,\n or ENFORCED, mode. You can assign an action to each risk level that\n advanced security features evaluates.

\n

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionsType": { @@ -1332,24 +1362,24 @@ "LowAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionType", "traits": { - "smithy.api#documentation": "

Action to take for a low risk.

" + "smithy.api#documentation": "

The action that you assign to a low-risk assessment by advanced security\n features.

" } }, "MediumAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionType", "traits": { - "smithy.api#documentation": "

Action to take for a medium risk.

" + "smithy.api#documentation": "

The action that you assign to a medium-risk assessment by advanced security\n features.

" } }, "HighAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionType", "traits": { - "smithy.api#documentation": "

Action to take for a high risk.

" + "smithy.api#documentation": "

The action that you assign to a high-risk assessment by advanced security\n features.

" } } }, "traits": { - "smithy.api#documentation": "

Account takeover actions type.

" + "smithy.api#documentation": "

A list of account-takeover actions for each level of risk that Amazon Cognito might assess with\n advanced security features.

\n

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#AccountTakeoverEventActionType": { @@ -1387,19 +1417,19 @@ "NotifyConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#NotifyConfigurationType", "traits": { - "smithy.api#documentation": "

The notify configuration used to construct email notifications.

" + "smithy.api#documentation": "

The settings for composing and sending an email message when advanced security\n features assesses a risk level with adaptive authentication. When you choose to notify\n users in AccountTakeoverRiskConfiguration, Amazon Cognito sends an email message\n using the method and template that you set with this data type.

" } }, "Actions": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionsType", "traits": { - "smithy.api#documentation": "

Account takeover risk configuration actions.

", + "smithy.api#documentation": "

A list of account-takeover actions for each level of risk that Amazon Cognito might assess with\n advanced security features.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Configuration for mitigation actions and notification for different levels of risk\n detected for a potential account takeover.

" + "smithy.api#documentation": "

The settings for automated responses and notification templates for adaptive\n authentication with advanced security features.

\n

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#AddCustomAttributes": { @@ -1669,7 +1699,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new user in the specified user pool.

\n

If MessageAction isn't set, the default is to send a welcome message via\n email or phone (SMS).

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

This message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.

\n

Alternatively, you can call AdminCreateUser with SUPPRESS\n for the MessageAction parameter, and Amazon Cognito won't send any email.

\n

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until\n they sign in and change their password.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", + "smithy.api#documentation": "

Creates a new user in the specified user pool.

\n

If MessageAction isn't set, the default is to send a welcome message via\n email or phone (SMS).

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

This message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.

\n

Alternatively, you can call AdminCreateUser with SUPPRESS\n for the MessageAction parameter, and Amazon Cognito won't send any email.

\n

In either case, if the user has a password, they will be in the\n FORCE_CHANGE_PASSWORD state until they sign in and set their password.\n Your invitation message template must have the {####} password placeholder\n if your users have passwords. If your template doesn't have this placeholder, Amazon Cognito\n doesn't deliver the invitation message. In this case, you must update your message\n template and resend the password with a new AdminCreateUser request with a\n MessageAction value of RESEND.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#examples": [ { "title": "An AdminCreateUser request for for a test user named John.", @@ -1735,25 +1765,25 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Set to True if only the administrator is allowed to create user profiles.\n Set to False if users can sign themselves up via an app.

" + "smithy.api#documentation": "

The setting for allowing self-service sign-up. When true, only\n administrators can create new user profiles. When false, users can register\n themselves and create a new user profile with the SignUp operation.

" } }, "UnusedAccountValidityDays": { "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserUnusedAccountValidityDaysType", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The user account expiration limit, in days, after which a new account that hasn't\n signed in is no longer usable. To reset the account after that time limit, you must call\n AdminCreateUser again, specifying \"RESEND\" for the\n MessageAction parameter. The default value for this parameter is\n 7.

\n \n

If you set a value for TemporaryPasswordValidityDays in\n PasswordPolicy, that value will be used, and\n UnusedAccountValidityDays will be no longer be an available\n parameter for that user pool.

\n " + "smithy.api#documentation": "

This parameter is no longer in use. Configure the duration of temporary passwords with\n the TemporaryPasswordValidityDays parameter of PasswordPolicyType. For older user pools that have a\n UnusedAccountValidityDays configuration, that value is effective until\n you set a value for TemporaryPasswordValidityDays.

\n

The password expiration limit in days for administrator-created users. When this time\n expires, the user can't sign in with their temporary password. To reset the account\n after that time limit, you must call AdminCreateUser again, specifying\n RESEND for the MessageAction parameter.

\n

The default value for this parameter is 7.

" } }, "InviteMessageTemplate": { "target": "com.amazonaws.cognitoidentityprovider#MessageTemplateType", "traits": { - "smithy.api#documentation": "

The message template to be used for the welcome message to new users.

\n

See also Customizing User Invitation Messages.

" + "smithy.api#documentation": "

The template for the welcome message to new users. This template must include the\n {####} temporary password placeholder if you are creating users with\n passwords. If your users don't have passwords, you can omit the placeholder.

\n

See also Customizing User Invitation Messages.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration for creating a new user profile.

" + "smithy.api#documentation": "

The settings for administrator creation of users in a user pool. Contains settings for\n allowing user sign-up, customizing invitation messages to new users, and the amount of\n time before temporary passwords expire.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#AdminCreateUserRequest": { @@ -1776,7 +1806,7 @@ "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "

An array of name-value pairs that contain user attributes and attribute values to be\n set for the user to be created. You can create a user without specifying any attributes\n other than Username. However, any attributes that you specify as required\n (when creating a user pool or in the Attributes tab of\n the console) either you should supply (in your call to AdminCreateUser) or\n the user should supply (when they sign up in response to your welcome message).

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

To send a message inviting the user to sign up, you must specify the user's email\n address or phone number. You can do this in your call to AdminCreateUser or in the\n Users tab of the Amazon Cognito console for managing your\n user pools.

\n

In your call to AdminCreateUser, you can set the\n email_verified attribute to True, and you can set the\n phone_number_verified attribute to True. You can also do\n this by calling AdminUpdateUserAttributes.

\n " + "smithy.api#documentation": "

An array of name-value pairs that contain user attributes and attribute values to be\n set for the user to be created. You can create a user without specifying any attributes\n other than Username. However, any attributes that you specify as required\n (when creating a user pool or in the Attributes tab of\n the console) either you should supply (in your call to AdminCreateUser) or\n the user should supply (when they sign up in response to your welcome message).

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

To send a message inviting the user to sign up, you must specify the user's email\n address or phone number. You can do this in your call to AdminCreateUser or in the\n Users tab of the Amazon Cognito console for managing your\n user pools.

\n

You must also provide an email address or phone number when you expect the user to do\n passwordless sign-in with an email or SMS OTP. These attributes must be provided when\n passwordless options are the only available, or when you don't submit a\n TemporaryPassword.

\n

In your call to AdminCreateUser, you can set the\n email_verified attribute to True, and you can set the\n phone_number_verified attribute to True. You can also do\n this by calling AdminUpdateUserAttributes.

\n " } }, "ValidationData": { @@ -1788,7 +1818,7 @@ "TemporaryPassword": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { - "smithy.api#documentation": "

The user's temporary password. This password must conform to the password policy that\n you specified when you created the user pool.

\n

The temporary password is valid only once. To complete the Admin Create User flow, the\n user must enter the temporary password in the sign-in page, along with a new password to\n be used in all future sign-ins.

\n

This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for\n you.

\n

The temporary password can only be used until the user account expiration limit that\n you set for your user pool. To reset the account after that time limit, you must call\n AdminCreateUser again and specify RESEND for the\n MessageAction parameter.

" + "smithy.api#documentation": "

The user's temporary password. This password must conform to the password policy that\n you specified when you created the user pool.

\n

The exception to the requirement for a password is when your user pool supports\n passwordless sign-in with email or SMS OTPs. To create a user with no password, omit\n this parameter or submit a blank value. You can only create a passwordless user when\n passwordless sign-in is available. See the SignInPolicyType property of CreateUserPool and UpdateUserPool.

\n

The temporary password is valid only once. To complete the Admin Create User flow, the\n user must enter the temporary password in the sign-in page, along with a new password to\n be used in all future sign-ins.

\n

If you don't specify a value, Amazon Cognito generates one for you unless you have passwordless\n options active for your user pool.

\n

The temporary password can only be used until the user account expiration limit that\n you set for your user pool. To reset the account after that time limit, you must call\n AdminCreateUser again and specify RESEND for the\n MessageAction parameter.

" } }, "ForceAliasCreation": { @@ -1818,7 +1848,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the request to create a user in the specified user pool.

", + "smithy.api#documentation": "

Creates a new user in the specified user pool.

", "smithy.api#input": {} } }, @@ -2334,7 +2364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the specified user by user name in a user pool as an administrator. Works on any\n user.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + "smithy.api#documentation": "

Gets the specified user by user name in a user pool as an administrator. Works on any\n user. This operation contributes to your monthly active user (MAU) count for the purpose\n of billing.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminGetUserRequest": { @@ -2416,7 +2446,7 @@ "UserMFASettingList": { "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", "traits": { - "smithy.api#documentation": "

The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

" + "smithy.api#documentation": "

The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA, EMAIL_OTP, and\n SOFTWARE_TOKEN_MFA.

" } } }, @@ -2484,7 +2514,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates the authentication flow, as an administrator.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + "smithy.api#documentation": "

Initiates the authentication flow, as an administrator.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminInitiateAuthRequest": { @@ -2507,20 +2537,20 @@ "AuthFlow": { "target": "com.amazonaws.cognitoidentityprovider#AuthFlowType", "traits": { - "smithy.api#documentation": "

The authentication flow for this call to run. The API action will depend on this\n value. For example:

\n \n

Valid values include:

\n ", + "smithy.api#documentation": "

The authentication flow that you want to initiate. The AuthParameters\n that you must submit are linked to the flow that you submit. For example:

\n \n

Valid values include the following:

\n
\n
USER_AUTH
\n
\n

The entry point for sign-in with passwords, one-time passwords, biometric\n devices, and security keys.

\n
\n
USER_SRP_AUTH
\n
\n

Username-password authentication with the Secure Remote Password (SRP)\n protocol. For more information, see Use SRP password verification in custom\n authentication flow.

\n
\n
REFRESH_TOKEN_AUTH and REFRESH_TOKEN
\n
\n

Provide a valid refresh token and receive new ID and access tokens. For\n more information, see Using the refresh token.

\n
\n
CUSTOM_AUTH
\n
\n

Custom authentication with Lambda triggers. For more information, see\n Custom authentication challenge Lambda\n triggers.

\n
\n
ADMIN_USER_PASSWORD_AUTH
\n
\n

Username-password authentication with the password sent directly in the\n request. For more information, see Admin authentication flow.

\n
\n
\n

\n USER_PASSWORD_AUTH is a flow type of InitiateAuth and isn't valid for\n AdminInitiateAuth.

", "smithy.api#required": {} } }, "AuthParameters": { "target": "com.amazonaws.cognitoidentityprovider#AuthParametersType", "traits": { - "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking. The required values depend on the value\n of AuthFlow:

\n \n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" + "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking. The required values depend on the value\n of AuthFlow:

\n \n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that\n are specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:

\n \n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your AdminInitiateAuth request. In your function code in Lambda, you can process the\n validationData value to enhance your workflow for your specific\n needs.

\n

When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for\n the following triggers, but it doesn't provide the ClientMetadata value as input:

\n \n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that\n are specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:

\n \n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your AdminInitiateAuth request. In your function code in Lambda, you can process the\n validationData value to enhance your workflow for your specific\n needs.

\n

When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for\n the following triggers, but it doesn't provide the ClientMetadata value as input:

\n \n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:

\n \n " } }, "AnalyticsMetadata": { @@ -2534,6 +2564,12 @@ "traits": { "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } + }, + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "traits": { + "smithy.api#documentation": "

The optional session ID from a ConfirmSignUp API request. You can sign in\n a user directly from the sign-up process with the USER_AUTH authentication\n flow.

" + } } }, "traits": { @@ -2547,7 +2583,7 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of the challenge that you're responding to with this call. This is returned\n in the AdminInitiateAuth response if you must pass another\n challenge.

\n " + "smithy.api#documentation": "

The name of the challenge that you're responding to with this call. This is returned\n in the AdminInitiateAuth response if you must pass another\n challenge.

\n " } }, "Session": { @@ -2632,7 +2668,7 @@ "SourceUser": { "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { - "smithy.api#documentation": "

An external IdP account for a user who doesn't exist yet in the user pool. This user\n must be a federated user (for example, a SAML or Facebook user), not another native\n user.

\n

If the SourceUser is using a federated social IdP, such as Facebook,\n Google, or Login with Amazon, you must set the ProviderAttributeName to\n Cognito_Subject. For social IdPs, the ProviderName will be\n Facebook, Google, or LoginWithAmazon, and\n Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for\n id, sub, and user_id, respectively. The\n ProviderAttributeValue for the user must be the same value as the\n id, sub, or user_id value found in the social\n IdP token.

\n

\n

For OIDC, the ProviderAttributeName can be any value that matches a claim\n in the ID token, or that your app retrieves from the userInfo endpoint. You\n must map the claim to a user pool attribute in your IdP configuration, and set the user\n pool attribute name as the value of ProviderAttributeName in your\n AdminLinkProviderForUser request.

\n

For SAML, the ProviderAttributeName can be any value that matches a claim\n in the SAML assertion. To link SAML users based on the subject of the SAML assertion,\n map the subject to a claim through the SAML IdP and set that claim name as the value of\n ProviderAttributeName in your AdminLinkProviderForUser\n request.

\n

For both OIDC and SAML users, when you set ProviderAttributeName to\n Cognito_Subject, Amazon Cognito will automatically parse the default unique\n identifier found in the subject from the IdP token.

", + "smithy.api#documentation": "

An external IdP account for a user who doesn't exist yet in the user pool. This user\n must be a federated user (for example, a SAML or Facebook user), not another native\n user.

\n

If the SourceUser is using a federated social IdP, such as Facebook,\n Google, or Login with Amazon, you must set the ProviderAttributeName to\n Cognito_Subject. For social IdPs, the ProviderName will be\n Facebook, Google, or LoginWithAmazon, and\n Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for\n id, sub, and user_id, respectively. The\n ProviderAttributeValue for the user must be the same value as the\n id, sub, or user_id value found in the social\n IdP token.

\n

For OIDC, the ProviderAttributeName can be any mapped value from a claim\n in the ID token, or that your app retrieves from the userInfo endpoint. For\n SAML, the ProviderAttributeName can be any mapped value from a claim in the\n SAML assertion.

\n

The following additional considerations apply to SourceUser for OIDC and\n SAML providers.

\n ", "smithy.api#required": {} } } @@ -2677,7 +2713,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists devices, as an administrator.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + "smithy.api#documentation": "

Lists a user's registered devices.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminListDevicesRequest": { @@ -3034,7 +3070,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resets the specified user's password in a user pool as an administrator. Works on any\n user.

\n

To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Deactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + "smithy.api#documentation": "

Resets the specified user's password in a user pool as an administrator. Works on any\n user.

\n

To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Deactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminResetUserPasswordRequest": { @@ -3151,7 +3187,7 @@ } ], "traits": { - "smithy.api#documentation": "

Some API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. An AdminRespondToAuthChallenge API request provides the answer\n to that challenge, like a code or a secure remote password (SRP). The parameters of a\n response to an authentication challenge vary with the type of challenge.

\n

For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + "smithy.api#documentation": "

Some API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. An AdminRespondToAuthChallenge API request provides the answer\n to that challenge, like a code or a secure remote password (SRP). The parameters of a\n response to an authentication challenge vary with the type of challenge.

\n

For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallengeRequest": { @@ -3181,7 +3217,7 @@ "ChallengeResponses": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", "traits": { - "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret.

\n \n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, \nthen use the UpdateUserAttributes API operation to modify the value of any additional attributes.

\n \n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" + "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.

\n \n
\n
SELECT_CHALLENGE
\n
\n

\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n

\n

Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.

\n

Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:

\n \n

For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.

\n \n
\n
SMS_OTP
\n
\n

\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, \nthen use the UpdateUserAttributes API operation to modify the value of any additional attributes.

\n \n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "Session": { @@ -3684,7 +3720,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Updates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user. To delete an attribute from your user, submit the\n attribute in your API request with a blank value.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + "smithy.api#documentation": "\n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Updates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user. To delete an attribute from your user, submit the\n attribute in your API request with a blank value.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributesRequest": { @@ -3707,7 +3743,7 @@ "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "

An array of name-value pairs representing user attributes.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

If your user pool requires verification before Amazon Cognito updates an attribute value that\n you specify in this request, Amazon Cognito doesn’t immediately update the value of that\n attribute. After your user receives and responds to a verification message to verify the\n new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages\n with the original attribute value until they verify the new value.

\n

To update the value of an attribute that requires verification in the same API\n request, include the email_verified or phone_number_verified\n attribute, with a value of true. If you set the email_verified\n or phone_number_verified value for an email or\n phone_number attribute that requires verification to true,\n Amazon Cognito doesn’t send a verification message to your user.

", + "smithy.api#documentation": "

An array of name-value pairs representing user attributes.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

If your user pool requires verification before Amazon Cognito updates an attribute value that\n you specify in this request, Amazon Cognito doesn’t immediately update the value of that\n attribute. After your user receives and responds to a verification message to verify the\n new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages\n with the original attribute value until they verify the new value.

\n

To skip the verification message and update the value of an attribute that requires\n verification in the same API request, include the email_verified or\n phone_number_verified attribute, with a value of true. If\n you set the email_verified or phone_number_verified value for\n an email or phone_number attribute that requires verification\n to true, Amazon Cognito doesn’t send a verification message to your user.

", "smithy.api#required": {} } }, @@ -3800,7 +3836,7 @@ "CustomAuthMode": { "target": "com.amazonaws.cognitoidentityprovider#AdvancedSecurityEnabledModeType", "traits": { - "smithy.api#documentation": "

The operating mode of advanced security features in custom authentication with \n \n Custom authentication challenge Lambda triggers.\n

" + "smithy.api#documentation": "

The operating mode of advanced security features in custom authentication with Custom\n authentication challenge Lambda triggers.

" } } }, @@ -3893,31 +3929,43 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cognitoidentityprovider#AllowedFirstAuthFactorsListType": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentityprovider#AuthFactorType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType": { "type": "structure", "members": { "ApplicationId": { "target": "com.amazonaws.cognitoidentityprovider#HexStringType", "traits": { - "smithy.api#documentation": "

The application ID for an Amazon Pinpoint application.

" + "smithy.api#documentation": "

Your Amazon Pinpoint project ID.

" } }, "ApplicationArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project\n to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint\n project that the app ARN declares.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to\n your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that\n ApplicationArn declares. You can also configure your application to\n pass an endpoint ID in the AnalyticsMetadata parameter of sign-in\n operations. The endpoint ID is information about the destination for push\n notifications

" } }, "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint\n analytics.

" + "smithy.api#documentation": "

The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish\n events to Amazon Pinpoint analytics.

" } }, "ExternalId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The external ID.

" + "smithy.api#documentation": "

The external ID of the role that Amazon Cognito assumes to send\n analytics data to Amazon Pinpoint.

" } }, "UserDataShared": { @@ -3929,7 +3977,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user\n pool.

\n \n

In Regions where Amazon Pinpoint isn't available, user pools only support sending\n events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user\n pools support sending events to Amazon Pinpoint projects within that same Region.

\n " + "smithy.api#documentation": "

The settings for Amazon Pinpoint analytics configuration. With an analytics configuration,\n your application can collect user-activity metrics for user notifications with a Amazon Pinpoint\n campaign.

\n

Amazon Pinpoint isn't available in all Amazon Web Services Regions. For a list of available Regions, see\n Amazon Cognito and Amazon Pinpoint Region availability.

\n

This data type is a request parameter of CreateUserPoolClient and UpdateUserPoolClient, and a response parameter of\n DescribeUserPoolClient.

" } }, "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType": { @@ -3938,12 +3986,12 @@ "AnalyticsEndpointId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The endpoint ID.

" + "smithy.api#documentation": "

The endpoint ID. Information that you want to pass to Amazon Pinpoint about where to send\n notifications.

" } } }, "traits": { - "smithy.api#documentation": "

An Amazon Pinpoint analytics endpoint.

\n

An endpoint uniquely identifies a mobile device, email address, or phone number that\n can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that\n can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.

" + "smithy.api#documentation": "

Information that your application adds to authentication requests. Applies an endpoint\n ID to the analytics data that your user pool sends to Amazon Pinpoint.

\n

An endpoint ID uniquely identifies a mobile device, email address or phone number that\n can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that\n can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.

\n

This data type is a request parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.

" } }, "com.amazonaws.cognitoidentityprovider#ArnType": { @@ -3956,6 +4004,198 @@ "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?$" } }, + "com.amazonaws.cognitoidentityprovider#AssetBytesType": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000000 + } + } + }, + "com.amazonaws.cognitoidentityprovider#AssetCategoryType": { + "type": "enum", + "members": { + "FAVICON_ICO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAVICON_ICO" + } + }, + "FAVICON_SVG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAVICON_SVG" + } + }, + "EMAIL_GRAPHIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_GRAPHIC" + } + }, + "SMS_GRAPHIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS_GRAPHIC" + } + }, + "AUTH_APP_GRAPHIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTH_APP_GRAPHIC" + } + }, + "PASSWORD_GRAPHIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD_GRAPHIC" + } + }, + "PASSKEY_GRAPHIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSKEY_GRAPHIC" + } + }, + "PAGE_HEADER_LOGO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_HEADER_LOGO" + } + }, + "PAGE_HEADER_BACKGROUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_HEADER_BACKGROUND" + } + }, + "PAGE_FOOTER_LOGO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_FOOTER_LOGO" + } + }, + "PAGE_FOOTER_BACKGROUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_FOOTER_BACKGROUND" + } + }, + "PAGE_BACKGROUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGE_BACKGROUND" + } + }, + "FORM_BACKGROUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORM_BACKGROUND" + } + }, + "FORM_LOGO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORM_LOGO" + } + }, + "IDP_BUTTON_ICON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDP_BUTTON_ICON" + } + } + } + }, + "com.amazonaws.cognitoidentityprovider#AssetExtensionType": { + "type": "enum", + "members": { + "ICO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ICO" + } + }, + "JPEG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JPEG" + } + }, + "PNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PNG" + } + }, + "SVG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SVG" + } + }, + "WEBP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEBP" + } + } + } + }, + "com.amazonaws.cognitoidentityprovider#AssetListType": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentityprovider#AssetType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.cognitoidentityprovider#AssetType": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.cognitoidentityprovider#AssetCategoryType", + "traits": { + "smithy.api#documentation": "

The category that the image corresponds to in your managed login configuration.\n Managed login has asset categories for different types of logos, backgrounds, and\n icons.

", + "smithy.api#required": {} + } + }, + "ColorMode": { + "target": "com.amazonaws.cognitoidentityprovider#ColorSchemeModeType", + "traits": { + "smithy.api#documentation": "

The display-mode target of the asset: light, dark, or browser-adaptive. For example,\n Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode,\n but displays a browser-adaptive file in all contexts.

", + "smithy.api#required": {} + } + }, + "Extension": { + "target": "com.amazonaws.cognitoidentityprovider#AssetExtensionType", + "traits": { + "smithy.api#documentation": "

The file type of the image file.

", + "smithy.api#required": {} + } + }, + "Bytes": { + "target": "com.amazonaws.cognitoidentityprovider#AssetBytesType", + "traits": { + "smithy.api#documentation": "

The image file, in Base64-encoded binary.

" + } + }, + "ResourceId": { + "target": "com.amazonaws.cognitoidentityprovider#ResourceIdType", + "traits": { + "smithy.api#documentation": "

The ID of the asset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An image file from a managed login branding style in a user pool.

\n

This data type is a request parameter of CreateManagedLoginBranding and UpdateManagedLoginBranding, and a response parameter of\n DescribeManagedLoginBranding.

" + } + }, "com.amazonaws.cognitoidentityprovider#AssociateSoftwareToken": { "type": "operation", "input": { @@ -4120,7 +4360,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies whether the attribute is standard or custom.

" + "smithy.api#documentation": "

The name and value of a user attribute.

\n

This data type is a request parameter of AdminUpdateUserAttributes and UpdateUserAttributes.

" } }, "com.amazonaws.cognitoidentityprovider#AttributeValueType": { @@ -4151,7 +4391,7 @@ "EventType": { "target": "com.amazonaws.cognitoidentityprovider#EventType", "traits": { - "smithy.api#documentation": "

The event type.

" + "smithy.api#documentation": "

The type of authentication event.

" } }, "CreationDate": { @@ -4169,13 +4409,13 @@ "EventRisk": { "target": "com.amazonaws.cognitoidentityprovider#EventRiskType", "traits": { - "smithy.api#documentation": "

The event risk.

" + "smithy.api#documentation": "

The threat evaluation from your user pool about an event. Contains information about\n whether your user pool detected compromised credentials, whether the event triggered an\n automated response, and the level of risk.

" } }, "ChallengeResponses": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponseListType", "traits": { - "smithy.api#documentation": "

The challenge responses.

" + "smithy.api#documentation": "

A list of the challenges that the user was requested to answer, for example\n Password, and the result, for example Success.

" } }, "EventContextData": { @@ -4187,12 +4427,12 @@ "EventFeedback": { "target": "com.amazonaws.cognitoidentityprovider#EventFeedbackType", "traits": { - "smithy.api#documentation": "

A flag specifying the user feedback captured at the time of an event request is good\n or bad.

" + "smithy.api#documentation": "

The UpdateAuthEventFeedback or AdminUpdateAuthEventFeedback feedback that you or your\n user provided in response to the event. A value of Valid indicates that you\n disagreed with the level of risk that your user pool assigned, and evaluated a session\n to be valid, or likely safe. A value of Invalid indicates that you agreed\n with the user pool risk level and evaluated a session to be invalid, or likely\n malicious.

" } } }, "traits": { - "smithy.api#documentation": "

The authentication event type.

" + "smithy.api#documentation": "

One authentication event that Amazon Cognito logged in a user pool with advanced security\n features active. Contains user and device metadata and a risk assessment from your user\n pool.

\n

This data type is a request parameter of AdminListUserAuthEvents.

" } }, "com.amazonaws.cognitoidentityprovider#AuthEventsType": { @@ -4201,6 +4441,35 @@ "target": "com.amazonaws.cognitoidentityprovider#AuthEventType" } }, + "com.amazonaws.cognitoidentityprovider#AuthFactorType": { + "type": "enum", + "members": { + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD" + } + }, + "EMAIL_OTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_OTP" + } + }, + "SMS_OTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS_OTP" + } + }, + "WEB_AUTHN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB_AUTHN" + } + } + } + }, "com.amazonaws.cognitoidentityprovider#AuthFlowType": { "type": "enum", "members": { @@ -4245,6 +4514,12 @@ "traits": { "smithy.api#enumValue": "ADMIN_USER_PASSWORD_AUTH" } + }, + "USER_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_AUTH" + } } } }, @@ -4275,7 +4550,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "

A valid access token that Amazon Cognito issued to the user who you want to\n authenticate.

" + "smithy.api#documentation": "

Your user's access token.

" } }, "ExpiresIn": { @@ -4288,19 +4563,19 @@ "TokenType": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The token type.

" + "smithy.api#documentation": "

The intended use of the token, for example Bearer.

" } }, "RefreshToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "

The refresh token.

" + "smithy.api#documentation": "

Your user's refresh token.

" } }, "IdToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "

The ID token.

" + "smithy.api#documentation": "

Your user's ID token.

" } }, "NewDeviceMetadata": { @@ -4311,7 +4586,13 @@ } }, "traits": { - "smithy.api#documentation": "

The authentication result.

" + "smithy.api#documentation": "

The object that your application receives after authentication. Contains tokens and\n information for device authentication.

\n

This data type is a response parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.

" + } + }, + "com.amazonaws.cognitoidentityprovider#AvailableChallengeListType": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType" } }, "com.amazonaws.cognitoidentityprovider#BlockedIPRangeListType": { @@ -4418,6 +4699,12 @@ "smithy.api#enumValue": "CUSTOM_CHALLENGE" } }, + "SELECT_CHALLENGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECT_CHALLENGE" + } + }, "DEVICE_SRP_AUTH": { "target": "smithy.api#Unit", "traits": { @@ -4441,6 +4728,30 @@ "traits": { "smithy.api#enumValue": "NEW_PASSWORD_REQUIRED" } + }, + "SMS_OTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS_OTP" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD" + } + }, + "WEB_AUTHN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB_AUTHN" + } + }, + "PASSWORD_SRP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD_SRP" + } } } }, @@ -4482,18 +4793,18 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeName", "traits": { - "smithy.api#documentation": "

The challenge name.

" + "smithy.api#documentation": "

The type of challenge that your previous authentication request returned in the\n parameter ChallengeName, for example SMS_MFA.

" } }, "ChallengeResponse": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponse", "traits": { - "smithy.api#documentation": "

The challenge response.

" + "smithy.api#documentation": "

The set of key-value pairs that provides a response to the requested challenge.

" } } }, "traits": { - "smithy.api#documentation": "

The challenge response type.

" + "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.

\n \n
\n
SELECT_CHALLENGE
\n
\n

\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n

\n

Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.

\n

Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:

\n \n

For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.

\n \n
\n
SMS_OTP
\n
\n

\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, \nthen use the UpdateUserAttributes API operation to modify the value of any additional attributes.

\n \n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

\n

This data type is a request parameter of RespondToAuthChallenge and AdminRespondToAuthChallenge.

" } }, "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType": { @@ -4566,8 +4877,7 @@ "PreviousPassword": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { - "smithy.api#documentation": "

The old password.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The user's previous password. Required if the user has a password. If the user\n has no password and only signs in with passwordless authentication options, you can omit\n this parameter.

" } }, "ProposedPassword": { @@ -4665,7 +4975,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration for the CloudWatch log group destination of user pool detailed activity\n logging, or of user activity log export with advanced security features.

" + "smithy.api#documentation": "

Configuration for the CloudWatch log group destination of user pool detailed activity\n logging, or of user activity log export with advanced security features.

\n

This data type is a request parameter of SetLogDeliveryConfiguration and a response parameter of\n GetLogDeliveryConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsListType": { @@ -4697,7 +5007,7 @@ } }, "traits": { - "smithy.api#documentation": "

The delivery details for an email or SMS message that Amazon Cognito sent for authentication or\n verification.

" + "smithy.api#documentation": "

The delivery details for an email or SMS message that Amazon Cognito sent for authentication or\n verification.

\n

This data type is a response parameter of operations that send a code for user profile\n confirmation, verification, or management, for example ForgotPassword and SignUp.

" } }, "com.amazonaws.cognitoidentityprovider#CodeDeliveryFailureException": { @@ -4732,67 +5042,171 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.cognitoidentityprovider#CompletionMessageType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[\\w]+$" - } - }, - "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsActionsType": { - "type": "structure", - "members": { - "EventAction": { - "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsEventActionType", - "traits": { - "smithy.api#documentation": "

The event action.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The compromised credentials actions type.

" - } - }, - "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsEventActionType": { + "com.amazonaws.cognitoidentityprovider#ColorSchemeModeType": { "type": "enum", "members": { - "BLOCK": { + "LIGHT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "BLOCK" + "smithy.api#enumValue": "LIGHT" } }, - "NO_ACTION": { + "DARK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NO_ACTION" - } - } - } - }, - "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsRiskConfigurationType": { - "type": "structure", - "members": { - "EventFilter": { - "target": "com.amazonaws.cognitoidentityprovider#EventFiltersType", - "traits": { - "smithy.api#documentation": "

Perform the action for these events. The default is to perform all events if no event\n filter is specified.

" + "smithy.api#enumValue": "DARK" } }, - "Actions": { - "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsActionsType", + "DYNAMIC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The compromised credentials risk configuration actions.

", - "smithy.api#required": {} + "smithy.api#enumValue": "DYNAMIC" + } + } + } + }, + "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnChallengeNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnClientMismatchException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialNotSupportedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnNotEnabledException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnOriginNotAllowedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnRelyingPartyMismatchException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "

Completes registration of a passkey authenticator for the current user. Your\n application provides data from a successful registration request with the data from the\n output of a StartWebAuthnRegistration.

\n

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

", + "smithy.api#optionalAuth": {} + } + }, + "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistrationRequest": { + "type": "structure", + "members": { + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

A valid access token that Amazon Cognito issued to the user whose passkey registration you want\n to verify.

", + "smithy.api#required": {} + } + }, + "Credential": { + "target": "com.amazonaws.cognitoidentityprovider#Document", + "traits": { + "smithy.api#documentation": "

A RegistrationResponseJSON public-key credential response from the\n user's passkey provider.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistrationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentityprovider#CompletionMessageType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]+$" + } + }, + "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsActionsType": { + "type": "structure", + "members": { + "EventAction": { + "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsEventActionType", + "traits": { + "smithy.api#documentation": "

The action that Amazon Cognito takes when it detects compromised credentials.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for user pool actions when Amazon Cognito detects compromised credentials with\n advanced security features in full-function ENFORCED mode.

\n

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

" + } + }, + "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsEventActionType": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "NO_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ACTION" + } + } + } + }, + "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsRiskConfigurationType": { + "type": "structure", + "members": { + "EventFilter": { + "target": "com.amazonaws.cognitoidentityprovider#EventFiltersType", + "traits": { + "smithy.api#documentation": "

Settings for the sign-in activity where you want to configure compromised-credentials\n actions. Defaults to all events.

" + } + }, + "Actions": { + "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsActionsType", + "traits": { + "smithy.api#documentation": "

Settings for the actions that you want your user pool to take when Amazon Cognito detects\n compromised credentials.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The compromised credentials risk configuration type.

" + "smithy.api#documentation": "

Settings for compromised-credentials actions and authentication-event sources with\n advanced security features in full-function ENFORCED mode.

\n

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException": { @@ -4811,6 +5225,18 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cognitoidentityprovider#ConfiguredUserAuthFactorsListType": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentityprovider#AuthFactorType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8 + } + } + }, "com.amazonaws.cognitoidentityprovider#ConfirmDevice": { "type": "operation", "input": { @@ -5168,6 +5594,12 @@ "traits": { "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function\n code in Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:

\n \n " } + }, + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "traits": { + "smithy.api#documentation": "

The optional session ID from a SignUp API request. You can sign in a user\n directly from the sign-up process with the USER_AUTH authentication\n flow.

" + } } }, "traits": { @@ -5177,7 +5609,14 @@ }, "com.amazonaws.cognitoidentityprovider#ConfirmSignUpResponse": { "type": "structure", - "members": {}, + "members": { + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "traits": { + "smithy.api#documentation": "

You can automatically sign users in with the one-time password that they provided in a\n successful ConfirmSignUp request. To do this, pass the Session\n parameter from the ConfirmSignUp response in the Session\n parameter of an InitiateAuth or AdminInitiateAuth request.

" + } + } + }, "traits": { "smithy.api#documentation": "

Represents the response from the server for the registration confirmation.

", "smithy.api#output": {} @@ -5206,21 +5645,21 @@ "ServerName": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

Your server endpoint where this API is invoked.

", + "smithy.api#documentation": "

The name of your application's service endpoint.

", "smithy.api#required": {} } }, "ServerPath": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

Your server path where this API is invoked.

", + "smithy.api#documentation": "

The path of your application's service endpoint.

", "smithy.api#required": {} } }, "HttpHeaders": { "target": "com.amazonaws.cognitoidentityprovider#HttpHeaderList", "traits": { - "smithy.api#documentation": "

HttpHeaders received on your server in same order.

", + "smithy.api#documentation": "

The HTTP headers from your user's authentication request.

", "smithy.api#required": {} } }, @@ -5232,7 +5671,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito\n advanced security.

" + "smithy.api#documentation": "

Contextual user data used for evaluating the risk of an authentication event by user\n pool threat protection.

\n

This data type is a request parameter of server-side authentication operations like\n AdminInitiateAuth and AdminRespondToAuthChallenge.

" } }, "com.amazonaws.cognitoidentityprovider#CreateGroup": { @@ -5422,6 +5861,99 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBranding": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBrandingRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBrandingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingExistsException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new set of branding settings for a user pool style and associates it with an\n app client. This operation is the programmatic option for the creation of a new style in\n the branding designer.

\n

Provides values for UI customization in a Settings JSON object and image\n files in an Assets array. To send the JSON object Document\n type parameter in Settings, you might need to update to the most recent\n version of your Amazon Web Services SDK.

\n

This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.

\n

For more information, see API and SDK operations for managed login branding\n

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + } + }, + "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBrandingRequest": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool where you want to create a new branding style.

", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "traits": { + "smithy.api#documentation": "

The app client that you want to create the branding style for. Each style is\n permanently linked to an app client. To change the style for an app client, delete the\n existing style with DeleteManagedLoginBranding and create a new one.

", + "smithy.api#required": {} + } + }, + "UseCognitoProvidedValues": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When true, applies the default branding style options. This option reverts to default\n style options that are managed by Amazon Cognito. You can modify them later in the branding\n designer.

\n

When you specify true for this option, you must also omit values for\n Settings and Assets in the request.

" + } + }, + "Settings": { + "target": "com.amazonaws.cognitoidentityprovider#Document", + "traits": { + "smithy.api#documentation": "

A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.

" + } + }, + "Assets": { + "target": "com.amazonaws.cognitoidentityprovider#AssetListType", + "traits": { + "smithy.api#documentation": "

An array of image files that you want to apply to roles like backgrounds, logos, and\n icons. Each object must also indicate whether it is for dark mode, light mode, or\n browser-adaptive mode.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBrandingResponse": { + "type": "structure", + "members": { + "ManagedLoginBranding": { + "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingType", + "traits": { + "smithy.api#documentation": "

The details of the branding style that you created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#CreateResourceServer": { "type": "operation", "input": { @@ -5593,6 +6125,9 @@ "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -5614,6 +6149,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, + { + "target": "com.amazonaws.cognitoidentityprovider#TierChangeNotAllowedException" + }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, @@ -5622,7 +6160,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Creates a new Amazon Cognito user pool and sets the password policy for the\n pool.

\n \n

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", + "smithy.api#documentation": "\n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Creates a new Amazon Cognito user pool and sets the password policy for the\n pool.

\n \n

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#examples": [ { "title": "Example user pool with email and username sign-in", @@ -6303,13 +6841,13 @@ "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in \nyour users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and \npassword, or a custom authentication process that you define with Lambda functions.

\n \n

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

\n \n

Valid values include:

\n \n

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. \nYou can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,\nlike ALLOW_USER_SRP_AUTH.

" + "smithy.api#documentation": "

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in \nyour users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and \npassword, or a custom authentication process that you define with Lambda functions.

\n \n

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

\n \n

Valid values include:

\n \n

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. \nYou can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,\nlike ALLOW_USER_SRP_AUTH.

" } }, "SupportedIdentityProviders": { "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "

A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO, Facebook,\n Google, SignInWithApple, and LoginWithAmazon.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP or MyOIDCIdP.

" + "smithy.api#documentation": "

A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO, Facebook,\n Google, SignInWithApple, and LoginWithAmazon.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP or MyOIDCIdP.

\n

This setting applies to providers that you can access with the hosted\n UI and OAuth 2.0 authorization server. The removal of COGNITO\n from this list doesn't prevent authentication operations for local users with the\n user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to\n block access with a WAF rule.

" } }, "CallbackURLs": { @@ -6370,7 +6908,7 @@ "EnablePropagateAdditionalUserContextData": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

" + "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

" } }, "AuthSessionValidity": { @@ -6409,6 +6947,9 @@ "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomainResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -6426,7 +6967,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new domain for a user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + "smithy.api#documentation": "

Creates a new domain for a user pool. The domain hosts user pool domain services like\n managed login, the hosted UI (classic), and the user pool authorization server.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomainRequest": { @@ -6442,10 +6983,16 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#documentation": "

The ID of the user pool where you want to add a domain.

", "smithy.api#required": {} } }, + "ManagedLoginVersion": { + "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", + "traits": { + "smithy.api#documentation": "

The version of managed login branding that you want to apply to your domain. A value\n of 1 indicates hosted UI (classic) branding and a version of 2\n indicates managed login branding.

\n

Managed login requires that your user pool be configured for any feature plan other than Lite.

" + } + }, "CustomDomainConfig": { "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", "traits": { @@ -6460,6 +7007,12 @@ "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomainResponse": { "type": "structure", "members": { + "ManagedLoginVersion": { + "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", + "traits": { + "smithy.api#documentation": "

The version of managed login branding applied your domain. A value of 1\n indicates hosted UI (classic) branding and a version of 2 indicates managed\n login branding.

" + } + }, "CloudFrontDomain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { @@ -6496,7 +7049,7 @@ "LambdaConfig": { "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", "traits": { - "smithy.api#documentation": "

The Lambda trigger configuration information for the new user pool.

\n \n

In a push model, event sources (such as Amazon S3 and custom applications) need\n permission to invoke a function. So you must make an extra call to add permission\n for these event sources to invoke your Lambda function.

\n

\n

For more information on using the Lambda API to add permission, see\n AddPermission .

\n

For adding permission using the CLI, see add-permission\n .

\n " + "smithy.api#documentation": "

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of authentication operations. Triggers can modify the outcome of the operations\n that invoked them.

" } }, "AutoVerifiedAttributes": { @@ -6538,7 +7091,7 @@ "VerificationMessageTemplate": { "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", "traits": { - "smithy.api#documentation": "

The template for the verification message that the user sees when the app requests\n permission to access the user's information.

" + "smithy.api#documentation": "

The template for the verification message that your user pool delivers to users who\n set an email address or phone number attribute.

\n

Set the email message type that corresponds to your DefaultEmailOption\n selection. For CONFIRM_WITH_LINK, specify an\n EmailMessageByLink and leave EmailMessage blank. For\n CONFIRM_WITH_CODE, specify an EmailMessage and leave\n EmailMessageByLink blank. When you supply both parameters with either\n choice, Amazon Cognito returns an error.

" } }, "SmsAuthenticationMessage": { @@ -6612,6 +7165,12 @@ "traits": { "smithy.api#documentation": "

The available verified method a user can use to recover their password when they call\n ForgotPassword. You can use this setting to define a preferred method\n when a user has more than one method available. With this setting, SMS doesn't qualify\n for a valid password recovery mechanism if the user also has SMS multi-factor\n authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\n behavior to determine the recovery method where SMS is preferred through email.

" } + }, + "UserPoolTier": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolTierType", + "traits": { + "smithy.api#documentation": "

The user pool feature plan, or tier. This parameter determines the\n eligibility of the user pool for features like managed login, access-token\n customization, and threat protection. Defaults to ESSENTIALS.

" + } } }, "traits": { @@ -6668,7 +7227,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.

" + "smithy.api#documentation": "

The configuration for a hosted UI custom domain.

\n

This data type is a request parameter of CreateUserPoolDomain and UpdateUserPoolDomain.

" } }, "com.amazonaws.cognitoidentityprovider#CustomEmailLambdaVersionConfigType": { @@ -6690,7 +7249,7 @@ } }, "traits": { - "smithy.api#documentation": "

The properties of a custom email sender Lambda trigger.

" + "smithy.api#documentation": "

The properties of a custom email sender Lambda trigger.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#CustomEmailSenderLambdaVersionType": { @@ -6723,7 +7282,7 @@ } }, "traits": { - "smithy.api#documentation": "

The properties of a custom SMS sender Lambda trigger.

" + "smithy.api#documentation": "

The properties of a custom SMS sender Lambda trigger.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#CustomSMSSenderLambdaVersionType": { @@ -6865,15 +7424,18 @@ "smithy.api#input": {} } }, - "com.amazonaws.cognitoidentityprovider#DeleteResourceServer": { + "com.amazonaws.cognitoidentityprovider#DeleteManagedLoginBranding": { "type": "operation", "input": { - "target": "com.amazonaws.cognitoidentityprovider#DeleteResourceServerRequest" + "target": "com.amazonaws.cognitoidentityprovider#DeleteManagedLoginBrandingRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -6891,23 +7453,23 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a resource server.

" + "smithy.api#documentation": "

Deletes a managed login branding style. When you delete a style, you delete the\n branding association for an app client and restore it to default settings.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, - "com.amazonaws.cognitoidentityprovider#DeleteResourceServerRequest": { + "com.amazonaws.cognitoidentityprovider#DeleteManagedLoginBrandingRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "ManagedLoginBrandingId": { + "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool that hosts the resource server.

", + "smithy.api#documentation": "

The ID of the managed login branding style that you want to delete.

", "smithy.api#required": {} } }, - "Identifier": { - "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The identifier for the resource server.

", + "smithy.api#documentation": "

The ID of the user pool that contains the managed login branding style that you want\n to delete.

", "smithy.api#required": {} } } @@ -6916,18 +7478,15 @@ "smithy.api#input": {} } }, - "com.amazonaws.cognitoidentityprovider#DeleteUser": { + "com.amazonaws.cognitoidentityprovider#DeleteResourceServer": { "type": "operation", "input": { - "target": "com.amazonaws.cognitoidentityprovider#DeleteUserRequest" + "target": "com.amazonaws.cognitoidentityprovider#DeleteResourceServerRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ - { - "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" - }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -6938,7 +7497,61 @@ "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { - "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a resource server.

" + } + }, + "com.amazonaws.cognitoidentityprovider#DeleteResourceServerRequest": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The user pool ID for the user pool that hosts the resource server.

", + "smithy.api#required": {} + } + }, + "Identifier": { + "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", + "traits": { + "smithy.api#documentation": "

The identifier for the resource server.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#DeleteUserRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" @@ -7207,6 +7820,66 @@ "smithy.api#input": {} } }, + "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredential": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredentialRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredentialResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "

Deletes a registered passkey, or webauthN, device for the currently signed-in\n user.

\n

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

", + "smithy.api#optionalAuth": {} + } + }, + "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredentialRequest": { + "type": "structure", + "members": { + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

A valid access token that Amazon Cognito issued to the user whose passkey you want to\n delete.

", + "smithy.api#required": {} + } + }, + "CredentialId": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The unique identifier of the passkey that you want to delete. Look up registered\n devices with ListWebAuthnCredentials.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredentialResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#DeletionProtectionType": { "type": "enum", "members": { @@ -7313,6 +7986,150 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBranding": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

When given the ID of a managed login branding style, returns detailed information\n about the style.

" + } + }, + "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClient": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClientRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClientResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

When given the ID of a user pool app client, returns detailed information about the\n style assigned to the app client.

" + } + }, + "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClientRequest": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool that contains the app client where you want more information\n about the managed login branding style.

", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "traits": { + "smithy.api#documentation": "

The app client that's assigned to the branding style that you want more information\n about.

", + "smithy.api#required": {} + } + }, + "ReturnMergedResources": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When true, returns values for branding options that are unchanged from\n Amazon Cognito defaults. When false or when you omit this parameter, returns only\n values that you customized in your branding style.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClientResponse": { + "type": "structure", + "members": { + "ManagedLoginBranding": { + "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingType", + "traits": { + "smithy.api#documentation": "

The details of the requested branding style.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingRequest": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool that contains the managed login branding style that you want\n to get information about.

", + "smithy.api#required": {} + } + }, + "ManagedLoginBrandingId": { + "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingIdType", + "traits": { + "smithy.api#documentation": "

The ID of the managed login branding style that you want to get more information\n about.

", + "smithy.api#required": {} + } + }, + "ReturnMergedResources": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When true, returns values for branding options that are unchanged from\n Amazon Cognito defaults. When false or when you omit this parameter, returns only\n values that you customized in your branding style.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingResponse": { + "type": "structure", + "members": { + "ManagedLoginBranding": { + "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingType", + "traits": { + "smithy.api#documentation": "

The details of the requested branding style.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#DescribeResourceServer": { "type": "operation", "input": { @@ -7727,7 +8544,7 @@ } }, "traits": { - "smithy.api#documentation": "

The device-remembering configuration for a user pool. A \n DescribeUserPool request returns a null value for this object when the user\n pool isn't configured to remember devices. When device remembering is active, you can\n remember a user's device with a ConfirmDevice API request. Additionally. when the property\n DeviceOnlyRememberedOnUserPrompt is true, you must follow\n ConfirmDevice with an UpdateDeviceStatus API request that sets the user's device to\n remembered or not_remembered.

\n

To sign in with a remembered device, include DEVICE_KEY in the\n authentication parameters in your user's \n InitiateAuth request. If your app doesn't include a DEVICE_KEY\n parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY and\n DEVICE_GROUP_KEY values under NewDeviceMetadata. Store\n these values to use in future device-authentication requests.

\n \n

When you provide a value for any property of DeviceConfiguration, you\n activate the device remembering for the user pool.

\n " + "smithy.api#documentation": "

The device-remembering configuration for a user pool. A \n DescribeUserPool request returns a null value for this object when the user\n pool isn't configured to remember devices. When device remembering is active, you can\n remember a user's device with a ConfirmDevice API request. Additionally. when the property\n DeviceOnlyRememberedOnUserPrompt is true, you must follow\n ConfirmDevice with an UpdateDeviceStatus API request that sets the user's device to\n remembered or not_remembered.

\n

To sign in with a remembered device, include DEVICE_KEY in the\n authentication parameters in your user's \n InitiateAuth request. If your app doesn't include a DEVICE_KEY\n parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY and\n DEVICE_GROUP_KEY values under NewDeviceMetadata. Store\n these values to use in future device-authentication requests.

\n \n

When you provide a value for any property of DeviceConfiguration, you\n activate the device remembering for the user pool.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

\n " } }, "com.amazonaws.cognitoidentityprovider#DeviceKeyType": { @@ -7778,18 +8595,18 @@ "PasswordVerifier": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The password verifier.

" + "smithy.api#documentation": "

A password verifier for a user's device. Used in SRP authentication.

" } }, "Salt": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The salt\n

" + "smithy.api#documentation": "

The salt that you want to use in SRP authentication with the user's device.

" } } }, "traits": { - "smithy.api#documentation": "

The device verifier against which it is authenticated.

" + "smithy.api#documentation": "

A Secure Remote Password (SRP) value that your application generates when you register\n a user's device. For more information, see Getting a device key.

\n

This data type is a request parameter of ConfirmDevice.

" } }, "com.amazonaws.cognitoidentityprovider#DeviceType": { @@ -7798,19 +8615,19 @@ "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { - "smithy.api#documentation": "

The device key.

" + "smithy.api#documentation": "

The device key, for example\n us-west-2_EXAMPLE-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

" } }, "DeviceAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "

The device attributes.

" + "smithy.api#documentation": "

Metadata about a user's device, like name and last-access source IP.

" } }, "DeviceCreateDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The creation date of the device.

" + "smithy.api#documentation": "

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

" } }, "DeviceLastModifiedDate": { @@ -7822,27 +8639,30 @@ "DeviceLastAuthenticatedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date when the device was last authenticated.

" + "smithy.api#documentation": "

The date when the user last signed in with the device.

" } } }, "traits": { - "smithy.api#documentation": "

The device type.

" + "smithy.api#documentation": "

Information about a user's device that they've registered for device SRP\n authentication in your application. For more information, see Working with user devices in your user pool.

\n

The data type is a response parameter of AdminGetDevice, AdminListDevices, and GetDevice.

" } }, + "com.amazonaws.cognitoidentityprovider#Document": { + "type": "document" + }, "com.amazonaws.cognitoidentityprovider#DomainDescriptionType": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID.

" + "smithy.api#documentation": "

The ID of the user pool that the domain is attached to.

" } }, "AWSAccountId": { "target": "com.amazonaws.cognitoidentityprovider#AWSAccountIdType", "traits": { - "smithy.api#documentation": "

The Amazon Web Services ID for the user pool owner.

" + "smithy.api#documentation": "

The Amazon Web Services account that you created the user pool in.

" } }, "Domain": { @@ -7860,7 +8680,7 @@ "CloudFrontDistribution": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with\n your Domain Name Service (DNS) provider.

" + "smithy.api#documentation": "

The Amazon CloudFront endpoint that hosts your custom domain.

" } }, "Version": { @@ -7880,10 +8700,16 @@ "traits": { "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.

" } + }, + "ManagedLoginVersion": { + "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", + "traits": { + "smithy.api#documentation": "

The version of managed login branding that you want to apply to your domain. A value\n of 1 indicates hosted UI (classic) branding and a version of 2\n indicates managed login branding.

\n

Managed login requires that your user pool be configured for any feature plan other than Lite.

" + } } }, "traits": { - "smithy.api#documentation": "

A container for information about a domain.

" + "smithy.api#documentation": "

A container for information about the user pool domain associated with the hosted UI\n and OAuth endpoints.

\n

This data type is a response parameter of DescribeUserPoolDomain.

" } }, "com.amazonaws.cognitoidentityprovider#DomainStatusType": { @@ -7994,7 +8820,17 @@ } }, "traits": { - "smithy.api#documentation": "

The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.

\n \n

Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where\n you created your user pool, and in alternate Regions in some cases. For more\n information on the supported Regions, see Email settings for Amazon Cognito user pools.

\n " + "smithy.api#documentation": "

The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.

\n \n

Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where\n you created your user pool, and in alternate Regions in some cases. For more\n information on the supported Regions, see Email settings for Amazon Cognito user pools.

\n \n

This data type is a request parameter of CreateUserPool, UpdateUserPool, and SetUserPoolMfaConfig, and a response parameter of\n CreateUserPool, UpdateUserPool, and GetUserPoolMfaConfig.

" + } + }, + "com.amazonaws.cognitoidentityprovider#EmailInviteMessageType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 20000 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*$" } }, "com.amazonaws.cognitoidentityprovider#EmailMfaConfigType": { @@ -8014,7 +8850,7 @@ } }, "traits": { - "smithy.api#documentation": "

Sets or shows user pool email message configuration for MFA. Includes the subject and\n body of the email message template for MFA messages. To activate this setting, \n advanced security features must be active in your user pool.

" + "smithy.api#documentation": "

Sets or shows user pool email message configuration for MFA. Includes the subject and\n body of the email message template for MFA messages. To activate this setting, \n advanced security features must be active in your user pool.

\n

This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.

" } }, "com.amazonaws.cognitoidentityprovider#EmailMfaMessageType": { @@ -8046,7 +8882,7 @@ } }, "traits": { - "smithy.api#documentation": "

User preferences for multi-factor authentication with email messages. Activates or\n deactivates email MFA and sets it as the preferred MFA method when multiple methods are\n available. To activate this setting, \n advanced security features must be active in your user pool.

" + "smithy.api#documentation": "

User preferences for multi-factor authentication with email messages. Activates or\n deactivates email MFA and sets it as the preferred MFA method when multiple methods are\n available. To activate this setting, \n advanced security features must be active in your user pool.

\n

This data type is a request parameter of SetUserMFAPreference and AdminSetUserMFAPreference.

" } }, "com.amazonaws.cognitoidentityprovider#EmailMfaSubjectType": { @@ -8180,7 +9016,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the user context data captured at the time of an event request.

" + "smithy.api#documentation": "

The context data that your application submitted in an authentication request with\n advanced security features, as displayed in an AdminListUserAuthEvents response.

" } }, "com.amazonaws.cognitoidentityprovider#EventFeedbackType": { @@ -8196,19 +9032,19 @@ "Provider": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The provider.

", + "smithy.api#documentation": "

The submitter of the event feedback. For example, if you submit event feedback in the\n Amazon Cognito console, this value is Admin.

", "smithy.api#required": {} } }, "FeedbackDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The event feedback date.

" + "smithy.api#documentation": "

The date that you or your user submitted the feedback.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the event feedback type.

" + "smithy.api#documentation": "

The feedback that your application submitted to an advanced security features event\n log, as displayed in an AdminListUserAuthEvents response.

" } }, "com.amazonaws.cognitoidentityprovider#EventFilterType": { @@ -8279,13 +9115,13 @@ "RiskDecision": { "target": "com.amazonaws.cognitoidentityprovider#RiskDecisionType", "traits": { - "smithy.api#documentation": "

The risk decision.

" + "smithy.api#documentation": "

The action taken by adaptive authentication. If NoRisk, your user pool\n took no action. If AccountTakeover, your user pool applied the adaptive\n authentication automated response that you configured. If Block, your user\n pool prevented the attempt.

" } }, "RiskLevel": { "target": "com.amazonaws.cognitoidentityprovider#RiskLevelType", "traits": { - "smithy.api#documentation": "

The risk level.

" + "smithy.api#documentation": "

The risk level that adaptive authentication assessed for the authentication\n event.

" } }, "CompromisedCredentialsDetected": { @@ -8296,7 +9132,7 @@ } }, "traits": { - "smithy.api#documentation": "

The event risk type.

" + "smithy.api#documentation": "

The risk evaluation by adaptive authentication, as displayed in an AdminListUserAuthEvents response. Contains evaluations\n of compromised-credentials detection and assessed risk level and action taken by\n adaptive authentication.

" } }, "com.amazonaws.cognitoidentityprovider#EventSourceName": { @@ -8423,7 +9259,26 @@ "traits": { "smithy.api#enumValue": "ALLOW_REFRESH_TOKEN_AUTH" } + }, + "ALLOW_USER_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW_USER_AUTH" + } + } + } + }, + "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when a feature you attempted to configure isn't\n available in your current feature plan.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 } }, "com.amazonaws.cognitoidentityprovider#FeedbackValueType": { @@ -8604,7 +9459,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Calling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. To\n use the confirmation code for resetting the password, call ConfirmForgotPassword.

\n

If neither a verified phone number nor a verified email exists, this API returns\n InvalidParameterException. If your app client has a client secret and\n you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.

\n

To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", + "smithy.api#documentation": "

Calling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. To\n use the confirmation code for resetting the password, call ConfirmForgotPassword.

\n

If neither a verified phone number nor a verified email exists, this API returns\n InvalidParameterException. If your app client has a client secret and\n you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.

\n

To use this API operation, your user pool must have self-service account recovery\n configured. Use AdminSetUserPassword if you manage passwords as an administrator.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -9240,7 +10095,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Generates a user attribute verification code for the specified attribute name. Sends a\n message to a user with a code that they must return in a VerifyUserAttribute\n request.

\n

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", + "smithy.api#documentation": "

Generates a user attribute verification code for the specified attribute name. Sends a\n message to a user with a code that they must return in a VerifyUserAttribute\n request.

\n

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -9288,13 +10143,104 @@ "smithy.api#output": {} } }, - "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfig": { + "com.amazonaws.cognitoidentityprovider#GetUserAuthFactors": { "type": "operation", "input": { - "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfigRequest" + "target": "com.amazonaws.cognitoidentityprovider#GetUserAuthFactorsRequest" }, "output": { - "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfigResponse" + "target": "com.amazonaws.cognitoidentityprovider#GetUserAuthFactorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "

Lists the authentication options for the currently signed-in user. Returns the\n following:

\n
    \n
  1. \n

    The user's multi-factor authentication (MFA) preferences.

    \n
    2. \n
  2. \n

    The user's options in the USER_AUTH flow that they can\n select in a SELECT_CHALLENGE response or request in a\n PREFERRED_CHALLENGErequest.

    \n
    3. \n
", + "smithy.api#optionalAuth": {} + } + }, + "com.amazonaws.cognitoidentityprovider#GetUserAuthFactorsRequest": { + "type": "structure", + "members": { + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

A valid access token that Amazon Cognito issued to the user whose authentication factors you\n want to view.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#GetUserAuthFactorsResponse": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "traits": { + "smithy.api#documentation": "

The username of the currently sign-in user.

", + "smithy.api#required": {} + } + }, + "PreferredMfaSetting": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The user's preferred MFA setting.

" + } + }, + "UserMFASettingList": { + "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", + "traits": { + "smithy.api#documentation": "

The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA, EMAIL_OTP, and\n SOFTWARE_TOKEN_MFA.

" + } + }, + "ConfiguredUserAuthFactors": { + "target": "com.amazonaws.cognitoidentityprovider#ConfiguredUserAuthFactorsListType", + "traits": { + "smithy.api#documentation": "

The authentication types that are available to the user with USER_AUTH\n sign-in.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfigRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfigResponse" }, "errors": [ { @@ -9358,6 +10304,12 @@ "traits": { "smithy.api#documentation": "

The multi-factor authentication (MFA) configuration. Valid values include:

\n " } + }, + "WebAuthnConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnConfigurationType", + "traits": { + "smithy.api#documentation": "

Shows user pool configuration for MFA with passkeys from biometric devices and\n security keys.

" + } } }, "traits": { @@ -9412,7 +10364,7 @@ "UserMFASettingList": { "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", "traits": { - "smithy.api#documentation": "

The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

" + "smithy.api#documentation": "

The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA, EMAIL_OTP, and\n SOFTWARE_TOKEN_MFA.

" } } }, @@ -9526,25 +10478,25 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

" + "smithy.api#documentation": "

The ID of the user pool that contains the group.

" } }, "Description": { "target": "com.amazonaws.cognitoidentityprovider#DescriptionType", "traits": { - "smithy.api#documentation": "

A string containing the description of the group.

" + "smithy.api#documentation": "

A friendly description of the group.

" } }, "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The role Amazon Resource Name (ARN) for the group.

" + "smithy.api#documentation": "

The ARN of the IAM role associated with the group. If a group has the highest\n priority of a user's groups, users who authenticate with an identity pool get\n credentials for the RoleArn that's associated with the group.

" } }, "Precedence": { "target": "com.amazonaws.cognitoidentityprovider#PrecedenceType", "traits": { - "smithy.api#documentation": "

A non-negative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. Zero is the highest\n precedence value. Groups with lower Precedence values take precedence over\n groups with higher ornull Precedence values. If a user belongs to two or\n more groups, it is the group with the lowest precedence value whose role ARN is given in\n the user's tokens for the cognito:roles and\n cognito:preferred_role claims.

\n

Two groups can have the same Precedence value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence have the same role ARN, that role is used in the\n cognito:preferred_role claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role claim isn't\n set in users' tokens.

\n

The default Precedence value is null.

" + "smithy.api#documentation": "

A non-negative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. Zero is the highest\n precedence value. Groups with lower Precedence values take precedence over\n groups with higher ornull Precedence values. If a user belongs to two or\n more groups, it is the group with the lowest precedence value whose role ARN is given in\n the user's tokens for the cognito:roles and\n cognito:preferred_role claims.

\n

Two groups can have the same Precedence value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence have the same role ARN, that role is used in the\n cognito:preferred_role claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role claim isn't\n set in users' tokens.

\n

The default Precedence value is null.

" } }, "LastModifiedDate": { @@ -9561,7 +10513,7 @@ } }, "traits": { - "smithy.api#documentation": "

The group type.

" + "smithy.api#documentation": "

A user pool group. Contains details about the group and the way that it contributes to\n IAM role decisions with identity pools. Identity pools can make decisions about the\n IAM role to assign based on groups: users get credentials for the role associated with\n their highest-priority group.

\n

This data type is a response parameter of AdminListGroupsForUser, CreateGroup, GetGroup, ListGroups, and UpdateGroup.

" } }, "com.amazonaws.cognitoidentityprovider#HexStringType": { @@ -9587,7 +10539,7 @@ } }, "traits": { - "smithy.api#documentation": "

The HTTP header.

" + "smithy.api#documentation": "

The HTTP header in the ContextData parameter.

\n

This data type is a request parameter of server-side authentication operations like\n AdminInitiateAuth and AdminRespondToAuthChallenge.

" } }, "com.amazonaws.cognitoidentityprovider#HttpHeaderList": { @@ -9611,19 +10563,19 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID.

" + "smithy.api#documentation": "

The ID of the user pool associated with the IdP.

" } }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { - "smithy.api#documentation": "

The IdP name.

" + "smithy.api#documentation": "

A friendly name for the IdP.

" } }, "ProviderType": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType", "traits": { - "smithy.api#documentation": "

The IdP type.

" + "smithy.api#documentation": "

The type of IdP. Either SAML, OIDC, or a named social identity provider.

" } }, "ProviderDetails": { @@ -9641,7 +10593,7 @@ "IdpIdentifiers": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", "traits": { - "smithy.api#documentation": "

A list of IdP identifiers.

" + "smithy.api#documentation": "

A list of IdP identifiers. IdP identifiers are strings that represent friendly names\n or domain names of IdPs, for example MyIdP or\n auth.example.com. You can choose to route user authorization requests to\n the right IdP with either IdP identifiers or IdP names. For more information, see\n identity_provider and idp_identifier at Authorize endpoint.

" } }, "LastModifiedDate": { @@ -9658,7 +10610,7 @@ } }, "traits": { - "smithy.api#documentation": "

A container for information about an IdP.

" + "smithy.api#documentation": "

A user pool identity provider (IdP). Contains information about a third-party IdP to a\n user pool, the attributes that it populates to user profiles, and the trust relationship\n between the IdP and your user pool.

\n

This data type is a response parameter of CreateIdentityProvider, DescribeIdentityProvider, GetIdentityProviderByIdentifier, and UpdateIdentityProvider.

" } }, "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType": { @@ -9796,7 +10748,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user\n with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", + "smithy.api#documentation": "

Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user\n with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#examples": [ { "title": "Example username and password sign-in for a user who has TOTP MFA", @@ -9839,20 +10791,20 @@ "AuthFlow": { "target": "com.amazonaws.cognitoidentityprovider#AuthFlowType", "traits": { - "smithy.api#documentation": "

The authentication flow for this call to run. The API action will depend on this\n value. For example:

\n \n

Valid values include:

\n \n

\n ADMIN_NO_SRP_AUTH isn't a valid value.

", + "smithy.api#documentation": "

The authentication flow that you want to initiate. The AuthParameters\n that you must submit are linked to the flow that you submit. For example:

\n \n

Valid values include the following:

\n
\n
USER_AUTH
\n
\n

The entry point for sign-in with passwords, one-time passwords, biometric\n devices, and security keys.

\n
\n
USER_SRP_AUTH
\n
\n

Username-password authentication with the Secure Remote Password (SRP)\n protocol. For more information, see Use SRP password verification in custom\n authentication flow.

\n
\n
REFRESH_TOKEN_AUTH and REFRESH_TOKEN
\n
\n

Provide a valid refresh token and receive new ID and access tokens. For\n more information, see Using the refresh token.

\n
\n
CUSTOM_AUTH
\n
\n

Custom authentication with Lambda triggers. For more information, see\n Custom authentication challenge Lambda\n triggers.

\n
\n
USER_PASSWORD_AUTH
\n
\n

Username-password authentication with the password sent directly in the\n request. For more information, see Admin authentication flow.

\n
\n
\n

\n ADMIN_USER_PASSWORD_AUTH is a flow type of AdminInitiateAuth and isn't valid for InitiateAuth.\n ADMIN_NO_SRP_AUTH is a legacy server-side username-password flow and\n isn't valid for InitiateAuth.

", "smithy.api#required": {} } }, "AuthParameters": { "target": "com.amazonaws.cognitoidentityprovider#AuthParametersType", "traits": { - "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking. The required values depend on the value\n of AuthFlow:

\n \n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" + "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking. The required values depend on the value\n of AuthFlow:

\n \n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are\n specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:

\n \n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your InitiateAuth request. In your function code in Lambda, you can process the\n validationData value to enhance your workflow for your specific\n needs.

\n

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the\n following triggers, but it doesn't provide the ClientMetadata value as input:

\n \n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:

\n \n " + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.

\n

You create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are\n specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:

\n \n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your InitiateAuth request. In your function code in Lambda, you can process the\n validationData value to enhance your workflow for your specific\n needs.

\n

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the\n following triggers, but it doesn't provide the ClientMetadata value as input:

\n \n

For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

\n \n

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:

\n \n " } }, "ClientId": { @@ -9873,6 +10825,12 @@ "traits": { "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } + }, + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "traits": { + "smithy.api#documentation": "

The optional session ID from a ConfirmSignUp API request. You can sign in\n a user directly from the sign-up process with the USER_AUTH authentication\n flow.

" + } } }, "traits": { @@ -9886,19 +10844,19 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of the challenge that you're responding to with this call. This name is\n returned in the InitiateAuth response if you must pass another\n challenge.

\n

Valid values include the following:

\n \n

All of the following challenges require USERNAME and\n SECRET_HASH (if applicable) in the parameters.

\n \n " + "smithy.api#documentation": "

The name of the challenge that you're responding to with this call. This name is\n returned in the InitiateAuth response if you must pass another\n challenge.

\n

Valid values include the following:

\n \n

All of the following challenges require USERNAME and\n SECRET_HASH (if applicable) in the parameters.

\n \n " } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "

The session that should pass both ways in challenge-response calls to the service. If\n the caller must pass another challenge, they return a session with other challenge\n parameters. This session should be passed as it is to the next\n RespondToAuthChallenge API call.

" + "smithy.api#documentation": "

The session that should pass both ways in challenge-response calls to the service. If\n the caller must pass another challenge, they return a session with other challenge\n parameters. Include this session identifier in a RespondToAuthChallenge API\n request.

" } }, "ChallengeParameters": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeParametersType", "traits": { - "smithy.api#documentation": "

The challenge parameters. These are returned in the InitiateAuth response\n if you must pass another challenge. The responses in this parameter should be used to\n compute inputs to the next call (RespondToAuthChallenge).

\n

All challenges require USERNAME and SECRET_HASH (if\n applicable).

" + "smithy.api#documentation": "

The challenge parameters. These are returned in the InitiateAuth response\n if you must pass another challenge. The responses in this parameter should be used to\n compute inputs to the next call (RespondToAuthChallenge).

\n

All challenges require USERNAME. They also require\n SECRET_HASH if your app client has a client secret.

" } }, "AuthenticationResult": { @@ -9906,6 +10864,12 @@ "traits": { "smithy.api#documentation": "

The result of the authentication response. This result is only returned if the caller\n doesn't need to pass another challenge. If the caller does need to pass another\n challenge before it gets tokens, ChallengeName,\n ChallengeParameters, and Session are returned.

" } + }, + "AvailableChallenges": { + "target": "com.amazonaws.cognitoidentityprovider#AvailableChallengeListType", + "traits": { + "smithy.api#documentation": "

This response parameter prompts a user to select from multiple available challenges\n that they can complete authentication with. For example, they might be able to continue\n with passwordless authentication or with a one-time password from an SMS message.

" + } } }, "traits": { @@ -9987,6 +10951,12 @@ "traits": { "smithy.api#documentation": "

The message returned when the Amazon Cognito service throws an invalid parameter\n exception.

" } + }, + "reasonCode": { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterExceptionReasonCodeType", + "traits": { + "smithy.api#documentation": "

The reason code of the exception.

" + } } }, "traits": { @@ -9995,6 +10965,9 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cognitoidentityprovider#InvalidParameterExceptionReasonCodeType": { + "type": "string" + }, "com.amazonaws.cognitoidentityprovider#InvalidPasswordException": { "type": "structure", "members": { @@ -10038,7 +11011,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception is thrown when the trust relationship is not valid for the role\n provided for SMS configuration. This can happen if you don't trust\n cognito-idp.amazonaws.com or the external ID provided in the role does\n not match what is provided in the SMS configuration for the user pool.

", + "smithy.api#documentation": "

This exception is thrown when the trust relationship is not valid for the role\n provided for SMS configuration. This can happen if you don't trust\n cognito-idp.amazonaws.com or the external ID provided in the role does\n not match what is provided in the SMS configuration for the user pool.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -10065,90 +11038,90 @@ "PreSignUp": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

A pre-registration Lambda trigger.

" + "smithy.api#documentation": "

The configuration of a pre sign-up Lambda trigger in a user pool. This trigger\n evaluates new users and can bypass confirmation, link a federated user profile, or block sign-up\n requests.

" } }, "CustomMessage": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

A custom Message Lambda trigger.

" + "smithy.api#documentation": "

A custom message Lambda trigger. This trigger is an opportunity to customize all SMS\n and email messages from your user pool. When a custom message trigger is active, your\n user pool routes all messages to a Lambda function that returns a runtime-customized\n message subject and body for your user pool to deliver to a user.

" } }, "PostConfirmation": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

A post-confirmation Lambda trigger.

" + "smithy.api#documentation": "

The configuration of a post confirmation Lambda trigger in a user pool. This\n trigger can take custom actions after a user confirms their user account and their email\n address or phone number.

" } }, "PreAuthentication": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

A pre-authentication Lambda trigger.

" + "smithy.api#documentation": "

The configuration of a pre authentication trigger in a user pool. This trigger\n can evaluate and modify user sign-in events.

" } }, "PostAuthentication": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

A post-authentication Lambda trigger.

" + "smithy.api#documentation": "

The configuration of a post authentication Lambda trigger in a user pool. This\n trigger can take custom actions after a user signs in.

" } }, "DefineAuthChallenge": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

Defines the authentication challenge.

" + "smithy.api#documentation": "

The configuration of a define auth challenge Lambda trigger, one of three triggers in\n the sequence of the custom authentication challenge triggers.

" } }, "CreateAuthChallenge": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

Creates an authentication challenge.

" + "smithy.api#documentation": "

The configuration of a create auth challenge Lambda trigger, one of three triggers in\n the sequence of the custom authentication challenge triggers.

" } }, "VerifyAuthChallengeResponse": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

Verifies the authentication challenge response.

" + "smithy.api#documentation": "

The configuration of a verify auth challenge Lambda trigger, one of three triggers in\n the sequence of the custom authentication challenge triggers.

" } }, "PreTokenGeneration": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

\n

Set this parameter for legacy purposes. If you also set an ARN in\n PreTokenGenerationConfig, its value must be identical to\n PreTokenGeneration. For new instances of pre token generation triggers,\n set the LambdaArn of PreTokenGenerationConfig.

\n

You can set \n

" + "smithy.api#documentation": "

The legacy configuration of a pre token generation Lambda trigger in a user\n pool.

\n

Set this parameter for legacy purposes. If you also set an ARN in\n PreTokenGenerationConfig, its value must be identical to\n PreTokenGeneration. For new instances of pre token generation triggers,\n set the LambdaArn of PreTokenGenerationConfig.

" } }, "UserMigration": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The user migration Lambda config type.

" + "smithy.api#documentation": "

The configuration of a migrate user Lambda trigger in a user pool. This trigger\n can create user profiles when users sign in or attempt to reset their password with\n credentials that don't exist yet.

" } }, "PreTokenGenerationConfig": { "target": "com.amazonaws.cognitoidentityprovider#PreTokenGenerationVersionConfigType", "traits": { - "smithy.api#documentation": "

The detailed configuration of a pre token generation trigger. If you also set an ARN\n in PreTokenGeneration, its value must be identical to\n PreTokenGenerationConfig.

" + "smithy.api#documentation": "

The detailed configuration of a pre token generation Lambda trigger in a user pool. If\n you also set an ARN in PreTokenGeneration, its value must be identical to\n PreTokenGenerationConfig.

" } }, "CustomSMSSender": { "target": "com.amazonaws.cognitoidentityprovider#CustomSMSLambdaVersionConfigType", "traits": { - "smithy.api#documentation": "

A custom SMS sender Lambda trigger.

" + "smithy.api#documentation": "

The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS\n notifications from a user pool to a Lambda function that delivers the message using\n custom logic.

" } }, "CustomEmailSender": { "target": "com.amazonaws.cognitoidentityprovider#CustomEmailLambdaVersionConfigType", "traits": { - "smithy.api#documentation": "

A custom email sender Lambda trigger.

" + "smithy.api#documentation": "

The configuration of a custom email sender Lambda trigger. This trigger routes all\n email notifications from a user pool to a Lambda function that delivers the message using\n custom logic.

" } }, "KMSKeyID": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito\n uses the key to encrypt codes and temporary passwords sent to\n CustomEmailSender and CustomSMSSender.

" + "smithy.api#documentation": "

The ARN of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to\n custom sender Lambda triggers.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the configuration for Lambda triggers.

" + "smithy.api#documentation": "

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of user pool operations. Triggers can modify the outcome of the operations that\n invoked them.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#LimitExceededException": { @@ -11072,7 +12045,7 @@ "Filter": { "target": "com.amazonaws.cognitoidentityprovider#UserFilterType", "traits": { - "smithy.api#documentation": "

A filter string of the form \"AttributeName\n Filter-Type \"AttributeValue\"\". Quotation marks\n within the filter string must be escaped using the backslash (\\) character.\n For example, \"family_name = \\\"Reddy\\\"\".

\n \n

If the filter string is empty, ListUsers returns all users in the user\n pool.

\n

You can only search for the following standard attributes:

\n \n

Custom attributes aren't searchable.

\n \n

You can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query parameter of the list-users action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.

\n

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.

\n \n

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.

" + "smithy.api#documentation": "

A filter string of the form \"AttributeName Filter-Type \"AttributeValue\".\n Quotation marks within the filter string must be escaped using the backslash\n (\\) character. For example, \"family_name =\n \\\"Reddy\\\"\".

\n \n

If the filter string is empty, ListUsers returns all users in the user\n pool.

\n

You can only search for the following standard attributes:

\n \n

Custom attributes aren't searchable.

\n \n

You can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query parameter of the list-users action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.

\n

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.

\n \n

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.

" } } }, @@ -11102,6 +12075,82 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentials": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentialsRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentialsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "

Generates a list of the current user's registered passkey, or webauthN,\n credentials.

", + "smithy.api#optionalAuth": {} + } + }, + "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentialsRequest": { + "type": "structure", + "members": { + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

A valid access token that Amazon Cognito issued to the user whose registered passkeys you want\n to list.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialsQueryLimitType", + "traits": { + "smithy.api#documentation": "

The maximum number of the user's passkey credentials that you want to\n return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentialsResponse": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialDescriptionListType", + "traits": { + "smithy.api#documentation": "

A list of registered passkeys for a user.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", + "traits": { + "smithy.api#documentation": "

An identifier that you can use in a later request to return the next set of items in\n the list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#LogConfigurationListType": { "type": "list", "member": { @@ -11151,7 +12200,7 @@ } }, "traits": { - "smithy.api#documentation": "

The logging parameters of a user pool.

" + "smithy.api#documentation": "

The configuration of user event logs to an external Amazon Web Services service like\n Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.

\n

This data type is a request parameter of SetLogDeliveryConfiguration and a response parameter of\n GetLogDeliveryConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#LogDeliveryConfigurationType": { @@ -11173,7 +12222,7 @@ } }, "traits": { - "smithy.api#documentation": "

The logging parameters of a user pool returned in response to\n GetLogDeliveryConfiguration.

" + "smithy.api#documentation": "

The logging parameters of a user pool, as returned in the response to a GetLogDeliveryConfiguration request.

" } }, "com.amazonaws.cognitoidentityprovider#LogLevel": { @@ -11253,6 +12302,76 @@ "smithy.api#documentation": "

\n This data type is no longer supported. Applies only to SMS\n multi-factor authentication (MFA) configurations. Does not apply to time-based one-time\n password (TOTP) software token MFA configurations.

" } }, + "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when you attempt to apply a managed login branding style to\n an app client that already has an assigned style.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingIdType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingType": { + "type": "structure", + "members": { + "ManagedLoginBrandingId": { + "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingIdType", + "traits": { + "smithy.api#documentation": "

The ID of the managed login branding style.

" + } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The user pool where the branding style is assigned.

" + } + }, + "UseCognitoProvidedValues": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When true, applies the default branding style options. This option reverts to a\n \"blank\" style that you can modify later in the branding designer.

" + } + }, + "Settings": { + "target": "com.amazonaws.cognitoidentityprovider#Document", + "traits": { + "smithy.api#documentation": "

A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.

" + } + }, + "Assets": { + "target": "com.amazonaws.cognitoidentityprovider#AssetListType", + "traits": { + "smithy.api#documentation": "

An array of image files that you want to apply to roles like backgrounds, logos, and\n icons. Each object must also indicate whether it is for dark mode, light mode, or\n browser-adaptive mode.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A managed login branding style that's assigned to a user pool app client.

\n

This data type is a response parameter of CreateManagedLoginBranding, UpdateManagedLoginBranding, DescribeManagedLoginBranding, and DescribeManagedLoginBrandingByClient.

" + } + }, "com.amazonaws.cognitoidentityprovider#MessageActionType": { "type": "enum", "members": { @@ -11274,13 +12393,13 @@ "type": "structure", "members": { "SMSMessage": { - "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", + "target": "com.amazonaws.cognitoidentityprovider#SmsInviteMessageType", "traits": { "smithy.api#documentation": "

The message template for SMS messages.

" } }, "EmailMessage": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", + "target": "com.amazonaws.cognitoidentityprovider#EmailInviteMessageType", "traits": { "smithy.api#documentation": "

The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

" } @@ -11305,18 +12424,18 @@ "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { - "smithy.api#documentation": "

The device key.

" + "smithy.api#documentation": "

The device key, an identifier used in generating the\n DEVICE_PASSWORD_VERIFIER for device SRP authentication.

" } }, "DeviceGroupKey": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The device group key.

" + "smithy.api#documentation": "

The device group key, an identifier used in generating the\n DEVICE_PASSWORD_VERIFIER for device SRP authentication.

" } } }, "traits": { - "smithy.api#documentation": "

The new device metadata type.

" + "smithy.api#documentation": "

Information that your user pool responds with in AuthenticationResultwhen\n you configure it to remember devices and a user signs in with an unrecognized device.\n Amazon Cognito presents a new device key that you can use to set up device authentication in a \"Remember me on this device\"\n authentication model.

\n

This data type is a response parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.

" } }, "com.amazonaws.cognitoidentityprovider#NotAuthorizedException": { @@ -11341,13 +12460,13 @@ "From": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The email address that is sending the email. The address must be either individually\n verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.

" + "smithy.api#documentation": "

The email address that sends the email message. The address must be either\n individually verified with Amazon Simple Email Service, or from a domain that has been verified with\n Amazon SES.

" } }, "ReplyTo": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The destination to which the receiver of an email should reply to.

" + "smithy.api#documentation": "

The reply-to email address of an email template.

" } }, "SourceArn": { @@ -11360,24 +12479,24 @@ "BlockEmail": { "target": "com.amazonaws.cognitoidentityprovider#NotifyEmailType", "traits": { - "smithy.api#documentation": "

Email template used when a detected risk event is blocked.

" + "smithy.api#documentation": "

The template for the email message that your user pool sends when a detected risk\n event is blocked.

" } }, "NoActionEmail": { "target": "com.amazonaws.cognitoidentityprovider#NotifyEmailType", "traits": { - "smithy.api#documentation": "

The email template used when a detected risk event is allowed.

" + "smithy.api#documentation": "

The template for the email message that your user pool sends when no action is taken\n in response to a detected risk.

" } }, "MfaEmail": { "target": "com.amazonaws.cognitoidentityprovider#NotifyEmailType", "traits": { - "smithy.api#documentation": "

The multi-factor authentication (MFA) email template used when MFA is challenged as\n part of a detected risk.

" + "smithy.api#documentation": "

The template for the email message that your user pool sends when MFA is challenged in\n response to a detected risk.

" } } }, "traits": { - "smithy.api#documentation": "

The notify configuration type.

" + "smithy.api#documentation": "

The configuration for Amazon SES email messages that advanced security features sends to a\n user when your adaptive authentication automated response has a\n Notify action.

\n

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#NotifyEmailType": { @@ -11386,25 +12505,25 @@ "Subject": { "target": "com.amazonaws.cognitoidentityprovider#EmailNotificationSubjectType", "traits": { - "smithy.api#documentation": "

The email subject.

", + "smithy.api#documentation": "

The subject of the threat protection email notification.

", "smithy.api#required": {} } }, "HtmlBody": { "target": "com.amazonaws.cognitoidentityprovider#EmailNotificationBodyType", "traits": { - "smithy.api#documentation": "

The email HTML body.

" + "smithy.api#documentation": "

The body of an email notification formatted in HTML. Choose an HtmlBody\n or a TextBody to send an HTML-formatted or plaintext message,\n respectively.

" } }, "TextBody": { "target": "com.amazonaws.cognitoidentityprovider#EmailNotificationBodyType", "traits": { - "smithy.api#documentation": "

The email text body.

" + "smithy.api#documentation": "

The body of an email notification formatted in plaintext. Choose an\n HtmlBody or a TextBody to send an HTML-formatted or\n plaintext message, respectively.

" } } }, "traits": { - "smithy.api#documentation": "

The notify email type.

" + "smithy.api#documentation": "

The template for email messages that advanced security features sends to a user when\n your threat protection automated response has a Notify\n action.

\n

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#NumberAttributeConstraintsType": { @@ -11424,7 +12543,7 @@ } }, "traits": { - "smithy.api#documentation": "

The minimum and maximum values of an attribute that is of the number data type.

" + "smithy.api#documentation": "

The minimum and maximum values of an attribute that is of the number type, for example\n custom:age.

\n

This data type is part of SchemaAttributeType. It defines the length constraints\n on number-type attributes that you configure in CreateUserPool and UpdateUserPool, and displays the length constraints of\n all number-type attributes in the response to DescribeUserPool\n

" } }, "com.amazonaws.cognitoidentityprovider#OAuthFlowType": { @@ -11489,7 +12608,7 @@ } }, "traits": { - "smithy.api#documentation": "

The message returned when a user's new password matches a previous password and \n doesn't comply with the password-history policy.

", + "smithy.api#documentation": "

The message returned when a user's new password matches a previous password and\n doesn't comply with the password-history policy.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11525,28 +12644,28 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one uppercase letter in their password.

" + "smithy.api#documentation": "

The requirement in a password policy that users must include at least one uppercase\n letter in their password.

" } }, "RequireLowercase": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one lowercase letter in their password.

" + "smithy.api#documentation": "

The requirement in a password policy that users must include at least one lowercase\n letter in their password.

" } }, "RequireNumbers": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one number in their password.

" + "smithy.api#documentation": "

The requirement in a password policy that users must include at least one number in\n their password.

" } }, "RequireSymbols": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one symbol in their password.

" + "smithy.api#documentation": "

The requirement in a password policy that users must include at least one symbol in\n their password.

" } }, "PasswordHistorySize": { @@ -11564,7 +12683,7 @@ } }, "traits": { - "smithy.api#documentation": "

The password policy type.

" + "smithy.api#documentation": "

The password policy settings for a user pool, including complexity, history, and\n length requirements.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException": { @@ -11648,7 +12767,7 @@ } }, "traits": { - "smithy.api#documentation": "

The properties of a pre token generation Lambda trigger.

" + "smithy.api#documentation": "

The properties of a pre token generation Lambda trigger.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#PrecedenceType": { @@ -11707,19 +12826,19 @@ "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { - "smithy.api#documentation": "

The IdP name.

" + "smithy.api#documentation": "

The name of the IdP, for example MySAMLProvider.

" } }, "ProviderType": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType", "traits": { - "smithy.api#documentation": "

The IdP type.

" + "smithy.api#documentation": "

The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0,\n OIDC, and social IdPs. User pools list supported social IdPs by name in this response\n parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.

" } }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the provider was last modified.

" + "smithy.api#documentation": "

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

" } }, "CreationDate": { @@ -11730,7 +12849,7 @@ } }, "traits": { - "smithy.api#documentation": "

A container for IdP details.

" + "smithy.api#documentation": "

The details of a user pool identity provider (IdP), including name and type.

\n

This data type is a response parameter of ListIdentityProviders.

" } }, "com.amazonaws.cognitoidentityprovider#ProviderDetailsType": { @@ -11785,7 +12904,7 @@ } }, "traits": { - "smithy.api#documentation": "

A container for information about an IdP for a user pool.

" + "smithy.api#documentation": "

The characteristics of a source or destination user for linking a federated user\n profile to a local user profile.

\n

This data type is a request parameter of AdminLinkProviderForUser and AdminDisableProviderForUser.

" } }, "com.amazonaws.cognitoidentityprovider#ProvidersListType": { @@ -11859,20 +12978,20 @@ "Priority": { "target": "com.amazonaws.cognitoidentityprovider#PriorityType", "traits": { - "smithy.api#documentation": "

A positive integer specifying priority of a method with 1 being the highest\n priority.

", + "smithy.api#documentation": "

Your priority preference for using the specified attribute in account recovery. The\n highest priority is 1.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.cognitoidentityprovider#RecoveryOptionNameType", "traits": { - "smithy.api#documentation": "

The recovery method for a user.

", + "smithy.api#documentation": "

The recovery method that this object sets a recovery option for.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A map containing a priority as a key, and recovery method name as a value.

" + "smithy.api#documentation": "

A recovery option for a user. The AccountRecoverySettingType data type is\n an array of this object. Each RecoveryOptionType has a priority property\n that determines whether it is a primary or secondary option.

\n

For example, if verified_email has a priority of 1 and\n verified_phone_number has a priority of 2, your user pool\n sends account-recovery messages to a verified email address but falls back to an SMS\n message if the user has a verified phone number. The admin_only option\n prevents self-service account recovery.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#RedirectUrlType": { @@ -11904,6 +13023,15 @@ } } }, + "com.amazonaws.cognitoidentityprovider#RelyingPartyIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, "com.amazonaws.cognitoidentityprovider#ResendConfirmationCode": { "type": "operation", "input": { @@ -11961,7 +13089,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Resends the confirmation (for confirmation of registration) to a specific user in the\n user pool.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", + "smithy.api#documentation": "

Resends the confirmation (for confirmation of registration) to a specific user in the\n user pool.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -12027,6 +13155,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#ResourceIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + }, + "smithy.api#pattern": "^[\\w\\- ]+$" + } + }, "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException": { "type": "structure", "members": { @@ -12100,20 +13238,20 @@ "ScopeName": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeNameType", "traits": { - "smithy.api#documentation": "

The name of the scope.

", + "smithy.api#documentation": "

The name of the scope. Amazon Cognito renders custom scopes in the format\n resourceServerIdentifier/ScopeName. For example, if this parameter is\n exampleScope in the resource server with the identifier\n exampleResourceServer, you request and receive the scope\n exampleResourceServer/exampleScope.

", "smithy.api#required": {} } }, "ScopeDescription": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeDescriptionType", "traits": { - "smithy.api#documentation": "

A description of the scope.

", + "smithy.api#documentation": "

A friendly description of a custom scope.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A resource server scope.

" + "smithy.api#documentation": "

One custom scope associated with a user pool resource server. This data type is a\n member of ResourceServerScopeType. For more information, see \n Scopes, M2M, and API authorization with resource servers.

\n

This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer.

" } }, "com.amazonaws.cognitoidentityprovider#ResourceServerType": { @@ -12122,7 +13260,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool that hosts the resource server.

" + "smithy.api#documentation": "

The ID of the user pool that contains the resource server configuration.

" } }, "Identifier": { @@ -12145,7 +13283,7 @@ } }, "traits": { - "smithy.api#documentation": "

A container for information about a resource server for a user pool.

" + "smithy.api#documentation": "

The details of a resource server configuration and associated custom scopes in a user\n pool.

\n

This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer.

" } }, "com.amazonaws.cognitoidentityprovider#ResourceServersListType": { @@ -12235,7 +13373,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Some API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. A RespondToAuthChallenge API request provides the answer to that\n challenge, like a code or a secure remote password (SRP). The parameters of a response\n to an authentication challenge vary with the type of challenge.

\n

For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", + "smithy.api#documentation": "

Some API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. A RespondToAuthChallenge API request provides the answer to that\n challenge, like a code or a secure remote password (SRP). The parameters of a response\n to an authentication challenge vary with the type of challenge.

\n

For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -12265,7 +13403,7 @@ "ChallengeResponses": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", "traits": { - "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret.

\n \n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, \nthen use the UpdateUserAttributes API operation to modify the value of any additional attributes.

\n \n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" + "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.

\n \n
\n
SELECT_CHALLENGE
\n
\n

\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n

\n

Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.

\n

Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:

\n \n

For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.

\n \n
\n
SMS_OTP
\n
\n

\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, \nthen use the UpdateUserAttributes API operation to modify the value of any additional attributes.

\n \n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "AnalyticsMetadata": { @@ -12403,31 +13541,31 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID.

" + "smithy.api#documentation": "

The ID of the user pool that has the risk configuration applied.

" } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "

The app client ID.

" + "smithy.api#documentation": "

The app client where this configuration is applied. When this parameter isn't present,\n the risk configuration applies to all user pool app clients that don't have\n client-level settings.

" } }, "CompromisedCredentialsRiskConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsRiskConfigurationType", "traits": { - "smithy.api#documentation": "

The compromised credentials risk configuration object, including the\n EventFilter and the EventAction.

" + "smithy.api#documentation": "

Settings for compromised-credentials actions and authentication types with advanced\n security features in full-function ENFORCED mode.

" } }, "AccountTakeoverRiskConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverRiskConfigurationType", "traits": { - "smithy.api#documentation": "

The account takeover risk configuration object, including the\n NotifyConfiguration object and Actions to take if there is\n an account takeover.

" + "smithy.api#documentation": "

The settings for automated responses and notification templates for adaptive\n authentication with advanced security features.

" } }, "RiskExceptionConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#RiskExceptionConfigurationType", "traits": { - "smithy.api#documentation": "

The configuration to override the risk decision.

" + "smithy.api#documentation": "

Exceptions to the risk evaluation configuration, including always-allow and\n always-block IP address ranges.

" } }, "LastModifiedDate": { @@ -12438,7 +13576,7 @@ } }, "traits": { - "smithy.api#documentation": "

The risk configuration type.

" + "smithy.api#documentation": "

The settings of risk configuration for threat protection with advanced security\n features in a user pool.

\n

This data type is a response parameter of DescribeRiskConfiguration and SetRiskConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#RiskDecisionType": { @@ -12470,18 +13608,18 @@ "BlockedIPRangeList": { "target": "com.amazonaws.cognitoidentityprovider#BlockedIPRangeListType", "traits": { - "smithy.api#documentation": "

Overrides the risk decision to always block the pre-authentication requests. The IP\n range is in CIDR notation, a compact representation of an IP address and its routing\n prefix.

" + "smithy.api#documentation": "

An always-block IP address list. Overrides the risk decision and always blocks\n authentication requests. This parameter is displayed and set in CIDR notation.

" } }, "SkippedIPRangeList": { "target": "com.amazonaws.cognitoidentityprovider#SkippedIPRangeListType", "traits": { - "smithy.api#documentation": "

Risk detection isn't performed on the IP addresses in this range list. The IP range is\n in CIDR notation.

" + "smithy.api#documentation": "

An always-allow IP address list. Risk detection isn't performed on the IP addresses in\n this range list. This parameter is displayed and set in CIDR notation.

" } } }, "traits": { - "smithy.api#documentation": "

The type of the configuration to override the risk decision.

" + "smithy.api#documentation": "

Exceptions to the risk evaluation configuration, including always-allow and\n always-block IP address ranges.

\n

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

" } }, "com.amazonaws.cognitoidentityprovider#RiskLevelType": { @@ -12565,12 +13703,12 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether SMS is the preferred MFA method.

" + "smithy.api#documentation": "

Specifies whether SMS is the preferred MFA method. If true, your user pool prompts the\n specified user for a code delivered by SMS message after username-password sign-in\n succeeds.

" } } }, "traits": { - "smithy.api#documentation": "

The type used for enabling SMS multi-factor authentication (MFA) at the user level.\n Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts,\n unless device tracking is turned on and the device has been trusted. If you would like\n MFA to be applied selectively based on the assessed risk level of sign-in attempts,\n deactivate MFA for users and turn on Adaptive Authentication for the user pool.

" + "smithy.api#documentation": "

A user's preference for using SMS message multi-factor authentication (MFA). Turns SMS\n MFA on and off, and can set SMS as preferred when other MFA options are available. You\n can't turn off SMS MFA for any of your users when MFA is required in your user pool; you\n can only set the type that your user prefers.

\n

This data type is a request parameter of SetUserMFAPreference and AdminSetUserMFAPreference.

" } }, "com.amazonaws.cognitoidentityprovider#SchemaAttributeType": { @@ -12623,7 +13761,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of the user attributes and their properties in your user pool. The attribute\n schema contains standard attributes, custom attributes with a custom:\n prefix, and developer attributes with a dev: prefix. For more information,\n see User pool\n attributes.

\n

Developer-only attributes are a legacy feature of user pools, are read-only to all app\n clients. You can create and update developer-only attributes only with IAM-authenticated\n API operations. Use app client read/write permissions instead.

" + "smithy.api#documentation": "

A list of the user attributes and their properties in your user pool. The attribute\n schema contains standard attributes, custom attributes with a custom:\n prefix, and developer attributes with a dev: prefix. For more information,\n see User pool\n attributes.

\n

Developer-only dev: attributes are a legacy feature of user pools, and\n are read-only to all app clients. You can create and update developer-only attributes\n only with IAM-authenticated API operations. Use app client read/write permissions\n instead.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType": { @@ -12728,6 +13866,9 @@ "target": "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfigurationResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -13045,6 +14186,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, + { + "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -13068,7 +14212,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the user pool multi-factor authentication (MFA) configuration.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n " + "smithy.api#documentation": "

Sets the user pool multi-factor authentication (MFA) and passkey configuration.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n " } }, "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfigRequest": { @@ -13104,6 +14248,12 @@ "traits": { "smithy.api#documentation": "

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who\n have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor\n Authentication (MFA) to a user pool. Valid values include:

\n " } + }, + "WebAuthnConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnConfigurationType", + "traits": { + "smithy.api#documentation": "

The configuration of your user pool for passkey, or webauthN, authentication and\n registration. You can set this configuration independent of the MFA configuration\n options in this operation.

" + } } }, "traits": { @@ -13136,6 +14286,12 @@ "traits": { "smithy.api#documentation": "

The MFA configuration. Valid values include:

\n " } + }, + "WebAuthnConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnConfigurationType", + "traits": { + "smithy.api#documentation": "

The configuration of your user pool for passkey, or webauthN, biometric and\n security-key devices.

" + } } }, "traits": { @@ -13213,6 +14369,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#SignInPolicyType": { + "type": "structure", + "members": { + "AllowedFirstAuthFactors": { + "target": "com.amazonaws.cognitoidentityprovider#AllowedFirstAuthFactorsListType", + "traits": { + "smithy.api#documentation": "

The sign-in methods that a user pool supports as the first factor. You can permit\n users to start authentication with a standard username and password, or with other\n one-time password and hardware factors.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The policy for allowed types of authentication in a user pool.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" + } + }, "com.amazonaws.cognitoidentityprovider#SignUp": { "type": "operation", "input": { @@ -13273,7 +14443,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Registers the user in the specified user pool and creates a user name, password, and\n user attributes.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", + "smithy.api#documentation": "

Registers the user in the specified user pool and creates a user name, password, and\n user attributes.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

You might receive a LimitExceeded exception in response to this request\n if you have exceeded a rate quota for email or SMS messages, and if your user pool\n automatically verifies email addresses or phone numbers. When you get this exception in\n the response, the user is successfully created and is in an UNCONFIRMED\n state. You can send a new code with the ResendConfirmationCode request, or confirm the user as an administrator\n with an \n AdminConfirmSignUp request.

", "smithy.api#optionalAuth": {} } }, @@ -13303,8 +14473,7 @@ "Password": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { - "smithy.api#documentation": "

The password of the user you want to register.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The password of the user you want to register.

\n

Users can sign up without a password when your user pool supports passwordless sign-in\n with email or SMS OTPs. To create a user with no password, omit this parameter or submit\n a blank value. You can only create a passwordless user when passwordless sign-in is\n available. See the SignInPolicyType property of CreateUserPool and UpdateUserPool.

" } }, "UserAttributes": { @@ -13366,6 +14535,12 @@ "smithy.api#documentation": "

The 128-bit ID of the authenticated user. This isn't the same as\n username.

", "smithy.api#required": {} } + }, + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "traits": { + "smithy.api#documentation": "

A session Id that you can pass to ConfirmSignUp when you want to\n immediately sign in your user with the USER_AUTH flow after they complete\n sign-up.

" + } } }, "traits": { @@ -13398,7 +14573,7 @@ "ExternalId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The external ID provides additional security for your IAM role. You can use an\n ExternalId with the IAM role that you use with Amazon SNS to send SMS\n messages for your user pool. If you provide an ExternalId, your Amazon Cognito user\n pool includes it in the request to assume your IAM role. You can configure the role\n trust policy to require that Amazon Cognito, and any principal, provide the\n ExternalID. If you use the Amazon Cognito Management Console to create a role\n for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required\n permissions and a trust policy that demonstrates use of the\n ExternalId.

\n

For more information about the ExternalId of a role, see How to use an\n external ID when granting access to your Amazon Web Services resources to a third\n party\n

" + "smithy.api#documentation": "

The external ID provides additional security for your IAM role. You can use an\n ExternalId with the IAM role that you use with Amazon SNS to send SMS\n messages for your user pool. If you provide an ExternalId, your Amazon Cognito user\n pool includes it in the request to assume your IAM role. You can configure the role\n trust policy to require that Amazon Cognito, and any principal, provide the\n ExternalID. If you use the Amazon Cognito Management Console to create a role\n for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required\n permissions and a trust policy that demonstrates use of the\n ExternalId.

\n

For more information about the ExternalId of a role, see How to use an\n external ID when granting access to your Amazon Web Services resources to a third\n party.

" } }, "SnsRegion": { @@ -13409,7 +14584,17 @@ } }, "traits": { - "smithy.api#documentation": "

The SMS configuration type is the settings that your Amazon Cognito user pool must use to send\n an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS\n messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an\n Identity and Access Management (IAM) role in your Amazon Web Services account.

" + "smithy.api#documentation": "

User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS\n messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an\n Identity and Access Management (IAM) role in your Amazon Web Services account.

\n

This data type is a request parameter of CreateUserPool, UpdateUserPool, and SetUserPoolMfaConfig, and a response parameter of\n CreateUserPool, UpdateUserPool, and GetUserPoolMfaConfig.

" + } + }, + "com.amazonaws.cognitoidentityprovider#SmsInviteMessageType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 140 + }, + "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType": { @@ -13418,18 +14603,18 @@ "SmsAuthenticationMessage": { "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { - "smithy.api#documentation": "

The SMS message that your user pool sends to users with an MFA code. The message must\n contain the {####} placeholder. In the message, Amazon Cognito replaces this\n placeholder with the code. If you don't provide this parameter, Amazon Cognito sends\n messages in the default format.

" + "smithy.api#documentation": "

The SMS authentication message that will be sent to users with the code they must sign\n in with. The message must contain the {####} placeholder. Your user pool\n replaces the placeholder with the MFA code. If this parameter isn't provided, your user\n pool sends a default message.

" } }, "SmsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { - "smithy.api#documentation": "

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an\n SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in\n the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that\n you provide for your Amazon Web Services account.

" + "smithy.api#documentation": "

User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS\n messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an\n Identity and Access Management (IAM) role in your Amazon Web Services account.

\n

You can set SmsConfiguration in CreateUserPool and \n UpdateUserPool, or in SetUserPoolMfaConfig.

" } } }, "traits": { - "smithy.api#documentation": "

Configures user pool SMS messages for multi-factor authentication (MFA). Sets the\n message template and the SMS message sending configuration for Amazon SNS.

" + "smithy.api#documentation": "

The configuration of multi-factor authentication (MFA) with SMS messages in a user\n pool.

\n

This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.

" } }, "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType": { @@ -13473,12 +14658,12 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether software token MFA is activated.

" + "smithy.api#documentation": "

The activation state of TOTP MFA.

" } } }, "traits": { - "smithy.api#documentation": "

Configures a user pool for time-based one-time password (TOTP) multi-factor\n authentication (MFA). Enables or disables TOTP.

" + "smithy.api#documentation": "

Settings for time-based one-time password (TOTP) multi-factor authentication (MFA) in\n a user pool. Enables and disables availability of this feature.

\n

This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.

" } }, "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType": { @@ -13500,7 +14685,7 @@ } }, "traits": { - "smithy.api#documentation": "

The type used for enabling software token MFA at the user level. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts,\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.

" + "smithy.api#documentation": "

A user's preference for using time-based one-time password (TOTP) multi-factor\n authentication (MFA). Turns TOTP MFA on and off, and can set TOTP as preferred when\n other MFA options are available. You can't turn off TOTP MFA for any of your users when\n MFA is required in your user pool; you can only set the type that your user prefers.

\n

This data type is a request parameter of SetUserMFAPreference and AdminSetUserMFAPreference.

" } }, "com.amazonaws.cognitoidentityprovider#StartUserImportJob": { @@ -13573,6 +14758,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnConfigurationMissingException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnNotEnabledException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "

Requests credential creation options from your user pool for registration of a passkey\n authenticator. Returns information about the user pool, the user profile, and\n authentication requirements. Users must provide this information in their request to\n enroll your application with their passkey provider.

\n

After users present this data and register with their passkey provider, return the\n response to your user pool in a CompleteWebAuthnRegistration API request.

\n

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

", + "smithy.api#optionalAuth": {} + } + }, + "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistrationRequest": { + "type": "structure", + "members": { + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

A valid access token that Amazon Cognito issued to the user whose passkey metadata you want to\n generate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistrationResponse": { + "type": "structure", + "members": { + "CredentialCreationOptions": { + "target": "com.amazonaws.cognitoidentityprovider#Document", + "traits": { + "smithy.api#documentation": "

The information that a user can provide in their request to register with their\n passkey provider.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#StatusType": { "type": "enum", "members": { @@ -13666,7 +14921,7 @@ "MinLength": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The minimum length.

" + "smithy.api#documentation": "

The minimum length of a string attribute value.

" } }, "MaxLength": { @@ -13677,7 +14932,7 @@ } }, "traits": { - "smithy.api#documentation": "

The constraints associated with a string attribute.

" + "smithy.api#documentation": "

The minimum and maximum length values of an attribute that is of the string type, for\n example custom:department.

\n

This data type is part of SchemaAttributeType. It defines the length constraints\n on string-type attributes that you configure in CreateUserPool and UpdateUserPool, and displays the length constraints of\n all string-type attributes in the response to DescribeUserPool\n

" } }, "com.amazonaws.cognitoidentityprovider#StringType": { @@ -13781,6 +15036,19 @@ } } }, + "com.amazonaws.cognitoidentityprovider#TierChangeNotAllowedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when you've attempted to change your feature plan but\n the operation isn't permitted.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.cognitoidentityprovider#TimeUnitsType": { "type": "enum", "members": { @@ -13823,24 +15091,24 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the AccessTokenValidity\n parameter. The default AccessTokenValidity time unit is hours.\n AccessTokenValidity duration can range from five minutes to one\n day.

" + "smithy.api#documentation": "

A time unit for the value that you set in the AccessTokenValidity\n parameter. The default AccessTokenValidity time unit is hours.\n AccessTokenValidity duration can range from five minutes to one\n day.

" } }, "IdToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the IdTokenValidity\n parameter. The default IdTokenValidity time unit is hours.\n IdTokenValidity duration can range from five minutes to one day.

" + "smithy.api#documentation": "

A time unit for the value that you set in the IdTokenValidity parameter.\n The default IdTokenValidity time unit is hours.\n IdTokenValidity duration can range from five minutes to one day.

" } }, "RefreshToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the\n RefreshTokenValidity parameter. The default\n RefreshTokenValidity time unit is days.\n RefreshTokenValidity duration can range from 60 minutes to 10\n years.

" + "smithy.api#documentation": "

A time unit for the value that you set in the RefreshTokenValidity\n parameter. The default RefreshTokenValidity time unit is days.\n RefreshTokenValidity duration can range from 60 minutes to 10\n years.

" } } }, "traits": { - "smithy.api#documentation": "

The data type TokenValidityUnits specifies the time units you use when you set the\n duration of ID, access, and refresh tokens.

" + "smithy.api#documentation": "

The time units that, with IdTokenValidity,\n AccessTokenValidity, and RefreshTokenValidity, set and\n display the duration of ID, access, and refresh tokens for an app client. You can assign\n a separate token validity unit to each type of token.

\n

This data type is a request parameter of CreateUserPoolClient and UpdateUserPoolClient, and a response parameter of\n DescribeUserPoolClient.

" } }, "com.amazonaws.cognitoidentityprovider#TooManyFailedAttemptsException": { @@ -13881,25 +15149,25 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

" + "smithy.api#documentation": "

The ID of the user pool with hosted UI customizations.

" } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "

The client ID for the client app.

" + "smithy.api#documentation": "

The app client ID for your UI customization. When this value isn't present, the\n customization applies to all user pool app clients that don't have client-level\n settings..

" } }, "ImageUrl": { "target": "com.amazonaws.cognitoidentityprovider#ImageUrlType", "traits": { - "smithy.api#documentation": "

The logo image for the UI customization.

" + "smithy.api#documentation": "

A URL path to the hosted logo image of your UI customization.

" } }, "CSS": { "target": "com.amazonaws.cognitoidentityprovider#CSSType", "traits": { - "smithy.api#documentation": "

The CSS values in the UI customization.

" + "smithy.api#documentation": "

The CSS values in the UI customization. To get a template with your UI customization\n options, make a GetUiCustomization request.

" } }, "CSSVersion": { @@ -13922,7 +15190,7 @@ } }, "traits": { - "smithy.api#documentation": "

A container for the UI customization information for a user pool's built-in app\n UI.

" + "smithy.api#documentation": "

A container for the UI customization information for the hosted UI in a user\n pool.

\n

This data type is a response parameter of GetUICustomization.

" } }, "com.amazonaws.cognitoidentityprovider#UnauthorizedException": { @@ -14410,6 +15678,91 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBranding": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBrandingRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBrandingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Configures the branding settings for a user pool style. This operation is the\n programmatic option for the configuration of a style in the branding designer.

\n

Provides values for UI customization in a Settings JSON object and image\n files in an Assets array.

\n

This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.

\n

For more information, see API and SDK operations for managed login branding.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + } + }, + "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBrandingRequest": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool that contains the managed login branding style that you want\n to update.

" + } + }, + "ManagedLoginBrandingId": { + "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingIdType", + "traits": { + "smithy.api#documentation": "

The ID of the managed login branding style that you want to update.

" + } + }, + "UseCognitoProvidedValues": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When true, applies the default branding style options. This option reverts to default\n style options that are managed by Amazon Cognito. You can modify them later in the branding\n designer.

\n

When you specify true for this option, you must also omit values for\n Settings and Assets in the request.

" + } + }, + "Settings": { + "target": "com.amazonaws.cognitoidentityprovider#Document", + "traits": { + "smithy.api#documentation": "

A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.

" + } + }, + "Assets": { + "target": "com.amazonaws.cognitoidentityprovider#AssetListType", + "traits": { + "smithy.api#documentation": "

An array of image files that you want to apply to roles like backgrounds, logos, and\n icons. Each object must also indicate whether it is for dark mode, light mode, or\n browser-adaptive mode.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBrandingResponse": { + "type": "structure", + "members": { + "ManagedLoginBranding": { + "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingType", + "traits": { + "smithy.api#documentation": "

The details of the branding style that you updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#UpdateResourceServer": { "type": "operation", "input": { @@ -14558,7 +15911,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

With this operation, your users can update one or more of their attributes with their\n own credentials. You authorize this API request with the user's access token. To delete\n an attribute from your user, submit the attribute in your API request with a blank\n value. Custom attribute values in this request must include the custom:\n prefix.

\n

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", + "smithy.api#documentation": "

With this operation, your users can update one or more of their attributes with their\n own credentials. You authorize this API request with the user's access token. To delete\n an attribute from your user, submit the attribute in your API request with a blank\n value. Custom attribute values in this request must include the custom:\n prefix.

\n

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -14618,6 +15971,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, + { + "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -14639,6 +15995,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, + { + "target": "com.amazonaws.cognitoidentityprovider#TierChangeNotAllowedException" + }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, @@ -14650,7 +16009,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Updates the specified user pool with the specified attributes. You can get a list of\n the current user pool settings using DescribeUserPool.

\n \n

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " + "smithy.api#documentation": "\n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Updates the specified user pool with the specified attributes. You can get a list of\n the current user pool settings using DescribeUserPool.

\n \n

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolClient": { @@ -14754,13 +16113,13 @@ "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in \nyour users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and \npassword, or a custom authentication process that you define with Lambda functions.

\n \n

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

\n \n

Valid values include:

\n \n

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. \nYou can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,\nlike ALLOW_USER_SRP_AUTH.

" + "smithy.api#documentation": "

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in \nyour users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and \npassword, or a custom authentication process that you define with Lambda functions.

\n \n

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

\n \n

Valid values include:

\n \n

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. \nYou can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,\nlike ALLOW_USER_SRP_AUTH.

" } }, "SupportedIdentityProviders": { "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "

A list of provider names for the IdPs that this client supports. The following are\n supported: COGNITO, Facebook, Google,\n SignInWithApple, LoginWithAmazon, and the names of your\n own SAML and OIDC providers.

" + "smithy.api#documentation": "

A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO, Facebook,\n Google, SignInWithApple, and LoginWithAmazon.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP or MyOIDCIdP.

\n

This setting applies to providers that you can access with the hosted\n UI and OAuth 2.0 authorization server. The removal of COGNITO\n from this list doesn't prevent authentication operations for local users with the\n user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to\n block access with a WAF rule.

" } }, "CallbackURLs": { @@ -14821,7 +16180,7 @@ "EnablePropagateAdditionalUserContextData": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

" + "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

" } }, "AuthSessionValidity": { @@ -14860,6 +16219,9 @@ "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomainResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -14897,10 +16259,16 @@ "smithy.api#required": {} } }, + "ManagedLoginVersion": { + "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", + "traits": { + "smithy.api#documentation": "

A version number that indicates the state of managed login for your domain. Version\n 1 is hosted UI (classic). Version 2 is the newer managed\n login with the branding designer. For more information, see Managed login.

" + } + }, "CustomDomainConfig": { "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", "traits": { - "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in pages for\n your application. Use this object to specify an SSL certificate that is managed by\n ACM.

", + "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in pages for\n your application. Use this object to specify an SSL certificate that is managed by\n ACM.

\n

When you create a custom domain, the passkey RP ID defaults to the custom domain. If\n you had a prefix domain active, this will cause passkey integration for your prefix\n domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey\n integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID\n in a SetUserPoolMfaConfig request.

", "smithy.api#required": {} } } @@ -14913,6 +16281,12 @@ "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomainResponse": { "type": "structure", "members": { + "ManagedLoginVersion": { + "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", + "traits": { + "smithy.api#documentation": "

A version number that indicates the state of managed login for your domain. Version\n 1 is hosted UI (classic). Version 2 is the newer managed\n login with the branding designer. For more information, see Managed login.

" + } + }, "CloudFrontDomain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { @@ -15042,6 +16416,18 @@ "traits": { "smithy.api#documentation": "

The available verified method a user can use to recover their password when they call\n ForgotPassword. You can use this setting to define a preferred method\n when a user has more than one method available. With this setting, SMS doesn't qualify\n for a valid password recovery mechanism if the user also has SMS multi-factor\n authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\n behavior to determine the recovery method where SMS is preferred through email.

" } + }, + "PoolName": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", + "traits": { + "smithy.api#documentation": "

The updated name of your user pool.

" + } + }, + "UserPoolTier": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolTierType", + "traits": { + "smithy.api#documentation": "

The user pool feature plan, or tier. This parameter determines the\n eligibility of the user pool for features like managed login, access-token\n customization, and threat protection. Defaults to ESSENTIALS.

" + } } }, "traits": { @@ -15068,7 +16454,7 @@ } }, "traits": { - "smithy.api#documentation": "

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to email addresses and phone numbers.

" + "smithy.api#documentation": "

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to email addresses and phone numbers.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#UserContextDataType": { @@ -15088,7 +16474,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

", + "smithy.api#documentation": "

Contextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

\n

This data type is a request parameter of public-client authentication operations like\n InitiateAuth and RespondToAuthChallenge.

", "smithy.api#sensitive": {} } }, @@ -15196,25 +16582,25 @@ "JobName": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobNameType", "traits": { - "smithy.api#documentation": "

The job name for the user import job.

" + "smithy.api#documentation": "

The friendly name of the user import job.

" } }, "JobId": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", "traits": { - "smithy.api#documentation": "

The job ID for the user import job.

" + "smithy.api#documentation": "

The ID of the user import job.

" } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool that the users are being imported into.

" + "smithy.api#documentation": "

The ID of the user pool that the users are being imported into.

" } }, "PreSignedUrl": { "target": "com.amazonaws.cognitoidentityprovider#PreSignedUrlType", "traits": { - "smithy.api#documentation": "

The pre-signed URL to be used to upload the .csv file.

" + "smithy.api#documentation": "

The pre-signed URL target for uploading the CSV file.

" } }, "CreationDate": { @@ -15276,7 +16662,7 @@ } }, "traits": { - "smithy.api#documentation": "

The user import job type.

" + "smithy.api#documentation": "

A user import job in a user pool. Describes the status of user import with a CSV file.\n For more information, see Importing users into user pools from a CSV file.

\n

This data type is a request parameter of CreateUserImportJob, DescribeUserImportJob, ListUserImportJobs, StartUserImportJob, and StopUserImportJob.

" } }, "com.amazonaws.cognitoidentityprovider#UserImportJobsListType": { @@ -15364,7 +16750,7 @@ "AdvancedSecurityMode": { "target": "com.amazonaws.cognitoidentityprovider#AdvancedSecurityModeType", "traits": { - "smithy.api#documentation": "

The operating mode of advanced security features for standard authentication types\n in your user pool, including username-password and secure remote password (SRP)\n authentication.\n

", + "smithy.api#documentation": "

The operating mode of advanced security features for standard authentication types in\n your user pool, including username-password and secure remote password (SRP)\n authentication.

", "smithy.api#required": {} } }, @@ -15376,7 +16762,7 @@ } }, "traits": { - "smithy.api#documentation": "

User pool add-ons. Contains settings for activation of advanced security features. To\n log user security information but take no action, set to AUDIT. To\n configure automatic security responses to risky traffic to your user pool, set to\n ENFORCED.

\n

For more information, see Adding advanced security to a user pool.

" + "smithy.api#documentation": "

User pool add-ons. Contains settings for activation of advanced security features. To\n log user security information but take no action, set to AUDIT. To\n configure automatic security responses to risky traffic to your user pool, set to\n ENFORCED.

\n

For more information, see Adding advanced security to a user pool.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#UserPoolClientDescription": { @@ -15385,24 +16771,24 @@ "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "

The ID of the client associated with the user pool.

" + "smithy.api#documentation": "

The app client ID.

" } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool where you want to describe the user pool\n client.

" + "smithy.api#documentation": "

The ID of the user pool that's associated with the app client.

" } }, "ClientName": { "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", "traits": { - "smithy.api#documentation": "

The client name from the user pool client description.

" + "smithy.api#documentation": "

The app client name.

" } } }, "traits": { - "smithy.api#documentation": "

The description of the user pool client.

" + "smithy.api#documentation": "

A short description of a user pool app client.

\n

This data type is a response parameter of ListUserPoolClients.

" } }, "com.amazonaws.cognitoidentityprovider#UserPoolClientListType": { @@ -15417,25 +16803,25 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool client.

" + "smithy.api#documentation": "

The ID of the user pool associated with the app client.

" } }, "ClientName": { "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", "traits": { - "smithy.api#documentation": "

The client name from the user pool request of the client type.

" + "smithy.api#documentation": "

The name of the app client.

" } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "

The ID of the client associated with the user pool.

" + "smithy.api#documentation": "

The ID of the app client.

" } }, "ClientSecret": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", "traits": { - "smithy.api#documentation": "

The client secret from the user pool request of the client type.

" + "smithy.api#documentation": "

The app client secret.

" } }, "LastModifiedDate": { @@ -15472,7 +16858,7 @@ "TokenValidityUnits": { "target": "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType", "traits": { - "smithy.api#documentation": "

The time units used to specify the token validity times of each token type: ID,\n access, and refresh.

" + "smithy.api#documentation": "

The time units that, with IdTokenValidity,\n AccessTokenValidity, and RefreshTokenValidity, set and\n display the duration of ID, access, and refresh tokens for an app client. You can assign\n a separate token validity unit to each type of token.

" } }, "ReadAttributes": { @@ -15490,13 +16876,13 @@ "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in \nyour users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and \npassword, or a custom authentication process that you define with Lambda functions.

\n \n

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

\n \n

Valid values include:

\n \n

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. \nYou can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,\nlike ALLOW_USER_SRP_AUTH.

" + "smithy.api#documentation": "

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in \nyour users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and \npassword, or a custom authentication process that you define with Lambda functions.

\n \n

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

\n \n

Valid values include:

\n \n

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. \nYou can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,\nlike ALLOW_USER_SRP_AUTH.

" } }, "SupportedIdentityProviders": { "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "

A list of provider names for the IdPs that this client supports. The following are\n supported: COGNITO, Facebook, Google,\n SignInWithApple, LoginWithAmazon, and the names of your\n own SAML and OIDC providers.

" + "smithy.api#documentation": "

A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO, Facebook,\n Google, SignInWithApple, and LoginWithAmazon.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP or MyOIDCIdP.

\n

This setting applies to providers that you can access with the hosted\n UI and OAuth 2.0 authorization server. The removal of COGNITO\n from this list doesn't prevent authentication operations for local users with the\n user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to\n block access with a WAF rule.

" } }, "CallbackURLs": { @@ -15520,13 +16906,13 @@ "AllowedOAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", "traits": { - "smithy.api#documentation": "

The allowed OAuth flows.

\n
\n
code
\n
\n

Use a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token endpoint.

\n
\n
implicit
\n
\n

Issue the access token (and, optionally, ID token, based on scopes)\n directly to your user.

\n
\n
client_credentials
\n
\n

Issue the access token from the /oauth2/token endpoint\n directly to a non-person user using a combination of the client ID and\n client secret.

\n
\n
" + "smithy.api#documentation": "

The OAuth grant types that you want your app client to generate. To create an app\n client that generates client credentials grants, you must add\n client_credentials as the only allowed OAuth flow.

\n
\n
code
\n
\n

Use a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token endpoint.

\n
\n
implicit
\n
\n

Issue the access token (and, optionally, ID token, based on scopes)\n directly to your user.

\n
\n
client_credentials
\n
\n

Issue the access token from the /oauth2/token endpoint\n directly to a non-person user using a combination of the client ID and\n client secret.

\n
\n
" } }, "AllowedOAuthScopes": { "target": "com.amazonaws.cognitoidentityprovider#ScopeListType", "traits": { - "smithy.api#documentation": "

The OAuth scopes that your app client supports. Possible values that OAuth provides\n are phone, email, openid, and\n profile. Possible values that Amazon Web Services provides are\n aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that\n you create in Resource Servers.

" + "smithy.api#documentation": "

The OAuth 2.0 scopes that you want your app client to support. Can include standard\n OAuth scopes like phone, email, openid, and\n profile. Can also include the\n aws.cognito.signin.user.admin scope that authorizes user profile\n self-service operations and custom scopes from resource servers.

" } }, "AllowedOAuthFlowsUserPoolClient": { @@ -15539,7 +16925,7 @@ "AnalyticsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for the user pool client.

\n \n

Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East\n (N. Virginia) us-east-1 Region, regardless of the Region where the user pool\n resides.

\n " + "smithy.api#documentation": "

The user pool analytics configuration for collecting metrics and sending them to your\n Amazon Pinpoint campaign.

\n \n

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending\n events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is\n available, user pools support sending events to Amazon Pinpoint projects within that same\n Region.

\n " } }, "PreventUserExistenceErrors": { @@ -15568,7 +16954,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about a user pool client.

" + "smithy.api#documentation": "

The configuration of a user pool client.

\n

This data type is a request parameter of CreateUserPoolClient and UpdateUserPoolClient, and a response parameter of\n DescribeUserPoolClient.

" } }, "com.amazonaws.cognitoidentityprovider#UserPoolDescriptionType": { @@ -15577,19 +16963,19 @@ "Id": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The ID in a user pool description.

" + "smithy.api#documentation": "

The user pool ID.

" } }, "Name": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", "traits": { - "smithy.api#documentation": "

The name in a user pool description.

" + "smithy.api#documentation": "

The user pool name.

" } }, "LambdaConfig": { "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", "traits": { - "smithy.api#documentation": "

The Lambda configuration information in a user pool description.

" + "smithy.api#documentation": "

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of user pool operations. Triggers can modify the outcome of the operations that\n invoked them.

" } }, "Status": { @@ -15598,7 +16984,7 @@ "smithy.api#deprecated": { "message": "This property is no longer available." }, - "smithy.api#documentation": "

The user pool status in a user pool description.

" + "smithy.api#documentation": "

The user pool status.

" } }, "LastModifiedDate": { @@ -15615,7 +17001,7 @@ } }, "traits": { - "smithy.api#documentation": "

A user pool description.

" + "smithy.api#documentation": "

A short description of a user pool.

\n

This data type is a response parameter of ListUserPools.

" } }, "com.amazonaws.cognitoidentityprovider#UserPoolIdType": { @@ -15673,12 +17059,18 @@ "PasswordPolicy": { "target": "com.amazonaws.cognitoidentityprovider#PasswordPolicyType", "traits": { - "smithy.api#documentation": "

The password policy.

" + "smithy.api#documentation": "

The password policy settings for a user pool, including complexity, history, and\n length requirements.

" + } + }, + "SignInPolicy": { + "target": "com.amazonaws.cognitoidentityprovider#SignInPolicyType", + "traits": { + "smithy.api#documentation": "

The policy for allowed types of authentication in a user pool.

" } } }, "traits": { - "smithy.api#documentation": "

The policy associated with a user pool.

" + "smithy.api#documentation": "

A list of user pool policies. Contains the policy that sets password-complexity\n requirements.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#UserPoolTaggingException": { @@ -15709,6 +17101,29 @@ "target": "com.amazonaws.cognitoidentityprovider#TagValueType" } }, + "com.amazonaws.cognitoidentityprovider#UserPoolTierType": { + "type": "enum", + "members": { + "LITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LITE" + } + }, + "ESSENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ESSENTIALS" + } + }, + "PLUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLUS" + } + } + } + }, "com.amazonaws.cognitoidentityprovider#UserPoolType": { "type": "structure", "members": { @@ -15727,7 +17142,7 @@ "Policies": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", "traits": { - "smithy.api#documentation": "

The policies associated with the user pool.

" + "smithy.api#documentation": "

A list of user pool policies. Contains the policy that sets password-complexity\n requirements.

" } }, "DeletionProtection": { @@ -15739,7 +17154,7 @@ "LambdaConfig": { "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", "traits": { - "smithy.api#documentation": "

The Lambda triggers associated with the user pool.

" + "smithy.api#documentation": "

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of user pool operations. Triggers can modify the outcome of the operations that\n invoked them.

" } }, "Status": { @@ -15766,7 +17181,7 @@ "SchemaAttributes": { "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType", "traits": { - "smithy.api#documentation": "

A list of the user attributes and their properties in your user pool. The attribute\n schema contains standard attributes, custom attributes with a custom:\n prefix, and developer attributes with a dev: prefix. For more information,\n see User pool\n attributes.

\n

Developer-only attributes are a legacy feature of user pools, are read-only to all app\n clients. You can create and update developer-only attributes only with IAM-authenticated\n API operations. Use app client read/write permissions instead.

" + "smithy.api#documentation": "

A list of the user attributes and their properties in your user pool. The attribute\n schema contains standard attributes, custom attributes with a custom:\n prefix, and developer attributes with a dev: prefix. For more information,\n see User pool\n attributes.

\n

Developer-only attributes are a legacy feature of user pools, and are read-only to all\n app clients. You can create and update developer-only attributes only with\n IAM-authenticated API operations. Use app client read/write permissions instead.

" } }, "AutoVerifiedAttributes": { @@ -15778,7 +17193,7 @@ "AliasAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AliasAttributesListType", "traits": { - "smithy.api#documentation": "

The attributes that are aliased in a user pool.

" + "smithy.api#documentation": "

Attributes supported as an alias for this user pool. An alias is an attribute that\n users can enter as an alternative username. Possible values: phone_number, email, or preferred_username.

" } }, "UsernameAttributes": { @@ -15808,7 +17223,7 @@ "VerificationMessageTemplate": { "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", "traits": { - "smithy.api#documentation": "

The template for verification messages.

" + "smithy.api#documentation": "

The template for the verification message that your user pool delivers to users who\n set an email address or phone number attribute.

" } }, "SmsAuthenticationMessage": { @@ -15851,7 +17266,7 @@ "SmsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { - "smithy.api#documentation": "

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an\n SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages\n with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management\n (IAM) role in your Amazon Web Services account.

" + "smithy.api#documentation": "

User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS\n messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an\n Identity and Access Management (IAM) role in your Amazon Web Services account.

" } }, "UserPoolTags": { @@ -15899,13 +17314,13 @@ "UsernameConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", "traits": { - "smithy.api#documentation": "

Case sensitivity of the username input for the selected sign-in option. For example,\n when case sensitivity is set to False, users can sign in using either\n \"username\" or \"Username\". This configuration is immutable once it has been set. For more\n information, see UsernameConfigurationType.

" + "smithy.api#documentation": "

Case sensitivity of the username input for the selected sign-in option. When case\n sensitivity is set to False (case insensitive), users can sign in with any\n combination of capital and lowercase letters. For example, username,\n USERNAME, or UserName, or for email,\n email@example.com or EMaiL@eXamplE.Com. For most use\n cases, set case sensitivity to False (case insensitive) as a best practice.\n When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in\n case as the same user, and prevents a case variation from being assigned to the same\n attribute for a different user.

\n

This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

" } }, "Arn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user pool.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user pool.

" } }, "AccountRecoverySetting": { @@ -15913,10 +17328,16 @@ "traits": { "smithy.api#documentation": "

The available verified method a user can use to recover their password when they call\n ForgotPassword. You can use this setting to define a preferred method\n when a user has more than one method available. With this setting, SMS doesn't qualify\n for a valid password recovery mechanism if the user also has SMS multi-factor\n authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\n behavior to determine the recovery method where SMS is preferred through email.

" } + }, + "UserPoolTier": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolTierType", + "traits": { + "smithy.api#documentation": "

The user pool feature plan, or tier. This parameter determines the\n eligibility of the user pool for features like managed login, access-token\n customization, and threat protection. Defaults to ESSENTIALS.

" + } } }, "traits": { - "smithy.api#documentation": "

A container for information about the user pool.

" + "smithy.api#documentation": "

The configuration of a user pool.

\n

This data type is a response parameter of CreateUserPool, UpdateUserPool, and DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#UserStatusType": { @@ -15978,19 +17399,19 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The user name of the user you want to describe.

" + "smithy.api#documentation": "

The user's username.

" } }, "Attributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "

A container with information about the user type attributes.

" + "smithy.api#documentation": "

Names and values of a user's attributes, for example email.

" } }, "UserCreateDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The creation date of the user.

" + "smithy.api#documentation": "

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

" } }, "UserLastModifiedDate": { @@ -16003,7 +17424,7 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the user is enabled.

" + "smithy.api#documentation": "

Indicates whether the user's account is enabled or disabled.

" } }, "UserStatus": { @@ -16015,12 +17436,29 @@ "MFAOptions": { "target": "com.amazonaws.cognitoidentityprovider#MFAOptionListType", "traits": { - "smithy.api#documentation": "

The MFA options for the user.

" + "smithy.api#documentation": "

The user's MFA configuration.

" } } }, "traits": { - "smithy.api#documentation": "

A user profile in a Amazon Cognito user pool.

" + "smithy.api#documentation": "

A user profile in a Amazon Cognito user pool.

\n

This data type is a response parameter to AdminCreateUser and ListUsers.

" + } + }, + "com.amazonaws.cognitoidentityprovider#UserVerificationType": { + "type": "enum", + "members": { + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "PREFERRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "preferred" + } + } } }, "com.amazonaws.cognitoidentityprovider#UsernameAttributeType": { @@ -16052,13 +17490,13 @@ "CaseSensitive": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "

Specifies whether user name case sensitivity will be applied for all users in the user\n pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False\n (case insensitive) as a best practice. When usernames and email addresses are case\n insensitive, users can sign in as the same user when they enter a different\n capitalization of their user name.

\n

Valid values include:

\n
\n
True
\n
\n

Enables case sensitivity for all username input. When this option is set\n to True, users must sign in using the exact capitalization of\n their given username, such as “UserName”. This is the default value.

\n
\n
False
\n
\n

Enables case insensitivity for all username input. For example, when this\n option is set to False, users can sign in using\n username, USERNAME, or UserName.\n This option also enables both preferred_username and\n email alias to be case insensitive, in addition to the\n username attribute.

\n
\n
", + "smithy.api#documentation": "

Specifies whether user name case sensitivity will be applied for all users in the user\n pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False\n (case insensitive) as a best practice. When usernames and email addresses are case\n insensitive, users can sign in as the same user when they enter a different\n capitalization of their user name.

\n

Valid values include:

\n
\n
true
\n
\n

Enables case sensitivity for all username input. When this option is set\n to true, users must sign in using the exact capitalization of\n their given username, such as “UserName”. This is the default value.

\n
\n
false
\n
\n

Enables case insensitivity for all username input. For example, when this\n option is set to false, users can sign in using\n username, USERNAME, or UserName.\n This option also enables both preferred_username and\n email alias to be case insensitive, in addition to the\n username attribute.

\n
\n
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The username configuration type.

" + "smithy.api#documentation": "

The configuration of a user pool for username case sensitivity.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#UsernameExistsException": { @@ -16130,12 +17568,12 @@ "DefaultEmailOption": { "target": "com.amazonaws.cognitoidentityprovider#DefaultEmailOptionType", "traits": { - "smithy.api#documentation": "

The default email option.

" + "smithy.api#documentation": "

The configuration of verification emails to contain a clickable link or a verification\n code.

\n

For link, your template body must contain link text in the format {##Click\n here##}. \"Click here\" in the example is a customizable string. For code, your\n template body must contain a code placeholder in the format {####}.

" } } }, "traits": { - "smithy.api#documentation": "

The template for verification messages.

" + "smithy.api#documentation": "

The template for the verification message that your user pool delivers to users who\n set an email address or phone number attribute.

\n

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

" } }, "com.amazonaws.cognitoidentityprovider#VerifiedAttributeType": { @@ -16379,8 +17817,198 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorAttachmentType": { + "type": "string" + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorTransportType": { + "type": "string" + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorTransportsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorTransportType" + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnChallengeNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when the challenge from StartWebAuthn\n registration has expired.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnClientMismatchException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when the access token is for a different client than the one\n in the original StartWebAuthnRegistration request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnConfigurationMissingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when a user pool doesn't have a configured relying party\n id or a user pool domain.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnConfigurationType": { + "type": "structure", + "members": { + "RelyingPartyId": { + "target": "com.amazonaws.cognitoidentityprovider#RelyingPartyIdType", + "traits": { + "smithy.api#documentation": "

Sets or displays the authentication domain, typically your user pool domain, that\n passkey providers must use as a relying party (RP) in their configuration.

\n

Under the following conditions, the passkey relying party ID must be the\n fully-qualified domain name of your custom domain:

\n " + } + }, + "UserVerification": { + "target": "com.amazonaws.cognitoidentityprovider#UserVerificationType", + "traits": { + "smithy.api#documentation": "

Sets or displays your user-pool treatment for MFA with a passkey. You can override\n other MFA options and require passkey MFA, or you can set it as preferred. When passkey\n MFA is preferred, the hosted UI encourages users to register a passkey at\n sign-in.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for multi-factor authentication (MFA) with passkey, or webauthN, biometric\n and security-key devices in a user pool. Configures the following:

\n \n

This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.

" + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialDescription": { + "type": "structure", + "members": { + "CredentialId": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The unique identifier of the passkey credential.

", + "smithy.api#required": {} + } + }, + "FriendlyCredentialName": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

An automatically-generated friendly name for the passkey credential.

", + "smithy.api#required": {} + } + }, + "RelyingPartyId": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The relying-party ID of the provider for the passkey credential.

", + "smithy.api#required": {} + } + }, + "AuthenticatorAttachment": { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorAttachmentType", + "traits": { + "smithy.api#documentation": "

The general category of the passkey authenticator. Can be a platform, or on-device\n authenticator like a built-in fingerprint scanner, or a cross-platform device that's not\n attached to the device like a Bluetooth security key.

" + } + }, + "AuthenticatorTransports": { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorTransportsList", + "traits": { + "smithy.api#documentation": "

Information about the transport methods of the passkey credential, for example USB or\n Bluetooth Low Energy.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a passkey, or webauthN, biometric or security-key authentication factor\n for a user.

\n

This data type is a response parameter of ListWebAuthnCredentials.

" + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialDescriptionListType": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialDescription" + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialNotSupportedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when a user presents passkey credentials from an unsupported\n device or provider.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialsQueryLimitType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnNotEnabledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when the passkey feature isn't enabled for the user\n pool.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnOriginNotAllowedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when the passkey credential's registration origin does not\n align with the user pool relying party id.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentityprovider#WebAuthnRelyingPartyMismatchException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when the given passkey credential is associated with a\n different relying party ID than the user pool relying party ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cognitoidentityprovider#WrappedBooleanType": { "type": "boolean" + }, + "com.amazonaws.cognitoidentityprovider#WrappedIntegerType": { + "type": "integer" } } } diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 976b9fd8376..681e6a261d8 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -231,6 +231,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#AdditionalEmailRecipients": { + "type": "structure", + "members": { + "ToList": { + "target": "com.amazonaws.connect#EmailRecipientsList", + "traits": { + "smithy.api#documentation": "

" + } + }, + "CcList": { + "target": "com.amazonaws.connect#EmailRecipientsList", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, "com.amazonaws.connect#AfterContactWorkTimeLimit": { "type": "integer", "traits": { @@ -938,6 +958,9 @@ { "target": "com.amazonaws.connect#CreateAgentStatus" }, + { + "target": "com.amazonaws.connect#CreateContact" + }, { "target": "com.amazonaws.connect#CreateContactFlow" }, @@ -947,6 +970,9 @@ { "target": "com.amazonaws.connect#CreateContactFlowVersion" }, + { + "target": "com.amazonaws.connect#CreateEmailAddress" + }, { "target": "com.amazonaws.connect#CreateEvaluationForm" }, @@ -1025,6 +1051,9 @@ { "target": "com.amazonaws.connect#DeleteContactFlowModule" }, + { + "target": "com.amazonaws.connect#DeleteEmailAddress" + }, { "target": "com.amazonaws.connect#DeleteEvaluationForm" }, @@ -1100,6 +1129,9 @@ { "target": "com.amazonaws.connect#DescribeContactFlowModule" }, + { + "target": "com.amazonaws.connect#DescribeEmailAddress" + }, { "target": "com.amazonaws.connect#DescribeEvaluationForm" }, @@ -1244,6 +1276,9 @@ { "target": "com.amazonaws.connect#ListApprovedOrigins" }, + { + "target": "com.amazonaws.connect#ListAssociatedContacts" + }, { "target": "com.amazonaws.connect#ListAuthenticationProfiles" }, @@ -1409,6 +1444,9 @@ { "target": "com.amazonaws.connect#SearchContacts" }, + { + "target": "com.amazonaws.connect#SearchEmailAddresses" + }, { "target": "com.amazonaws.connect#SearchHoursOfOperations" }, @@ -1445,6 +1483,9 @@ { "target": "com.amazonaws.connect#SendChatIntegrationEvent" }, + { + "target": "com.amazonaws.connect#SendOutboundEmail" + }, { "target": "com.amazonaws.connect#StartAttachedFileUpload" }, @@ -1460,9 +1501,15 @@ { "target": "com.amazonaws.connect#StartContactStreaming" }, + { + "target": "com.amazonaws.connect#StartEmailContact" + }, { "target": "com.amazonaws.connect#StartOutboundChatContact" }, + { + "target": "com.amazonaws.connect#StartOutboundEmailContact" + }, { "target": "com.amazonaws.connect#StartOutboundVoiceContact" }, @@ -1541,6 +1588,9 @@ { "target": "com.amazonaws.connect#UpdateContactSchedule" }, + { + "target": "com.amazonaws.connect#UpdateEmailAddressMetadata" + }, { "target": "com.amazonaws.connect#UpdateEvaluationForm" }, @@ -1580,6 +1630,9 @@ { "target": "com.amazonaws.connect#UpdateQueueOutboundCallerConfig" }, + { + "target": "com.amazonaws.connect#UpdateQueueOutboundEmailConfig" + }, { "target": "com.amazonaws.connect#UpdateQueueStatus" }, @@ -3690,6 +3743,74 @@ "smithy.api#input": {} } }, + "com.amazonaws.connect#AssociatedContactSummary": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ContactArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

" + } + }, + "InitiationTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

" + } + }, + "DisconnectTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

" + } + }, + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "PreviousContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "RelatedContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "InitiationMethod": { + "target": "com.amazonaws.connect#ContactInitiationMethod", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#AssociatedContactSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AssociatedContactSummary" + } + }, "com.amazonaws.connect#AssociatedQueueIdList": { "type": "list", "member": { @@ -3834,6 +3955,23 @@ } } }, + "com.amazonaws.connect#AttachedFileServiceQuotaExceededExceptionReason": { + "type": "enum", + "members": { + "TOTAL_FILE_SIZE_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL_FILE_SIZE_EXCEEDED" + } + }, + "TOTAL_FILE_COUNT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL_FILE_COUNT_EXCEEDED" + } + } + } + }, "com.amazonaws.connect#AttachedFilesList": { "type": "list", "member": { @@ -3869,6 +4007,12 @@ "traits": { "smithy.api#documentation": "

Status of the attachment reference type.

" } + }, + "Arn": { + "target": "com.amazonaws.connect#ReferenceArn", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { @@ -4696,6 +4840,16 @@ } } }, + "com.amazonaws.connect#Body": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5242880 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.connect#Boolean": { "type": "boolean", "traits": { @@ -4769,6 +4923,12 @@ "traits": { "smithy.api#enumValue": "TASK" } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } } } }, @@ -4795,7 +4955,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 3 + "max": 4 } } }, @@ -5276,6 +5436,19 @@ "smithy.api#documentation": "

A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and\n ProficiencyLimit.

" } }, + "com.amazonaws.connect#ConditionalOperationFailedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.connect#Conditions": { "type": "list", "member": { @@ -5342,6 +5515,12 @@ "smithy.api#documentation": "

If this contact is not the first contact, this is the ID of the previous contact.

" } }, + "ContactAssociationId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + }, "InitiationMethod": { "target": "com.amazonaws.connect#ContactInitiationMethod", "traits": { @@ -5438,6 +5617,18 @@ "smithy.api#documentation": "

Information about Amazon Connect Wisdom.

" } }, + "CustomerEndpoint": { + "target": "com.amazonaws.connect#EndpointInfo", + "traits": { + "smithy.api#documentation": "

" + } + }, + "SystemEndpoint": { + "target": "com.amazonaws.connect#EndpointInfo", + "traits": { + "smithy.api#documentation": "

" + } + }, "QueueTimeAdjustmentSeconds": { "target": "com.amazonaws.connect#QueueTimeAdjustmentSeconds", "traits": { @@ -5501,6 +5692,12 @@ "smithy.api#documentation": "

Information about the call disconnect experience.

" } }, + "AdditionalEmailRecipients": { + "target": "com.amazonaws.connect#AdditionalEmailRecipients", + "traits": { + "smithy.api#documentation": "

" + } + }, "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { @@ -6259,6 +6456,24 @@ "traits": { "smithy.api#enumValue": "EXTERNAL_OUTBOUND" } + }, + "WEBRTC_API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEBRTC_API" + } + }, + "AGENT_REPLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_REPLY" + } + }, + "FLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOW" + } } } }, @@ -6359,6 +6574,12 @@ "traits": { "smithy.api#documentation": "

The timestamp, in Unix epoch time format, at which to start running the inbound flow.

" } + }, + "SegmentAttributes": { + "target": "com.amazonaws.connect#ContactSearchSummarySegmentAttributes", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { @@ -6405,6 +6626,29 @@ "smithy.api#documentation": "

If this contact was queued, this contains information about the queue.

" } }, + "com.amazonaws.connect#ContactSearchSummarySegmentAttributeValue": { + "type": "structure", + "members": { + "ValueString": { + "target": "com.amazonaws.connect#SegmentAttributeValueString", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#ContactSearchSummarySegmentAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#SegmentAttributeName" + }, + "value": { + "target": "com.amazonaws.connect#ContactSearchSummarySegmentAttributeValue" + } + }, "com.amazonaws.connect#ContactState": { "type": "enum", "members": { @@ -6751,6 +6995,52 @@ "smithy.api#documentation": "

The CreateCase action definition.

" } }, + "com.amazonaws.connect#CreateContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#ConflictException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/create-contact", + "code": 200 + } + } + }, "com.amazonaws.connect#CreateContactFlow": { "type": "operation", "input": { @@ -7101,6 +7391,232 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#CreateContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#idempotencyToken": {} + } + }, + "RelatedContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

" + } + }, + "References": { + "target": "com.amazonaws.connect#ContactReferences", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "InitiationMethod": { + "target": "com.amazonaws.connect#ContactInitiationMethod", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "ExpiryDurationInMinutes": { + "target": "com.amazonaws.connect#ExpiryDurationInMinutes", + "traits": { + "smithy.api#documentation": "

" + } + }, + "UserInfo": { + "target": "com.amazonaws.connect#UserInfo", + "traits": { + "smithy.api#documentation": "

" + } + }, + "InitiateAs": { + "target": "com.amazonaws.connect#InitiateAs", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Name": { + "target": "com.amazonaws.connect#Name", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

" + } + }, + "SegmentAttributes": { + "target": "com.amazonaws.connect#SegmentAttributes", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#CreateContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ContactArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.connect#CreateEmailAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateEmailAddressRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateEmailAddressResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "PUT", + "uri": "/email-addresses/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateEmailAddressRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "EmailAddress": { + "target": "com.amazonaws.connect#EmailAddress", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.connect#EmailAddressDisplayName", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#CreateEmailAddressResponse": { + "type": "structure", + "members": { + "EmailAddressId": { + "target": "com.amazonaws.connect#EmailAddressId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailAddressArn": { + "target": "com.amazonaws.connect#EmailAddressArn", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#CreateEvaluationForm": { "type": "operation", "input": { @@ -7958,6 +8474,12 @@ "smithy.api#documentation": "

The outbound caller ID name, number, and outbound whisper flow.

" } }, + "OutboundEmailConfig": { + "target": "com.amazonaws.connect#OutboundEmailConfig", + "traits": { + "smithy.api#documentation": "

" + } + }, "HoursOfOperationId": { "target": "com.amazonaws.connect#HoursOfOperationId", "traits": { @@ -8561,6 +9083,12 @@ "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" } }, + "SelfAssignFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

" + } + }, "Constraints": { "target": "com.amazonaws.connect#TaskTemplateConstraints", "traits": { @@ -9651,6 +10179,9 @@ "smithy.api#documentation": "

Information about the Customer on the contact.

" } }, + "com.amazonaws.connect#CustomerProfileAttributesSerialized": { + "type": "string" + }, "com.amazonaws.connect#CustomerQualityMetrics": { "type": "structure", "members": { @@ -10138,82 +10669,18 @@ "smithy.api#output": {} } }, - "com.amazonaws.connect#DeleteEvaluationForm": { + "com.amazonaws.connect#DeleteEmailAddress": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DeleteEvaluationFormRequest" + "target": "com.amazonaws.connect#DeleteEmailAddressRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.connect#DeleteEmailAddressResponse" }, "errors": [ { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" + "target": "com.amazonaws.connect#AccessDeniedException" }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an evaluation form in the specified Amazon Connect instance.

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/evaluation-forms/{InstanceId}/{EvaluationFormId}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.connect#DeleteEvaluationFormRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "EvaluationFormId": { - "target": "com.amazonaws.connect#ResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the evaluation form.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "EvaluationFormVersion": { - "target": "com.amazonaws.connect#VersionNumber", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The unique identifier for the evaluation form.

", - "smithy.api#httpQuery": "version" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.connect#DeleteHoursOfOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteHoursOfOperationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" }, @@ -10223,6 +10690,9 @@ { "target": "com.amazonaws.connect#InvalidRequestException" }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, { "target": "com.amazonaws.connect#ResourceNotFoundException" }, @@ -10231,73 +10701,29 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes an hours of operation.

", + "smithy.api#documentation": "

", "smithy.api#http": { "method": "DELETE", - "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", + "uri": "/email-addresses/{InstanceId}/{EmailAddressId}", "code": 200 } } }, - "com.amazonaws.connect#DeleteHoursOfOperationRequest": { + "com.amazonaws.connect#DeleteEmailAddressRequest": { "type": "structure", "members": { "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#documentation": "

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "HoursOfOperationId": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier for the hours of operation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.connect#DeleteInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes the Amazon Connect instance. For more information, see Delete your\n Amazon Connect instance in the Amazon Connect Administrator\n Guide.

\n

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "EmailAddressId": { + "target": "com.amazonaws.connect#EmailAddressId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#documentation": "

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10307,65 +10733,17 @@ "smithy.api#input": {} } }, - "com.amazonaws.connect#DeleteIntegrationAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteIntegrationAssociationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The\n association must not have any use cases associated with it.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteIntegrationAssociationRequest": { + "com.amazonaws.connect#DeleteEmailAddressResponse": { "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IntegrationAssociationId": { - "target": "com.amazonaws.connect#IntegrationAssociationId", - "traits": { - "smithy.api#documentation": "

The identifier for the integration association.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, + "members": {}, "traits": { - "smithy.api#input": {} + "smithy.api#output": {} } }, - "com.amazonaws.connect#DeletePredefinedAttribute": { + "com.amazonaws.connect#DeleteEvaluationForm": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DeletePredefinedAttributeRequest" + "target": "com.amazonaws.connect#DeleteEvaluationFormRequest" }, "output": { "target": "smithy.api#Unit" @@ -10378,10 +10756,7 @@ "target": "com.amazonaws.connect#InvalidParameterException" }, { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceInUseException" + "target": "com.amazonaws.connect#ResourceConflictException" }, { "target": "com.amazonaws.connect#ResourceNotFoundException" @@ -10391,43 +10766,51 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a predefined attribute from the specified Amazon Connect instance.

", + "smithy.api#documentation": "

Deletes an evaluation form in the specified Amazon Connect instance.

\n ", "smithy.api#http": { "method": "DELETE", - "uri": "/predefined-attributes/{InstanceId}/{Name}", + "uri": "/evaluation-forms/{InstanceId}/{EvaluationFormId}", "code": 200 }, "smithy.api#idempotent": {} } }, - "com.amazonaws.connect#DeletePredefinedAttributeRequest": { + "com.amazonaws.connect#DeleteEvaluationFormRequest": { "type": "structure", "members": { "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource\n Name (ARN) of the instance.

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.connect#PredefinedAttributeName", + "EvaluationFormId": { + "target": "com.amazonaws.connect#ResourceId", "traits": { - "smithy.api#documentation": "

The name of the predefined attribute.

", + "smithy.api#documentation": "

The unique identifier for the evaluation form.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "EvaluationFormVersion": { + "target": "com.amazonaws.connect#VersionNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The unique identifier for the evaluation form.

", + "smithy.api#httpQuery": "version" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.connect#DeletePrompt": { + "com.amazonaws.connect#DeleteHoursOfOperation": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DeletePromptRequest" + "target": "com.amazonaws.connect#DeleteHoursOfOperationRequest" }, "output": { "target": "smithy.api#Unit" @@ -10450,15 +10833,15 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a prompt.

", + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes an hours of operation.

", "smithy.api#http": { "method": "DELETE", - "uri": "/prompts/{InstanceId}/{PromptId}", + "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", "code": 200 } } }, - "com.amazonaws.connect#DeletePromptRequest": { + "com.amazonaws.connect#DeleteHoursOfOperationRequest": { "type": "structure", "members": { "InstanceId": { @@ -10469,10 +10852,10 @@ "smithy.api#required": {} } }, - "PromptId": { - "target": "com.amazonaws.connect#PromptId", + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", "traits": { - "smithy.api#documentation": "

A unique identifier for the prompt.

", + "smithy.api#documentation": "

The identifier for the hours of operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10482,10 +10865,10 @@ "smithy.api#input": {} } }, - "com.amazonaws.connect#DeleteQueue": { + "com.amazonaws.connect#DeleteInstance": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DeleteQueueRequest" + "target": "com.amazonaws.connect#DeleteInstanceRequest" }, "output": { "target": "smithy.api#Unit" @@ -10494,32 +10877,23 @@ { "target": "com.amazonaws.connect#InternalServiceException" }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, { "target": "com.amazonaws.connect#InvalidRequestException" }, - { - "target": "com.amazonaws.connect#ResourceInUseException" - }, { "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.

", + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes the Amazon Connect instance. For more information, see Delete your\n Amazon Connect instance in the Amazon Connect Administrator\n Guide.

\n

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.

", "smithy.api#http": { "method": "DELETE", - "uri": "/queues/{InstanceId}/{QueueId}", + "uri": "/instance/{InstanceId}", "code": 200 } } }, - "com.amazonaws.connect#DeleteQueueRequest": { + "com.amazonaws.connect#DeleteInstanceRequest": { "type": "structure", "members": { "InstanceId": { @@ -10529,24 +10903,16 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.connect#DeleteQuickConnect": { + "com.amazonaws.connect#DeleteIntegrationAssociation": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DeleteQuickConnectRequest" + "target": "com.amazonaws.connect#DeleteIntegrationAssociationRequest" }, "output": { "target": "smithy.api#Unit" @@ -10555,9 +10921,6 @@ { "target": "com.amazonaws.connect#InternalServiceException" }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, { "target": "com.amazonaws.connect#InvalidRequestException" }, @@ -10569,15 +10932,15 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a quick connect.

\n \n

After calling DeleteUser, it's important to\n call DeleteQuickConnect to delete any records related to the deleted users. This\n will help you:

\n \n ", + "smithy.api#documentation": "

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The\n association must not have any use cases associated with it.

", "smithy.api#http": { "method": "DELETE", - "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", + "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}", "code": 200 } } }, - "com.amazonaws.connect#DeleteQuickConnectRequest": { + "com.amazonaws.connect#DeleteIntegrationAssociationRequest": { "type": "structure", "members": { "InstanceId": { @@ -10588,10 +10951,10 @@ "smithy.api#required": {} } }, - "QuickConnectId": { - "target": "com.amazonaws.connect#QuickConnectId", + "IntegrationAssociationId": { + "target": "com.amazonaws.connect#IntegrationAssociationId", "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#documentation": "

The identifier for the integration association.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10601,10 +10964,249 @@ "smithy.api#input": {} } }, - "com.amazonaws.connect#DeleteRoutingProfile": { + "com.amazonaws.connect#DeletePredefinedAttribute": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DeleteRoutingProfileRequest" + "target": "com.amazonaws.connect#DeletePredefinedAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a predefined attribute from the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/predefined-attributes/{InstanceId}/{Name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connect#DeletePredefinedAttributeRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource\n Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#PredefinedAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the predefined attribute.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#DeletePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeletePromptRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a prompt.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/prompts/{InstanceId}/{PromptId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeletePromptRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PromptId": { + "target": "com.amazonaws.connect#PromptId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the prompt.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#DeleteQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/queues/{InstanceId}/{QueueId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteQueueRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#DeleteQuickConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteQuickConnectRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a quick connect.

\n \n

After calling DeleteUser, it's important to\n call DeleteQuickConnect to delete any records related to the deleted users. This\n will help you:

\n \n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteQuickConnectRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#DeleteRoutingProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteRoutingProfileRequest" }, "output": { "target": "smithy.api#Unit" @@ -11772,6 +12374,123 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#DescribeEmailAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeEmailAddressRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeEmailAddressResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "GET", + "uri": "/email-addresses/{InstanceId}/{EmailAddressId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeEmailAddressRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "EmailAddressId": { + "target": "com.amazonaws.connect#EmailAddressId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#DescribeEmailAddressResponse": { + "type": "structure", + "members": { + "EmailAddressId": { + "target": "com.amazonaws.connect#EmailAddressId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailAddressArn": { + "target": "com.amazonaws.connect#EmailAddressArn", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailAddress": { + "target": "com.amazonaws.connect#EmailAddress", + "traits": { + "smithy.api#documentation": "

" + } + }, + "DisplayName": { + "target": "com.amazonaws.connect#EmailAddressDisplayName", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

" + } + }, + "CreateTimestamp": { + "target": "com.amazonaws.connect#ISO8601Datetime", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ModifiedTimestamp": { + "target": "com.amazonaws.connect#ISO8601Datetime", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#DescribeEvaluationForm": { "type": "operation", "input": { @@ -14313,6 +15032,305 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.connect#EmailAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connect#EmailAddressArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.connect#EmailAddressDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connect#EmailAddressId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.connect#EmailAddressInfo": { + "type": "structure", + "members": { + "EmailAddress": { + "target": "com.amazonaws.connect#EmailAddress", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.connect#EmailAddressDisplayName", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#EmailAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#EmailAddressMetadata" + } + }, + "com.amazonaws.connect#EmailAddressMetadata": { + "type": "structure", + "members": { + "EmailAddressId": { + "target": "com.amazonaws.connect#EmailAddressId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailAddressArn": { + "target": "com.amazonaws.connect#EmailAddressArn", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailAddress": { + "target": "com.amazonaws.connect#EmailAddress", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

" + } + }, + "DisplayName": { + "target": "com.amazonaws.connect#EmailAddressDisplayName", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#EmailAddressRecipientList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#EmailAddressInfo" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.connect#EmailAddressSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#EmailAddressSearchCriteria" + } + }, + "com.amazonaws.connect#EmailAddressSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#EmailAddressSearchConditionList", + "traits": { + "smithy.api#documentation": "

" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#EmailAddressSearchConditionList", + "traits": { + "smithy.api#documentation": "

" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition" + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#EmailAddressSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#EmailAttachment": { + "type": "structure", + "members": { + "FileName": { + "target": "com.amazonaws.connect#FileName", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "S3Url": { + "target": "com.amazonaws.connect#PreSignedAttachmentUrl", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#EmailAttachments": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#EmailAttachment" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connect#EmailHeaderType": { + "type": "enum", + "members": { + "REFERENCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REFERENCES" + } + }, + "MESSAGE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MESSAGE_ID" + } + }, + "IN_REPLY_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_REPLY_TO" + } + }, + "X_SES_SPAM_VERDICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X_SES_SPAM_VERDICT" + } + }, + "X_SES_VIRUS_VERDICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X_SES_VIRUS_VERDICT" + } + } + } + }, + "com.amazonaws.connect#EmailHeaderValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20000 + } + } + }, + "com.amazonaws.connect#EmailHeaders": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#EmailHeaderType" + }, + "value": { + "target": "com.amazonaws.connect#EmailHeaderValue" + } + }, + "com.amazonaws.connect#EmailMessageContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#EmailMessageReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ReferenceArn", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#EmailRecipient": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.connect#EndpointAddress", + "traits": { + "smithy.api#documentation": "

" + } + }, + "DisplayName": { + "target": "com.amazonaws.connect#EndpointDisplayName", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#EmailRecipientsList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#EmailRecipient" + } + }, "com.amazonaws.connect#EmailReference": { "type": "structure", "members": { @@ -14409,6 +15427,41 @@ } } }, + "com.amazonaws.connect#EndpointDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.connect#EndpointInfo": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.connect#EndpointType", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Address": { + "target": "com.amazonaws.connect#EndpointAddress", + "traits": { + "smithy.api#documentation": "

" + } + }, + "DisplayName": { + "target": "com.amazonaws.connect#EndpointDisplayName", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, "com.amazonaws.connect#EndpointType": { "type": "enum", "members": { @@ -14435,6 +15488,12 @@ "traits": { "smithy.api#enumValue": "CONNECT_PHONENUMBER_ARN" } + }, + "EMAIL_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_ADDRESS" + } } } }, @@ -15888,6 +16947,9 @@ "smithy.api#documentation": "

An object to specify the expiration of a routing step.

" } }, + "com.amazonaws.connect#ExpiryDurationInMinutes": { + "type": "integer" + }, "com.amazonaws.connect#Expression": { "type": "structure", "members": { @@ -16112,7 +17174,8 @@ }, "traits": { "smithy.api#length": { - "min": 1 + "min": 1, + "max": 100 } } }, @@ -16166,6 +17229,12 @@ "com.amazonaws.connect#FileUseCaseType": { "type": "enum", "members": { + "EMAIL_MESSAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_MESSAGE" + } + }, "ATTACHMENT": { "target": "smithy.api#Unit", "traits": { @@ -16258,6 +17327,18 @@ "traits": { "smithy.api#enumValue": "SMS_PHONE_NUMBER" } + }, + "INBOUND_EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INBOUND_EMAIL" + } + }, + "OUTBOUND_EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTBOUND_EMAIL" + } } } }, @@ -17377,6 +18458,12 @@ "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" } }, + "SelfAssignFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

" + } + }, "Constraints": { "target": "com.amazonaws.connect#TaskTemplateConstraints", "traits": { @@ -18680,12 +19767,120 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#InboundAdditionalRecipients": { + "type": "structure", + "members": { + "ToAddresses": { + "target": "com.amazonaws.connect#EmailAddressRecipientList", + "traits": { + "smithy.api#documentation": "

" + } + }, + "CcAddresses": { + "target": "com.amazonaws.connect#EmailAddressRecipientList", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, "com.amazonaws.connect#InboundCallsEnabled": { "type": "boolean" }, + "com.amazonaws.connect#InboundEmailContent": { + "type": "structure", + "members": { + "MessageSourceType": { + "target": "com.amazonaws.connect#InboundMessageSourceType", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "RawMessage": { + "target": "com.amazonaws.connect#InboundRawMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#InboundMessageSourceType": { + "type": "enum", + "members": { + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RAW" + } + } + } + }, + "com.amazonaws.connect#InboundRawMessage": { + "type": "structure", + "members": { + "Subject": { + "target": "com.amazonaws.connect#InboundSubject", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "Body": { + "target": "com.amazonaws.connect#Body", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.connect#EmailMessageContentType", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "Headers": { + "target": "com.amazonaws.connect#EmailHeaders", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#InboundSubject": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 998 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.connect#Index": { "type": "integer" }, + "com.amazonaws.connect#InitiateAs": { + "type": "enum", + "members": { + "CONNECTED_TO_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTED_TO_USER" + } + } + } + }, "com.amazonaws.connect#InitiationMethodList": { "type": "list", "member": { @@ -19080,6 +20275,12 @@ "traits": { "smithy.api#enumValue": "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS" } + }, + "EMAIL_MESSAGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_MESSAGES" + } } } }, @@ -19304,6 +20505,12 @@ "traits": { "smithy.api#enumValue": "FILE_SCANNER" } + }, + "SES_IDENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SES_IDENTITY" + } } } }, @@ -19971,6 +21178,107 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#ListAssociatedContacts": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListAssociatedContactsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListAssociatedContactsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "GET", + "uri": "/contact/associated/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#ListAssociatedContactsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpQuery": "contactId", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#ListAssociatedContactsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ListAssociatedContactsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#ListAssociatedContactsResponse": { + "type": "structure", + "members": { + "ContactSummaryList": { + "target": "com.amazonaws.connect#AssociatedContactSummaryList", + "traits": { + "smithy.api#documentation": "

" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ListAuthenticationProfiles": { "type": "operation", "input": { @@ -20944,6 +22252,18 @@ "traits": { "smithy.api#enumValue": "VOICE_PHONE_NUMBER" } + }, + "INBOUND_EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INBOUND_EMAIL" + } + }, + "OUTBOUND_EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTBOUND_EMAIL" + } } } }, @@ -24466,6 +25786,24 @@ "com.amazonaws.connect#Message": { "type": "string" }, + "com.amazonaws.connect#MessageTemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.connect#MessageTemplateKnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, "com.amazonaws.connect#MetadataUrl": { "type": "string", "traits": { @@ -24779,7 +26117,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 512 + "max": 1024 }, "smithy.api#sensitive": {} } @@ -25089,6 +26427,20 @@ "target": "com.amazonaws.connect#Origin" } }, + "com.amazonaws.connect#OutboundAdditionalRecipients": { + "type": "structure", + "members": { + "CcEmailAddresses": { + "target": "com.amazonaws.connect#EmailAddressRecipientList", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, "com.amazonaws.connect#OutboundCallerConfig": { "type": "structure", "members": { @@ -25147,6 +26499,112 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.connect#OutboundEmailConfig": { + "type": "structure", + "members": { + "OutboundEmailAddressId": { + "target": "com.amazonaws.connect#EmailAddressId", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#OutboundEmailContent": { + "type": "structure", + "members": { + "MessageSourceType": { + "target": "com.amazonaws.connect#OutboundMessageSourceType", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "TemplatedMessageConfig": { + "target": "com.amazonaws.connect#TemplatedMessageConfig", + "traits": { + "smithy.api#documentation": "

" + } + }, + "RawMessage": { + "target": "com.amazonaws.connect#OutboundRawMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#OutboundMessageSourceType": { + "type": "enum", + "members": { + "TEMPLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEMPLATE" + } + }, + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RAW" + } + } + } + }, + "com.amazonaws.connect#OutboundRawMessage": { + "type": "structure", + "members": { + "Subject": { + "target": "com.amazonaws.connect#OutboundSubject", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "Body": { + "target": "com.amazonaws.connect#Body", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.connect#EmailMessageContentType", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#OutboundRequestId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.connect#OutboundSubject": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 998 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.connect#OutputTypeNotFoundException": { "type": "structure", "members": { @@ -27231,6 +28689,15 @@ } } }, + "com.amazonaws.connect#PreSignedAttachmentUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, "com.amazonaws.connect#PredefinedAttribute": { "type": "structure", "members": { @@ -27847,6 +29314,12 @@ "smithy.api#documentation": "

The outbound caller ID name, number, and outbound whisper flow.

" } }, + "OutboundEmailConfig": { + "target": "com.amazonaws.connect#OutboundEmailConfig", + "traits": { + "smithy.api#documentation": "

" + } + }, "HoursOfOperationId": { "target": "com.amazonaws.connect#HoursOfOperationId", "traits": { @@ -29206,8 +30679,9 @@ "Value": { "target": "com.amazonaws.connect#ReferenceValue", "traits": { - "smithy.api#documentation": "

A valid value for the reference. For example, for a URL reference, a formatted URL that is\n displayed to an agent in the Contact Control Panel (CCP).

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "

A valid value for the reference. For example, for a URL reference, a formatted URL that is\n displayed to an agent in the Contact Control Panel (CCP).

" } }, "Type": { @@ -29216,12 +30690,40 @@ "smithy.api#documentation": "

The type of the reference. DATE must be of type Epoch timestamp.\n

", "smithy.api#required": {} } + }, + "Status": { + "target": "com.amazonaws.connect#ReferenceStatus", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ReferenceArn", + "traits": { + "smithy.api#documentation": "

" + } + }, + "StatusReason": { + "target": "com.amazonaws.connect#ReferenceStatusReason", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { "smithy.api#documentation": "

Well-formed data on a contact, used by agents to complete a contact request. You can have up\n to 4,096 UTF-8 bytes across all references for a contact.

" } }, + "com.amazonaws.connect#ReferenceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 256 + }, + "smithy.api#pattern": "^[-:/A-Za-z0-9]+$" + } + }, "com.amazonaws.connect#ReferenceId": { "type": "string", "traits": { @@ -29243,6 +30745,18 @@ "com.amazonaws.connect#ReferenceStatus": { "type": "enum", "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, "APPROVED": { "target": "smithy.api#Unit", "traits": { @@ -29254,6 +30768,27 @@ "traits": { "smithy.api#enumValue": "REJECTED" } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.connect#ReferenceStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 } } }, @@ -29272,6 +30807,12 @@ "smithy.api#documentation": "

Information about the reference when the referenceType is\n ATTACHMENT. Otherwise, null.

" } }, + "EmailMessage": { + "target": "com.amazonaws.connect#EmailMessageReference", + "traits": { + "smithy.api#documentation": "

" + } + }, "String": { "target": "com.amazonaws.connect#StringReference", "traits": { @@ -29322,6 +30863,12 @@ "smithy.api#enumValue": "ATTACHMENT" } }, + "CONTACT_ANALYSIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACT_ANALYSIS" + } + }, "NUMBER": { "target": "smithy.api#Unit", "traits": { @@ -29345,6 +30892,12 @@ "traits": { "smithy.api#enumValue": "EMAIL" } + }, + "EMAIL_MESSAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_MESSAGE" + } } } }, @@ -31462,12 +33015,120 @@ "traits": { "smithy.api#documentation": "

The search criteria based on user-defined contact attributes that have been configured for\n contact search. For more information, see Search by custom contact\n attributes in the Amazon Connect Administrator Guide.

\n \n

To use SearchableContactAttributes in a search request, the\n GetContactAttributes action is required to perform an API request. For more\n information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.

\n " } + }, + "SearchableSegmentAttributes": { + "target": "com.amazonaws.connect#SearchableSegmentAttributes", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { "smithy.api#documentation": "

A structure of search criteria to be used to return contacts.

" } }, + "com.amazonaws.connect#SearchEmailAddresses": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchEmailAddressesRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchEmailAddressesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "POST", + "uri": "/search-email-addresses", + "code": 200 + } + } + }, + "com.amazonaws.connect#SearchEmailAddressesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#documentation": "

" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "

" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#EmailAddressSearchCriteria", + "traits": { + "smithy.api#documentation": "

" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#EmailAddressSearchFilter", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SearchEmailAddressesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailAddresses": { + "target": "com.amazonaws.connect#EmailAddressList", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#SearchHoursOfOperations": { "type": "operation", "input": { @@ -32635,7 +34296,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 0, + "min": 1, "max": 100 }, "smithy.api#sensitive": {} @@ -32729,6 +34390,94 @@ } } }, + "com.amazonaws.connect#SearchableSegmentAttributeKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connect#SearchableSegmentAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connect#SearchableSegmentAttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SearchableSegmentAttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connect#SearchableSegmentAttributes": { + "type": "structure", + "members": { + "Criteria": { + "target": "com.amazonaws.connect#SearchableSegmentAttributesCriteriaList", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "MatchType": { + "target": "com.amazonaws.connect#SearchContactsMatchType", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#SearchableSegmentAttributesCriteria": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.connect#SearchableSegmentAttributeKey", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.connect#SearchableSegmentAttributeValueList", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.connect#SearchableSegmentAttributesCriteriaList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SearchableSegmentAttributesCriteria" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + } + } + }, "com.amazonaws.connect#SecurityKey": { "type": "structure", "members": { @@ -33062,7 +34811,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 1024 } } @@ -33213,11 +34962,124 @@ "smithy.api#documentation": "

Information about the send notification action.

" } }, + "com.amazonaws.connect#SendOutboundEmail": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SendOutboundEmailRequest" + }, + "output": { + "target": "com.amazonaws.connect#SendOutboundEmailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/outbound-email", + "code": 200 + } + } + }, + "com.amazonaws.connect#SendOutboundEmailRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FromEmailAddress": { + "target": "com.amazonaws.connect#EmailAddressInfo", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "DestinationEmailAddress": { + "target": "com.amazonaws.connect#EmailAddressInfo", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "AdditionalRecipients": { + "target": "com.amazonaws.connect#OutboundAdditionalRecipients", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailMessage": { + "target": "com.amazonaws.connect#OutboundEmailContent", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "TrafficType": { + "target": "com.amazonaws.connect#TrafficType", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "SourceCampaign": { + "target": "com.amazonaws.connect#SourceCampaign", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SendOutboundEmailResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.connect#Message" + }, + "Reason": { + "target": "com.amazonaws.connect#ServiceQuotaExceededExceptionReason" } }, "traits": { @@ -33226,6 +35088,20 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.connect#ServiceQuotaExceededExceptionReason": { + "type": "union", + "members": { + "AttachedFileServiceQuotaExceededExceptionReason": { + "target": "com.amazonaws.connect#AttachedFileServiceQuotaExceededExceptionReason", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, "com.amazonaws.connect#SignInConfig": { "type": "structure", "members": { @@ -33424,6 +35300,26 @@ "smithy.api#pattern": "^[a-zA-Z0-9_ -]+$" } }, + "com.amazonaws.connect#SourceCampaign": { + "type": "structure", + "members": { + "CampaignId": { + "target": "com.amazonaws.connect#CampaignId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "OutboundRequestId": { + "target": "com.amazonaws.connect#OutboundRequestId", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, "com.amazonaws.connect#SourceId": { "type": "string", "traits": { @@ -34009,6 +35905,157 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#StartEmailContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartEmailContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartEmailContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/email", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartEmailContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "FromEmailAddress": { + "target": "com.amazonaws.connect#EmailAddressInfo", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "DestinationEmailAddress": { + "target": "com.amazonaws.connect#EmailAddress", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

" + } + }, + "References": { + "target": "com.amazonaws.connect#ContactReferences", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Name": { + "target": "com.amazonaws.connect#Name", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailMessage": { + "target": "com.amazonaws.connect#InboundEmailContent", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "AdditionalRecipients": { + "target": "com.amazonaws.connect#InboundAdditionalRecipients", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Attachments": { + "target": "com.amazonaws.connect#EmailAttachments", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "RelatedContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

" + } + }, + "SegmentAttributes": { + "target": "com.amazonaws.connect#SegmentAttributes", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#StartEmailContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#StartOutboundChatContact": { "type": "operation", "input": { @@ -34141,6 +36188,115 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#StartOutboundEmailContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartOutboundEmailContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartOutboundEmailContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/outbound-email", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartOutboundEmailContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "FromEmailAddress": { + "target": "com.amazonaws.connect#EmailAddressInfo", + "traits": { + "smithy.api#documentation": "

" + } + }, + "DestinationEmailAddress": { + "target": "com.amazonaws.connect#EmailAddressInfo", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "AdditionalRecipients": { + "target": "com.amazonaws.connect#OutboundAdditionalRecipients", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailMessage": { + "target": "com.amazonaws.connect#OutboundEmailContent", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#StartOutboundEmailContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#StartOutboundVoiceContact": { "type": "operation", "input": { @@ -34478,6 +36634,12 @@ "traits": { "smithy.api#documentation": "

The contactId that is related to this contact. Linking\n tasks together by using RelatedContactID copies over contact attributes from the\n related task contact to the new task contact. All updates to user-defined attributes in the new\n task contact are limited to the individual contact ID, unlike what happens when tasks are linked\n by using PreviousContactID. There are no limits to the number of contacts that can\n be linked by using RelatedContactId.

" } + }, + "SegmentAttributes": { + "target": "com.amazonaws.connect#SegmentAttributes", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { @@ -35813,6 +37975,18 @@ "traits": { "smithy.api#enumValue": "EMAIL" } + }, + "SELF_ASSIGN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELF_ASSIGN" + } + }, + "EXPIRY_DURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRY_DURATION" + } } } }, @@ -35946,6 +38120,26 @@ "smithy.api#documentation": "

The distribution of traffic between the instance and its replicas.

" } }, + "com.amazonaws.connect#TemplateAttributes": { + "type": "structure", + "members": { + "CustomAttributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

" + } + }, + "CustomerProfileAttributes": { + "target": "com.amazonaws.connect#CustomerProfileAttributesSerialized", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, "com.amazonaws.connect#TemplateId": { "type": "string", "traits": { @@ -35955,6 +38149,35 @@ } } }, + "com.amazonaws.connect#TemplatedMessageConfig": { + "type": "structure", + "members": { + "KnowledgeBaseId": { + "target": "com.amazonaws.connect#MessageTemplateKnowledgeBaseId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "MessageTemplateId": { + "target": "com.amazonaws.connect#MessageTemplateId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "TemplateAttributes": { + "target": "com.amazonaws.connect#TemplateAttributes", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, "com.amazonaws.connect#Threshold": { "type": "structure", "members": { @@ -37483,6 +39706,12 @@ "traits": { "smithy.api#documentation": "

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

" } + }, + "SegmentAttributes": { + "target": "com.amazonaws.connect#SegmentAttributes", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { @@ -37655,6 +39884,108 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#UpdateEmailAddressMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateEmailAddressMetadataRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateEmailAddressMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "POST", + "uri": "/email-addresses/{InstanceId}/{EmailAddressId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateEmailAddressMetadataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "EmailAddressId": { + "target": "com.amazonaws.connect#EmailAddressId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

" + } + }, + "DisplayName": { + "target": "com.amazonaws.connect#EmailAddressDisplayName", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#UpdateEmailAddressMetadataResponse": { + "type": "structure", + "members": { + "EmailAddressId": { + "target": "com.amazonaws.connect#EmailAddressId", + "traits": { + "smithy.api#documentation": "

" + } + }, + "EmailAddressArn": { + "target": "com.amazonaws.connect#EmailAddressArn", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#UpdateEvaluationForm": { "type": "operation", "input": { @@ -38710,6 +41041,77 @@ "smithy.api#input": {} } }, + "com.amazonaws.connect#UpdateQueueOutboundEmailConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQueueOutboundEmailConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#ConditionalOperationFailedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

", + "smithy.api#http": { + "method": "POST", + "uri": "/queues/{InstanceId}/{QueueId}/outbound-email-config", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQueueOutboundEmailConfigRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "OutboundEmailConfig": { + "target": "com.amazonaws.connect#OutboundEmailConfig", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.connect#UpdateQueueStatus": { "type": "operation", "input": { @@ -39515,6 +41917,12 @@ "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" } }, + "SelfAssignFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

" + } + }, "Constraints": { "target": "com.amazonaws.connect#TaskTemplateConstraints", "traits": { @@ -39583,6 +41991,12 @@ "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" } }, + "SelfAssignFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

" + } + }, "Constraints": { "target": "com.amazonaws.connect#TaskTemplateConstraints", "traits": { @@ -40848,6 +43262,20 @@ "smithy.api#documentation": "

The user's first name and last name.

" } }, + "com.amazonaws.connect#UserInfo": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#AgentResourceId", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, "com.amazonaws.connect#UserNotFoundException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/cost-explorer.json b/codegen/sdk-codegen/aws-models/cost-explorer.json index 3f4d5e71cba..f85925cd1f0 100644 --- a/codegen/sdk-codegen/aws-models/cost-explorer.json +++ b/codegen/sdk-codegen/aws-models/cost-explorer.json @@ -1014,7 +1014,7 @@ "SavingsPlansPurchaseAnalysisDetails": { "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseAnalysisDetails", "traits": { - "smithy.api#documentation": "

Details about the Savings Plans purchase\n analysis.

" + "smithy.api#documentation": "

Details about the Savings Plans purchase analysis.

" } } }, @@ -1052,7 +1052,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested analysis can't be\n found.

", + "smithy.api#documentation": "

The requested analysis can't be found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1086,7 +1086,7 @@ "EstimatedCompletionTime": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

The estimated time for when the analysis will\n complete.

" + "smithy.api#documentation": "

The estimated time for when the analysis will complete.

" } }, "AnalysisCompletionTime": { @@ -1110,19 +1110,19 @@ "ErrorCode": { "target": "com.amazonaws.costexplorer#ErrorCode", "traits": { - "smithy.api#documentation": "

The error code used for the\n analysis.

" + "smithy.api#documentation": "

The error code used for the analysis.

" } }, "AnalysisId": { "target": "com.amazonaws.costexplorer#AnalysisId", "traits": { - "smithy.api#documentation": "

The analysis ID that's associated with the commitment\n purchase.

" + "smithy.api#documentation": "

The analysis ID that's associated with the commitment purchase analysis.

" } }, "CommitmentPurchaseAnalysisConfiguration": { "target": "com.amazonaws.costexplorer#CommitmentPurchaseAnalysisConfiguration", "traits": { - "smithy.api#documentation": "

The analysis configuration for the commitment purchase\n analysis.

" + "smithy.api#documentation": "

The configuration for the commitment purchase analysis.

" } } }, @@ -1535,12 +1535,12 @@ "SavingsPlansPurchaseAnalysisConfiguration": { "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseAnalysisConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for the Savings Plans purchase\n analysis.

" + "smithy.api#documentation": "

The configuration for the Savings Plans purchase analysis.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration for the commitment purchase\n analysis.

" + "smithy.api#documentation": "

The configuration for the commitment purchase analysis.

" } }, "com.amazonaws.costexplorer#Context": { @@ -1998,7 +1998,7 @@ "Rule": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

An Expression\n object used to categorize costs. This supports dimensions, tags, and nested expressions.\n Currently the only dimensions supported are LINKED_ACCOUNT,\n\n SERVICE_CODE, RECORD_TYPE, LINKED_ACCOUNT_NAME, REGION, USAGE_TYPE, and BILLING_ENTITY.

\n

\n RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also\n supported for Cost Category expressions. This dimension uses different terms, depending\n on whether you're using the console or API/JSON editor. For a detailed comparison, see\n Term Comparisons in the Billing and Cost Management User\n Guide.

" + "smithy.api#documentation": "

An Expression\n object used to categorize costs. This supports dimensions, tags, and nested expressions.\n Currently the only dimensions supported are LINKED_ACCOUNT,\n\n SERVICE_CODE, RECORD_TYPE, LINKED_ACCOUNT_NAME, REGION, and USAGE_TYPE.

\n

\n RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also\n supported for Cost Category expressions. This dimension uses different terms, depending\n on whether you're using the console or API/JSON editor. For a detailed comparison, see\n Term Comparisons in the Billing and Cost Management User\n Guide.

" } }, "InheritedValue": { @@ -3765,7 +3765,7 @@ } }, "traits": { - "smithy.api#documentation": "

A request to generate a recommendation is already in progress.

", + "smithy.api#documentation": "

A request to generate a recommendation or analysis is already in progress.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4195,7 +4195,7 @@ "AnalysisId": { "target": "com.amazonaws.costexplorer#AnalysisId", "traits": { - "smithy.api#documentation": "

The analysis ID that's associated with the commitment purchase\n analysis.

", + "smithy.api#documentation": "

The analysis ID that's associated with the commitment purchase analysis.

", "smithy.api#required": {} } } @@ -4210,7 +4210,7 @@ "EstimatedCompletionTime": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

The estimated time for when the analysis will\n complete.

", + "smithy.api#documentation": "

The estimated time for when the analysis will complete.

", "smithy.api#required": {} } }, @@ -4230,7 +4230,7 @@ "AnalysisId": { "target": "com.amazonaws.costexplorer#AnalysisId", "traits": { - "smithy.api#documentation": "

The analysis ID that's associated with the commitment purchase\n analysis.

", + "smithy.api#documentation": "

The analysis ID that's associated with the commitment purchase analysis.

", "smithy.api#required": {} } }, @@ -4256,7 +4256,7 @@ "CommitmentPurchaseAnalysisConfiguration": { "target": "com.amazonaws.costexplorer#CommitmentPurchaseAnalysisConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for the commitment purchase\n analysis.

", + "smithy.api#documentation": "

The configuration for the commitment purchase analysis.

", "smithy.api#required": {} } } @@ -6104,7 +6104,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the commitment purchase analyses for your account based on the last 30\n days.

" + "smithy.api#documentation": "

Lists the commitment purchase analyses for your account.

" } }, "com.amazonaws.costexplorer#ListCommitmentPurchaseAnalysesRequest": { @@ -6119,20 +6119,20 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of\n results.

" + "smithy.api#documentation": "

The token to retrieve the next set of results.

" } }, "PageSize": { "target": "com.amazonaws.costexplorer#NonNegativeInteger", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of analyses that you want returned in a single response\n object.

" + "smithy.api#documentation": "

The number of analyses that you want returned in a single response object.

" } }, "AnalysisIds": { "target": "com.amazonaws.costexplorer#AnalysisIds", "traits": { - "smithy.api#documentation": "

The analysis IDs associated with the commitment purchase\n analyses.

" + "smithy.api#documentation": "

The analysis IDs associated with the commitment purchase analyses.

" } } }, @@ -6152,7 +6152,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of\n results.

" + "smithy.api#documentation": "

The token to retrieve the next set of results.

" } } }, @@ -7712,19 +7712,19 @@ "AverageUtilization": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average utilization of your recommendations. Amazon Web Services uses this to\n calculate your recommended reservation purchases.

" + "smithy.api#documentation": "

The average utilization of your instances. Amazon Web Services uses this to calculate\n your recommended reservation purchases.

" } }, "EstimatedBreakEvenInMonths": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How long Amazon Web Services estimates that it takes for this recommendation to start\n saving you money, in months.

" + "smithy.api#documentation": "

How long Amazon Web Services estimates that it takes for this instance to start saving\n you money, in months.

" } }, "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this\n recommendation.

" + "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this\n instance.

" } }, "EstimatedMonthlySavingsAmount": { @@ -7754,43 +7754,43 @@ "UpfrontCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much purchasing this recommendation costs you upfront.

" + "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" } }, "RecurringStandardMonthlyCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much purchasing this recommendation costs you on a monthly basis.

" + "smithy.api#documentation": "

How much purchasing this instance costs you on a monthly basis.

" } }, "ReservedCapacityDetails": { "target": "com.amazonaws.costexplorer#ReservedCapacityDetails", "traits": { - "smithy.api#documentation": "

Details about the reservations that Amazon Web Services recommends that you\n purchase.

" + "smithy.api#documentation": "

Details about the reservations that Amazon Web Services recommends that you\n \n purchase.

" } }, "RecommendedNumberOfCapacityUnitsToPurchase": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The number of reserved capacity units that Amazon Web Services recommends that you\n purchase.

" + "smithy.api#documentation": "

The number of reserved capacity units that Amazon Web Services recommends that you\n \n purchase.

" } }, "MinimumNumberOfCapacityUnitsUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The minimum number of provisioned capacity units that you used in an hour during the\n historical period. Amazon Web Services uses this to calculate your recommended\n reservation purchases.

" + "smithy.api#documentation": "

The minimum number of provisioned capacity units that you used in an hour during the\n \n historical period. Amazon Web Services uses this to calculate your recommended\n \n reservation purchases.

" } }, "MaximumNumberOfCapacityUnitsUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum number of provisioned capacity units that you used in an hour during the\n historical period. Amazon Web Services uses this to calculate your recommended\n reservation purchases.

" + "smithy.api#documentation": "

The maximum number of provisioned capacity units that you used in an hour during the\n \n historical period. Amazon Web Services uses this to calculate your recommended\n \n reservation purchases.

" } }, "AverageNumberOfCapacityUnitsUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average number of provisioned capacity units that you used in an hour during the\n historical period. Amazon Web Services uses this to calculate your recommended\n reservation purchases.

" + "smithy.api#documentation": "

The average number of provisioned capacity units that you used in an hour during the\n \n historical period. Amazon Web Services uses this to calculate your recommended\n \n reservation purchases.

" } } }, @@ -7911,7 +7911,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about the reservations that Amazon Web Services recommends that you\n purchase.

" + "smithy.api#documentation": "

Details about the reservations that Amazon Web Services recommends that you\n \n purchase.

" } }, "com.amazonaws.costexplorer#ReservedHours": { @@ -8244,21 +8244,43 @@ "smithy.api#documentation": "

The member account value that's associated with the cost anomaly.

" } }, + "LinkedAccountName": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The member account name value that's associated with the cost anomaly.

" + } + }, "UsageType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { "smithy.api#documentation": "

The UsageType value that's associated with the cost anomaly.

" } }, - "LinkedAccountName": { - "target": "com.amazonaws.costexplorer#GenericString", + "Impact": { + "target": "com.amazonaws.costexplorer#RootCauseImpact", "traits": { - "smithy.api#documentation": "

The member account name value that's associated with the cost anomaly.

" + "smithy.api#documentation": "

The dollar impact for the root cause.

" } } }, "traits": { - "smithy.api#documentation": "

The combination of Amazon Web Services service, linked account, linked account name,\n Region, and usage type where a cost anomaly is observed. The linked account name will\n only be available when the account name can be identified.

" + "smithy.api#documentation": "

The combination of Amazon Web Services service, linked account, linked account name,\n Region, and usage type where a cost anomaly is observed, along with the dollar and\n percentage amount of the anomaly impact. The linked account name will only be available\n when the account name can be identified.

" + } + }, + "com.amazonaws.costexplorer#RootCauseImpact": { + "type": "structure", + "members": { + "Contribution": { + "target": "com.amazonaws.costexplorer#GenericDouble", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The dollar amount that this root cause contributed to the anomaly's\n TotalImpact.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The dollar value of the root cause.

" } }, "com.amazonaws.costexplorer#RootCauses": { @@ -8276,7 +8298,7 @@ "PaymentOption": { "target": "com.amazonaws.costexplorer#PaymentOption", "traits": { - "smithy.api#documentation": "

The payment option for the Savings Plans\n commitment.

" + "smithy.api#documentation": "

The payment option for the Savings Plans commitment.

" } }, "SavingsPlansType": { @@ -8288,19 +8310,19 @@ "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The Region associated with the Savings Plans\n commitment.

" + "smithy.api#documentation": "

The Region associated with the Savings Plans commitment.

" } }, "InstanceFamily": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The instance family of the Savings Plans\n commitment.

" + "smithy.api#documentation": "

The instance family of the Savings Plans commitment.

" } }, "TermInYears": { "target": "com.amazonaws.costexplorer#TermInYears", "traits": { - "smithy.api#documentation": "

The term that you want the Savings Plans commitment\n for.

" + "smithy.api#documentation": "

The term that you want the Savings Plans commitment for.

" } }, "SavingsPlansCommitment": { @@ -8312,12 +8334,12 @@ "OfferingId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The unique ID that's used to distinguish commitments from one\n another.

" + "smithy.api#documentation": "

The unique ID that's used to distinguish Savings Plans commitments from one\n another.

" } } }, "traits": { - "smithy.api#documentation": "

The Savings Plans commitment\n details.

" + "smithy.api#documentation": "

The Savings Plans commitment details.

" } }, "com.amazonaws.costexplorer#SavingsPlansAmortizedCommitment": { @@ -8493,13 +8515,13 @@ "AccountScope": { "target": "com.amazonaws.costexplorer#AccountScope", "traits": { - "smithy.api#documentation": "

The account scope that you want your analysis\n for.

" + "smithy.api#documentation": "

The account scope that you want your analysis for.

" } }, "AccountId": { "target": "com.amazonaws.costexplorer#AccountId", "traits": { - "smithy.api#documentation": "

The account that the analysis is\n for.

" + "smithy.api#documentation": "

The account that the analysis is for.

" } }, "AnalysisType": { @@ -8512,26 +8534,26 @@ "SavingsPlansToAdd": { "target": "com.amazonaws.costexplorer#SavingsPlansToAdd", "traits": { - "smithy.api#documentation": "

Savings Plans to include in the\n analysis.

", + "smithy.api#documentation": "

Savings Plans to include in the analysis.

", "smithy.api#required": {} } }, "SavingsPlansToExclude": { "target": "com.amazonaws.costexplorer#SavingsPlansToExclude", "traits": { - "smithy.api#documentation": "

Savings Plans to exclude from the\n analysis.

" + "smithy.api#documentation": "

Savings Plans to exclude from the analysis.

" } }, "LookBackTimePeriod": { "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

The time period associated with the\n analysis.

", + "smithy.api#documentation": "

The time period associated with the analysis.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The configuration for the Savings Plans purchase\n analysis.

" + "smithy.api#documentation": "

The configuration for the Savings Plans purchase analysis.

" } }, "com.amazonaws.costexplorer#SavingsPlansPurchaseAnalysisDetails": { @@ -8540,97 +8562,97 @@ "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code used for the\n analysis.

" + "smithy.api#documentation": "

The currency code used for the analysis.

" } }, "LookbackPeriodInHours": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The lookback period in hours that's used to generate the\n analysis.

" + "smithy.api#documentation": "

The lookback period in hours that's used to generate the analysis.

" } }, "CurrentAverageCoverage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average value of hourly coverage over the lookback\n period.

" + "smithy.api#documentation": "

The average value of hourly coverage over the lookback period.

" } }, "CurrentAverageHourlyOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average value of hourly On-Demand spend over the lookback\n period.

" + "smithy.api#documentation": "

The average value of hourly On-Demand spend over the lookback period.

" } }, "CurrentMaximumHourlyOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The highest value of hourly On-Demand spend over the lookback\n period.

" + "smithy.api#documentation": "

The highest value of hourly On-Demand spend over the lookback period.

" } }, "CurrentMinimumHourlyOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The lowest value of hourly On-Demand spend over the lookback\n period.

" + "smithy.api#documentation": "

The lowest value of hourly On-Demand spend over the lookback period.

" } }, "CurrentOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The current total On-Demand spend over the lookback\n period.

" + "smithy.api#documentation": "

The current total On-Demand spend over the lookback period.

" } }, "ExistingHourlyCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The existing hourly commitment for the Savings Plan\n type.

" + "smithy.api#documentation": "

The existing hourly commitment for the Savings Plan type.

" } }, "HourlyCommitmentToPurchase": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The recommended or custom hourly\n commitment.

" + "smithy.api#documentation": "

The recommended or custom hourly commitment.

" } }, "EstimatedAverageCoverage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated coverage of the Savings\n Plan.

" + "smithy.api#documentation": "

The estimated coverage of the Savings Plan.

" } }, "EstimatedAverageUtilization": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated utilization of the Savings\n Plan.

" + "smithy.api#documentation": "

The estimated utilization of the Savings Plan.

" } }, "EstimatedMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated monthly savings amount based on the Savings\n Plan.

" + "smithy.api#documentation": "

The estimated monthly savings amount based on the Savings Plan.

" } }, "EstimatedOnDemandCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The remaining On-Demand cost estimated to not be covered by the commitment, over the\n length of the lookback period.

" + "smithy.api#documentation": "

The remaining On-Demand cost estimated to not be covered by the Savings Plan over the\n length of the lookback period.

" } }, "EstimatedOnDemandCostWithCurrentCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated On-Demand cost you expect with no additional commitment, based on your\n usage of the selected time period and the Savings Plan you\n own.

" + "smithy.api#documentation": "

The estimated On-Demand cost you expect with no additional commitment based on your\n usage of the selected time period and the Savings Plan you own.

" } }, "EstimatedROI": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated return on investment that's based on the purchase commitment and\n estimated savings. This is calculated as\n estimatedSavingsAmount/estimatedSPCost*100.

" + "smithy.api#documentation": "

The estimated return on investment that's based on the Savings Plan and estimated\n savings. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.

" } }, "EstimatedSavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated savings amount that's based on the purchase commitment over the length\n of the lookback period.

" + "smithy.api#documentation": "

The estimated savings amount that's based on the Savings Plan over the length of the\n lookback period.

" } }, "EstimatedSavingsPercentage": { @@ -8642,25 +8664,25 @@ "EstimatedCommitmentCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated cost of the purchase commitment over the length of the lookback\n period.

" + "smithy.api#documentation": "

The estimated cost of the Savings Plan over the length of the lookback period.

" } }, "LatestUsageTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The date and time of the last hour that went into the\n analysis.

" + "smithy.api#documentation": "

The date and time of the last hour that went into the analysis.

" } }, "UpfrontCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The upfront cost of the Savings Plan, based on the selected payment\n option.

" + "smithy.api#documentation": "

The upfront cost of the Savings Plan based on the selected payment option.

" } }, "AdditionalMetadata": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Additional metadata that might be applicable to the\n commitment.

" + "smithy.api#documentation": "

Additional metadata that might be applicable to the commitment.

" } }, "MetricsOverLookbackPeriod": { @@ -8671,7 +8693,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about the Savings Plans purchase\n analysis.

" + "smithy.api#documentation": "

Details about the Savings Plans purchase analysis.

" } }, "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendation": { @@ -9240,7 +9262,7 @@ } ], "traits": { - "smithy.api#documentation": "

Specifies the parameters of a planned commitment purchase and starts the generation of the\n analysis. This enables you to estimate the cost, coverage, and utilization impact of your\n planned commitment purchases. You can request up to 20 analysis runs per\n day.

" + "smithy.api#documentation": "

Specifies the parameters of a planned commitment purchase and starts the generation of the\n analysis. This enables you to estimate the cost, coverage, and utilization impact of your\n planned commitment purchases.

" } }, "com.amazonaws.costexplorer#StartCommitmentPurchaseAnalysisRequest": { @@ -9249,7 +9271,7 @@ "CommitmentPurchaseAnalysisConfiguration": { "target": "com.amazonaws.costexplorer#CommitmentPurchaseAnalysisConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for the commitment purchase\n analysis.

", + "smithy.api#documentation": "

The configuration for the commitment purchase analysis.

", "smithy.api#required": {} } } @@ -9264,7 +9286,7 @@ "AnalysisId": { "target": "com.amazonaws.costexplorer#AnalysisId", "traits": { - "smithy.api#documentation": "

The analysis ID that's associated with the commitment purchase\n analysis.

", + "smithy.api#documentation": "

The analysis ID that's associated with the commitment purchase analysis.

", "smithy.api#required": {} } }, @@ -9278,7 +9300,7 @@ "EstimatedCompletionTime": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

The estimated time for when the analysis will\n complete.

", + "smithy.api#documentation": "

The estimated time for when the analysis will complete.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.json b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.json index dcb0b302868..b8ead37f99b 100644 --- a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.json +++ b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.json @@ -390,6 +390,23 @@ "smithy.api#documentation": "

Information about the override status applied to a target.

" } }, + "com.amazonaws.elasticloadbalancingv2#AdvertiseTrustStoreCaNamesEnum": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } + }, "com.amazonaws.elasticloadbalancingv2#AllocationId": { "type": "string" }, @@ -7378,6 +7395,12 @@ "traits": { "smithy.api#documentation": "

Indicates a shared trust stores association status.

" } + }, + "AdvertiseTrustStoreCaNames": { + "target": "com.amazonaws.elasticloadbalancingv2#AdvertiseTrustStoreCaNamesEnum", + "traits": { + "smithy.api#documentation": "

Indicates whether trust store CA certificate names are advertised.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/emr.json b/codegen/sdk-codegen/aws-models/emr.json index 1dd27524426..16ceb61bc58 100644 --- a/codegen/sdk-codegen/aws-models/emr.json +++ b/codegen/sdk-codegen/aws-models/emr.json @@ -7299,6 +7299,18 @@ "traits": { "smithy.api#documentation": "

The Amazon EC2 unit limits for a managed scaling policy. The managed scaling\n activity of a cluster is not allowed to go above or below these limits. The limit only\n applies to the core and task nodes. The master node cannot be scaled after initial\n configuration.

" } + }, + "UtilizationPerformanceIndex": { + "target": "com.amazonaws.emr#UtilizationPerformanceIndexInteger", + "traits": { + "smithy.api#documentation": "

An integer value that represents an advanced scaling strategy. Setting a higher value optimizes for performance. Setting a lower value optimizes for resource conservation. Setting the value \n to 50 balances performance and resource conservation. Possible values are 1, 25, 50, 75, and 100.

" + } + }, + "ScalingStrategy": { + "target": "com.amazonaws.emr#ScalingStrategy", + "traits": { + "smithy.api#documentation": "

Determines whether a custom scaling utilization performance index can be set. Possible values include ADVANCED or DEFAULT.

" + } } }, "traits": { @@ -8866,6 +8878,23 @@ "target": "com.amazonaws.emr#ScalingRule" } }, + "com.amazonaws.emr#ScalingStrategy": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "ADVANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADVANCED" + } + } + } + }, "com.amazonaws.emr#ScalingTrigger": { "type": "structure", "members": { @@ -10700,6 +10729,15 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.emr#UtilizationPerformanceIndexInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.emr#VolumeSpecification": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/inspector2.json b/codegen/sdk-codegen/aws-models/inspector2.json index 41a02b0b1d7..3ea197fe1b7 100644 --- a/codegen/sdk-codegen/aws-models/inspector2.json +++ b/codegen/sdk-codegen/aws-models/inspector2.json @@ -599,6 +599,9 @@ { "target": "com.amazonaws.inspector2#InternalServerException" }, + { + "target": "com.amazonaws.inspector2#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.inspector2#ThrottlingException" }, @@ -607,7 +610,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator. An HTTP 200 response indicates the association was successfully started, but doesn’t indicate whether it was completed. You can check if the association completed by using ListMembers for multiple accounts or GetMembers for a single account.

", + "smithy.api#documentation": "

\n Associates an Amazon Web Services account with an Amazon Inspector delegated administrator. \n An HTTP 200 response indicates the association was started but doesn’t indicate whether it completed. \n You can check if the association completed using ListMembers for multiple accounts or GetMembers for a single account. \n An HTTP 402 response indicates the association failed because the organization size exceeded its limit. \n For information on limits, see Amazon Inspector quotas.\n

", "smithy.api#http": { "code": 200, "method": "POST", diff --git a/codegen/sdk-codegen/aws-models/lambda.json b/codegen/sdk-codegen/aws-models/lambda.json index e86a0448002..f5d3de57d3d 100644 --- a/codegen/sdk-codegen/aws-models/lambda.json +++ b/codegen/sdk-codegen/aws-models/lambda.json @@ -2780,6 +2780,12 @@ "traits": { "smithy.api#documentation": "

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" } + }, + "ProvisionedPollerConfig": { + "target": "com.amazonaws.lambda#ProvisionedPollerConfig", + "traits": { + "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The Provisioned Mode configuration for the event source.\n For more information, see Provisioned Mode.

" + } } }, "traits": { @@ -4347,6 +4353,12 @@ "traits": { "smithy.api#documentation": "

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" } + }, + "ProvisionedPollerConfig": { + "target": "com.amazonaws.lambda#ProvisionedPollerConfig", + "traits": { + "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The Provisioned Mode configuration for the event source.\n For more information, see Provisioned Mode.

" + } } }, "traits": { @@ -9569,6 +9581,15 @@ } } }, + "com.amazonaws.lambda#MaximumNumberOfPollers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2000 + } + } + }, "com.amazonaws.lambda#MaximumRecordAgeInSeconds": { "type": "integer", "traits": { @@ -9615,6 +9636,15 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.lambda#MinimumNumberOfPollers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, "com.amazonaws.lambda#NameSpacedFunctionArn": { "type": "string", "traits": { @@ -9893,6 +9923,26 @@ } } }, + "com.amazonaws.lambda#ProvisionedPollerConfig": { + "type": "structure", + "members": { + "MinimumPollers": { + "target": "com.amazonaws.lambda#MinimumNumberOfPollers", + "traits": { + "smithy.api#documentation": "

The minimum number of event pollers this event source can scale down to.

" + } + }, + "MaximumPollers": { + "target": "com.amazonaws.lambda#MaximumNumberOfPollers", + "traits": { + "smithy.api#documentation": "

The maximum number of event pollers this event source can scale up to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The \n Provisioned Mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers\n for your event source. An event poller is a compute unit that provides approximately 5 MBps of throughput.

" + } + }, "com.amazonaws.lambda#PublishLayerVersion": { "type": "operation", "input": { @@ -12709,6 +12759,12 @@ "traits": { "smithy.api#documentation": "

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" } + }, + "ProvisionedPollerConfig": { + "target": "com.amazonaws.lambda#ProvisionedPollerConfig", + "traits": { + "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The Provisioned Mode configuration for the event source.\n For more information, see Provisioned Mode.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/mailmanager.json b/codegen/sdk-codegen/aws-models/mailmanager.json index 80c71866104..3a7c9a63fbc 100644 --- a/codegen/sdk-codegen/aws-models/mailmanager.json +++ b/codegen/sdk-codegen/aws-models/mailmanager.json @@ -1729,6 +1729,41 @@ "smithy.api#documentation": "

This action to delivers an email to a mailbox.

" } }, + "com.amazonaws.mailmanager#DeliverToQBusinessAction": { + "type": "structure", + "members": { + "ActionFailurePolicy": { + "target": "com.amazonaws.mailmanager#ActionFailurePolicy", + "traits": { + "smithy.api#documentation": "

A policy that states what to do in the case of failure. The action will fail if there are\n configuration errors. For example, the specified application has been deleted or the role lacks\n necessary permissions to call the qbusiness:BatchPutDocument API.

" + } + }, + "ApplicationId": { + "target": "com.amazonaws.mailmanager#QBusinessApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Amazon Q Business application instance where the email\n content will be delivered.

", + "smithy.api#required": {} + } + }, + "IndexId": { + "target": "com.amazonaws.mailmanager#QBusinessIndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base index within the Amazon Q Business application\n where the email content will be stored and indexed.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.mailmanager#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access\n to the qbusiness:BatchPutDocument API for the given application and index.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The action to deliver incoming emails to an Amazon Q Business application for indexing.

" + } + }, "com.amazonaws.mailmanager#DropAction": { "type": "structure", "members": {}, @@ -5338,6 +5373,26 @@ "target": "com.amazonaws.mailmanager#PolicyStatement" } }, + "com.amazonaws.mailmanager#QBusinessApplicationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-z0-9-]+$" + } + }, + "com.amazonaws.mailmanager#QBusinessIndexId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-z0-9-]+$" + } + }, "com.amazonaws.mailmanager#Recipients": { "type": "list", "member": { @@ -5872,6 +5927,12 @@ "traits": { "smithy.api#documentation": "

This action delivers an email to a WorkMail mailbox.

" } + }, + "DeliverToQBusiness": { + "target": "com.amazonaws.mailmanager#DeliverToQBusinessAction", + "traits": { + "smithy.api#documentation": "

This action delivers an email to an Amazon Q Business application for ingestion into\n its knowledge base.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/neptune-graph.json b/codegen/sdk-codegen/aws-models/neptune-graph.json index 428904d8ad2..d7be70e6f62 100644 --- a/codegen/sdk-codegen/aws-models/neptune-graph.json +++ b/codegen/sdk-codegen/aws-models/neptune-graph.json @@ -1545,6 +1545,135 @@ } } }, + "com.amazonaws.neptunegraph#CancelExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#CancelExportTaskInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#CancelExportTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#ConflictException" + }, + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Cancel the specified export task.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/exporttasks/{taskIdentifier}" + }, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "ControlPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#CancelExportTaskInput": { + "type": "structure", + "members": { + "taskIdentifier": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#CancelExportTaskOutput": { + "type": "structure", + "members": { + "graphId": { + "target": "com.amazonaws.neptunegraph#GraphId", + "traits": { + "smithy.api#documentation": "

The source graph identifier of the cancelled export task.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that will allow the exporting of data to the destination.

", + "smithy.api#required": {} + } + }, + "taskId": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.neptunegraph#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "

The current status of the export task. The status is CANCELLING when the \n export task is cancelled.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the cancelled export task.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the cancelled export task where data will be exported to.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key identifier of the cancelled export task.

", + "smithy.api#required": {} + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the cancelled export task.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason that the export task has this status value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.neptunegraph#CancelImportTask": { "type": "operation", "input": { @@ -1630,6 +1759,12 @@ "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the cancelled import task.

" + } + }, "roleArn": { "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { @@ -2198,6 +2333,12 @@ "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format, OPEN_CYPHER, which identifies the openCypher\n load format, or ntriples, which identifies the\n RDF n-triples format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "blankNodeHandling": { "target": "com.amazonaws.neptunegraph#BlankNodeHandling", "traits": { @@ -2245,6 +2386,12 @@ "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format, OPENCYPHER, which identifies the openCypher\n load format, or ntriples, which identifies the\n RDF n-triples format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "roleArn": { "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { @@ -2767,195 +2914,719 @@ "target": "smithy.api#String" } }, - "com.amazonaws.neptunegraph#EdgeProperties": { + "com.amazonaws.neptunegraph#EdgeProperties": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunegraph#EdgeStructure": { + "type": "structure", + "members": { + "count": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of instances of the edge in the graph.

" + } + }, + "edgeProperties": { + "target": "com.amazonaws.neptunegraph#EdgeProperties", + "traits": { + "smithy.api#documentation": "

A list of the properties associated with the edge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an edge in a Neptune Analytics graph.

" + } + }, + "com.amazonaws.neptunegraph#EdgeStructures": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunegraph#EdgeStructure" + } + }, + "com.amazonaws.neptunegraph#ExecuteQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#ExecuteQueryInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#ExecuteQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunegraph#ConflictException" + }, + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#UnprocessableException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "

Execute an openCypher query.

\n

\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached \n that allows one of the following IAM actions in that cluster, depending on the query:\n

\n ", + "smithy.api#endpoint": { + "hostPrefix": "{graphIdentifier}." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/queries", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "DataPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#ExecuteQueryInput": { + "type": "structure", + "members": { + "graphIdentifier": { + "target": "com.amazonaws.neptunegraph#GraphIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Neptune Analytics graph.

", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "graphIdentifier", + "smithy.api#required": {} + } + }, + "queryString": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The query string to be executed.

", + "smithy.api#jsonName": "query", + "smithy.api#required": {} + } + }, + "language": { + "target": "com.amazonaws.neptunegraph#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The query language the query is written in. Currently only openCypher is supported.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.neptunegraph#DocumentValuedMap", + "traits": { + "smithy.api#documentation": "

The data parameters the query can use in JSON format. For example: {\"name\": \"john\", \"age\": 20}. (optional)

" + } + }, + "planCache": { + "target": "com.amazonaws.neptunegraph#PlanCacheType", + "traits": { + "smithy.api#documentation": "

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. \n This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an \n LRU cache with a 5 minute TTL and a capacity of 1000.

" + } + }, + "explainMode": { + "target": "com.amazonaws.neptunegraph#ExplainMode", + "traits": { + "smithy.api#documentation": "

The explain mode parameter returns a query explain instead of the actual query results. A query explain can \n be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions \n flowing etc.

", + "smithy.api#jsonName": "explain" + } + }, + "queryTimeoutMilliseconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Specifies the query timeout duration, in milliseconds. (optional)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#ExecuteQueryOutput": { + "type": "structure", + "members": { + "payload": { + "target": "com.amazonaws.neptunegraph#QueryResponseBlob", + "traits": { + "smithy.api#documentation": "

The query results.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunegraph#ExplainMode": { + "type": "enum", + "members": { + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATIC" + } + }, + "DETAILS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETAILS" + } + } + } + }, + "com.amazonaws.neptunegraph#ExportFilter": { + "type": "structure", + "members": { + "vertexFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilterPerLabelMap", + "traits": { + "smithy.api#documentation": "

Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels \n and properties are included in the export.

" + } + }, + "edgeFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilterPerLabelMap", + "traits": { + "smithy.api#documentation": "

Used to specify filters on a per-label basis for edges. This allows you to control which edge labels \n and properties are included in the export.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This is the top-level field for specifying vertex or edge filters. If the ExportFilter is not provided, \n then all properties for all labels will be exported. If the ExportFilter is provided but is an empty object, \n then no data will be exported.

" + } + }, + "com.amazonaws.neptunegraph#ExportFilterElement": { + "type": "structure", + "members": { + "properties": { + "target": "com.amazonaws.neptunegraph#ExportFilterPropertyMap", + "traits": { + "smithy.api#documentation": "

Each property is defined by a key-value pair, where the key is the desired output property name (e.g. \"name\"), \n and the value is an object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whihc properties of that label should be included in the export.

" + } + }, + "com.amazonaws.neptunegraph#ExportFilterLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.neptunegraph#ExportFilterOutputDataType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(Any|Byte|Short|Int|Long|Float|Double|String|Bool|Boolean|Float\\[\\]|Double\\[\\])$" + } + }, + "com.amazonaws.neptunegraph#ExportFilterOutputPropertyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]+$" + } + }, + "com.amazonaws.neptunegraph#ExportFilterPerLabelMap": { + "type": "map", + "key": { + "target": "com.amazonaws.neptunegraph#ExportFilterLabel" + }, + "value": { + "target": "com.amazonaws.neptunegraph#ExportFilterElement" + } + }, + "com.amazonaws.neptunegraph#ExportFilterPropertyAttributes": { + "type": "structure", + "members": { + "outputType": { + "target": "com.amazonaws.neptunegraph#ExportFilterOutputDataType", + "traits": { + "smithy.api#documentation": "

Specifies the data type to use for the property in the exported data (e.g. \"String\", \"Int\", \"Float\"). \n If a type is not provided, the export process will determine the type. If a given property is present as multiple \n types (e.g. one vertex has \"height\" stored as a double, and another edge has it stored as a string), the type \n will be of Any type, otherwise, it will be the type of the property as present in vertices.

" + } + }, + "sourcePropertyName": { + "target": "com.amazonaws.neptunegraph#ExportFilterSourcePropertyName", + "traits": { + "smithy.api#documentation": "

The name of the property as it exists in the original graph data. If not provided, it is assumed that the key \n matches the desired sourcePropertyName.

" + } + }, + "multiValueHandling": { + "target": "com.amazonaws.neptunegraph#MultiValueHandlingType", + "traits": { + "smithy.api#default": "PICK_FIRST", + "smithy.api#documentation": "

Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all \n values as a list, or PICK_FIRST to export the first value encountered. If not specified, the default \n value is PICK_FIRST.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName \n and multiValueHandling.

" + } + }, + "com.amazonaws.neptunegraph#ExportFilterPropertyMap": { + "type": "map", + "key": { + "target": "com.amazonaws.neptunegraph#ExportFilterOutputPropertyName" + }, + "value": { + "target": "com.amazonaws.neptunegraph#ExportFilterPropertyAttributes" + } + }, + "com.amazonaws.neptunegraph#ExportFilterSourcePropertyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.neptunegraph#ExportFormat": { + "type": "enum", + "members": { + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + } + }, + "com.amazonaws.neptunegraph#ExportTaskDetails": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the export task.

", + "smithy.api#required": {} + } + }, + "timeElapsedSeconds": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The time elapsed, in seconds, since the start time of the export task.

", + "smithy.api#required": {} + } + }, + "progressPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of progress percentage of the export task.

", + "smithy.api#required": {} + } + }, + "numVerticesWritten": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of exported vertices.

" + } + }, + "numEdgesWritten": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of exported edges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the specified export task.

" + } + }, + "com.amazonaws.neptunegraph#ExportTaskId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^t-[a-z0-9]{10}$" + } + }, + "com.amazonaws.neptunegraph#ExportTaskStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "EXPORTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPORTING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.neptunegraph#ExportTaskSummary": { + "type": "structure", + "members": { + "graphId": { + "target": "com.amazonaws.neptunegraph#GraphId", + "traits": { + "smithy.api#documentation": "

The source graph identifier of the export task.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that will allow the data to be exported to the destination.

", + "smithy.api#required": {} + } + }, + "taskId": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.neptunegraph#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "

The current status of the export task.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the export task.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the export task where data will be exported to.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key identifier of the export task.

", + "smithy.api#required": {} + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the export task.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason that the export task has this status value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an export task.

" + } + }, + "com.amazonaws.neptunegraph#ExportTaskSummaryList": { "type": "list", "member": { - "target": "smithy.api#String" + "target": "com.amazonaws.neptunegraph#ExportTaskSummary" } }, - "com.amazonaws.neptunegraph#EdgeStructure": { - "type": "structure", + "com.amazonaws.neptunegraph#Format": { + "type": "enum", "members": { - "count": { - "target": "smithy.api#Long", + "CSV": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The number of instances of the edge in the graph.

" + "smithy.api#enumValue": "CSV" } }, - "edgeProperties": { - "target": "com.amazonaws.neptunegraph#EdgeProperties", + "OPEN_CYPHER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A list of the properties associated with the edge.

" + "smithy.api#enumValue": "OPEN_CYPHER" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "NTRIPLES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NTRIPLES" } } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an edge in a Neptune Analytics graph.

" - } - }, - "com.amazonaws.neptunegraph#EdgeStructures": { - "type": "list", - "member": { - "target": "com.amazonaws.neptunegraph#EdgeStructure" } }, - "com.amazonaws.neptunegraph#ExecuteQuery": { + "com.amazonaws.neptunegraph#GetExportTask": { "type": "operation", "input": { - "target": "com.amazonaws.neptunegraph#ExecuteQueryInput" + "target": "com.amazonaws.neptunegraph#GetExportTaskInput" }, "output": { - "target": "com.amazonaws.neptunegraph#ExecuteQueryOutput" + "target": "com.amazonaws.neptunegraph#GetExportTaskOutput" }, "errors": [ - { - "target": "com.amazonaws.neptunegraph#AccessDeniedException" - }, - { - "target": "com.amazonaws.neptunegraph#ConflictException" - }, { "target": "com.amazonaws.neptunegraph#InternalServerException" }, { - "target": "com.amazonaws.neptunegraph#ThrottlingException" + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" }, { - "target": "com.amazonaws.neptunegraph#UnprocessableException" + "target": "com.amazonaws.neptunegraph#ThrottlingException" }, { "target": "com.amazonaws.neptunegraph#ValidationException" } ], "traits": { - "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Execute an openCypher query.

\n

\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached \n that allows one of the following IAM actions in that cluster, depending on the query:\n

\n ", - "smithy.api#endpoint": { - "hostPrefix": "{graphIdentifier}." - }, + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Retrieves a specified export task.

", "smithy.api#http": { - "method": "POST", - "uri": "/queries", - "code": 200 + "code": 200, + "method": "GET", + "uri": "/exporttasks/{taskIdentifier}" }, + "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "ApiType": { - "value": "DataPlane" + "value": "ControlPlane" + } + }, + "smithy.waiters#waitable": { + "ExportTaskSuccessful": { + "documentation": "Wait until Export Task is Successful", + "minDelay": 60, + "maxDelay": 28800, + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "CANCELLING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "CANCELLED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "SUCCEEDED", + "comparator": "stringEquals" + } + } + } + ] + }, + "ExportTaskCancelled": { + "documentation": "Wait until Export Task is Cancelled", + "minDelay": 60, + "maxDelay": 3600, + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "status != 'CANCELLING' && status != 'CANCELLED'", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "CANCELLED", + "comparator": "stringEquals" + } + } + } + ] } } } }, - "com.amazonaws.neptunegraph#ExecuteQueryInput": { + "com.amazonaws.neptunegraph#GetExportTaskInput": { "type": "structure", "members": { - "graphIdentifier": { - "target": "com.amazonaws.neptunegraph#GraphIdentifier", + "taskIdentifier": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Neptune Analytics graph.

", - "smithy.api#hostLabel": {}, - "smithy.api#httpHeader": "graphIdentifier", + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "queryString": { - "target": "smithy.api#String", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#GetExportTaskOutput": { + "type": "structure", + "members": { + "graphId": { + "target": "com.amazonaws.neptunegraph#GraphId", "traits": { - "smithy.api#documentation": "

The query string to be executed.

", - "smithy.api#jsonName": "query", + "smithy.api#documentation": "

The source graph identifier of the export task.

", "smithy.api#required": {} } }, - "language": { - "target": "com.amazonaws.neptunegraph#QueryLanguage", + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { - "smithy.api#documentation": "

The query language the query is written in. Currently only openCypher is supported.

", + "smithy.api#documentation": "

The ARN of the IAM role that will allow data to be exported to the destination.

", "smithy.api#required": {} } }, - "parameters": { - "target": "com.amazonaws.neptunegraph#DocumentValuedMap", + "taskId": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", "traits": { - "smithy.api#documentation": "

The data parameters the query can use in JSON format. For example: {\"name\": \"john\", \"age\": 20}. (optional)

" + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#required": {} } }, - "planCache": { - "target": "com.amazonaws.neptunegraph#PlanCacheType", + "status": { + "target": "com.amazonaws.neptunegraph#ExportTaskStatus", "traits": { - "smithy.api#documentation": "

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. \n This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an \n LRU cache with a 5 minute TTL and a capacity of 1000.

" + "smithy.api#documentation": "

The current status of the export task.

", + "smithy.api#required": {} } }, - "explainMode": { - "target": "com.amazonaws.neptunegraph#ExplainMode", + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", "traits": { - "smithy.api#documentation": "

The explain mode parameter returns a query explain instead of the actual query results. A query explain can \n be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions \n flowing etc.

", - "smithy.api#jsonName": "explain" + "smithy.api#documentation": "

The format of the export task.

", + "smithy.api#required": {} } }, - "queryTimeoutMilliseconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the query timeout duration, in milliseconds. (optional)

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.neptunegraph#ExecuteQueryOutput": { - "type": "structure", - "members": { - "payload": { - "target": "com.amazonaws.neptunegraph#QueryResponseBlob", + "destination": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The query results.

", - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

The Amazon S3 URI of the export task where data will be exported.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.neptunegraph#ExplainMode": { - "type": "enum", - "members": { - "STATIC": { - "target": "smithy.api#Unit", + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", "traits": { - "smithy.api#enumValue": "STATIC" + "smithy.api#documentation": "

The KMS key identifier of the export task.

", + "smithy.api#required": {} } }, - "DETAILS": { - "target": "smithy.api#Unit", + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", "traits": { - "smithy.api#enumValue": "DETAILS" + "smithy.api#documentation": "

The parquet type of the export task.

" } - } - } - }, - "com.amazonaws.neptunegraph#Format": { - "type": "enum", - "members": { - "CSV": { - "target": "smithy.api#Unit", + }, + "statusReason": { + "target": "smithy.api#String", "traits": { - "smithy.api#enumValue": "CSV" + "smithy.api#documentation": "

The reason that the export task has this status value.

" } }, - "OPEN_CYPHER": { - "target": "smithy.api#Unit", + "exportTaskDetails": { + "target": "com.amazonaws.neptunegraph#ExportTaskDetails", "traits": { - "smithy.api#enumValue": "OPEN_CYPHER" + "smithy.api#documentation": "

The details of the export task.

" } }, - "NTRIPLES": { - "target": "smithy.api#Unit", + "exportFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilter", "traits": { - "smithy.api#enumValue": "NTRIPLES" + "smithy.api#documentation": "

The export filter of the export task.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.neptunegraph#GetGraph": { @@ -3605,6 +4276,12 @@ "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "roleArn": { "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { @@ -3634,7 +4311,7 @@ "attemptNumber": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of the current attempt to execute the import task.

" + "smithy.api#documentation": "

The number of the current attempts to execute the import task.

" } }, "statusReason": { @@ -4399,6 +5076,12 @@ "traits": { "smithy.api#enumValue": "CANCELLED" } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } } } }, @@ -4428,7 +5111,13 @@ "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" + "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" } }, "roleArn": { @@ -4484,6 +5173,93 @@ "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" } }, + "com.amazonaws.neptunegraph#ListExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#ListExportTasksInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#ListExportTasksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Retrieves a list of export tasks.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/exporttasks" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "tasks" + }, + "smithy.api#readonly": {}, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "ControlPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#ListExportTasksInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.neptunegraph#PaginationToken", + "traits": { + "smithy.api#documentation": "

Pagination token used to paginate input.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.neptunegraph#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of export tasks to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#ListExportTasksOutput": { + "type": "structure", + "members": { + "tasks": { + "target": "com.amazonaws.neptunegraph#ExportTaskSummaryList", + "traits": { + "smithy.api#documentation": "

The requested list of export tasks.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.neptunegraph#PaginationToken", + "traits": { + "smithy.api#documentation": "

Pagination token used to paginate output.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.neptunegraph#ListGraphSnapshots": { "type": "operation", "input": { @@ -5023,6 +5799,23 @@ } } }, + "com.amazonaws.neptunegraph#MultiValueHandlingType": { + "type": "enum", + "members": { + "TO_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO_LIST" + } + }, + "PICK_FIRST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PICK_FIRST" + } + } + } + }, "com.amazonaws.neptunegraph#NeptuneImportOptions": { "type": "structure", "members": { @@ -5124,6 +5917,17 @@ } } }, + "com.amazonaws.neptunegraph#ParquetType": { + "type": "enum", + "members": { + "COLUMNAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMNAR" + } + } + } + }, "com.amazonaws.neptunegraph#PlanCacheType": { "type": "enum", "members": { @@ -5870,6 +6674,190 @@ } } }, + "com.amazonaws.neptunegraph#StartExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#StartExportTaskInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#StartExportTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#ConflictException" + }, + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Export data from an existing Neptune Analytics graph to Amazon S3. The graph state should be AVAILABLE.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/exporttasks" + }, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "ControlPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#StartExportTaskInput": { + "type": "structure", + "members": { + "graphIdentifier": { + "target": "com.amazonaws.neptunegraph#GraphIdentifier", + "traits": { + "smithy.api#documentation": "

The source graph identifier of the export task.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that will allow data to be exported to the destination.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the export task.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI where data will be exported to.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key identifier of the export task.

", + "smithy.api#required": {} + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the export task.

" + } + }, + "exportFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilter", + "traits": { + "smithy.api#documentation": "

The export filter of the export task.

" + } + }, + "tags": { + "target": "com.amazonaws.neptunegraph#TagMap", + "traits": { + "smithy.api#documentation": "

Tags to be applied to the export task.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#StartExportTaskOutput": { + "type": "structure", + "members": { + "graphId": { + "target": "com.amazonaws.neptunegraph#GraphId", + "traits": { + "smithy.api#documentation": "

The source graph identifier of the export task.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that will allow data to be exported to the destination.

", + "smithy.api#required": {} + } + }, + "taskId": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.neptunegraph#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "

The current status of the export task.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the export task.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the export task where data will be exported to.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key identifier of the export task.

", + "smithy.api#required": {} + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the export task.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason that the export task has this status value.

" + } + }, + "exportFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilter", + "traits": { + "smithy.api#documentation": "

The export filter of the export task.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.neptunegraph#StartImportTask": { "type": "operation", "input": { @@ -5935,6 +6923,12 @@ "smithy.api#documentation": "

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or \n OPENCYPHER, which identies the openCypher load format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "blankNodeHandling": { "target": "com.amazonaws.neptunegraph#BlankNodeHandling", "traits": { @@ -5990,6 +6984,12 @@ "smithy.api#documentation": "

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or \n OPENCYPHER, which identies the openCypher load format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "roleArn": { "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { @@ -6153,18 +7153,30 @@ "com.amazonaws.neptunegraph#TaskResource": { "type": "resource", "operations": [ + { + "target": "com.amazonaws.neptunegraph#CancelExportTask" + }, { "target": "com.amazonaws.neptunegraph#CancelImportTask" }, { "target": "com.amazonaws.neptunegraph#CreateGraphUsingImportTask" }, + { + "target": "com.amazonaws.neptunegraph#GetExportTask" + }, { "target": "com.amazonaws.neptunegraph#GetImportTask" }, + { + "target": "com.amazonaws.neptunegraph#ListExportTasks" + }, { "target": "com.amazonaws.neptunegraph#ListImportTasks" }, + { + "target": "com.amazonaws.neptunegraph#StartExportTask" + }, { "target": "com.amazonaws.neptunegraph#StartImportTask" } diff --git a/codegen/sdk-codegen/aws-models/omics.json b/codegen/sdk-codegen/aws-models/omics.json index 3aceb914bcf..5d8400c5e74 100644 --- a/codegen/sdk-codegen/aws-models/omics.json +++ b/codegen/sdk-codegen/aws-models/omics.json @@ -182,6 +182,12 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.omics#AccessLogLocation": { + "type": "string", + "traits": { + "smithy.api#pattern": "^$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,800})/)?$" + } + }, "com.amazonaws.omics#ActivateReadSetFilter": { "type": "structure", "members": { @@ -2246,7 +2252,8 @@ "clientToken": { "target": "com.amazonaws.omics#ClientToken", "traits": { - "smithy.api#documentation": "

To ensure that requests don't run multiple times, specify a unique token for each request.

" + "smithy.api#documentation": "

To ensure that requests don't run multiple times, specify a unique token for each request.

", + "smithy.api#idempotencyToken": {} } }, "fallbackLocation": { @@ -2260,6 +2267,18 @@ "traits": { "smithy.api#documentation": "

The ETag algorithm family to use for ingested read sets.

" } + }, + "propagatedSetLevelTags": { + "target": "com.amazonaws.omics#PropagatedSetLevelTags", + "traits": { + "smithy.api#documentation": "

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

" + } + }, + "s3AccessConfig": { + "target": "com.amazonaws.omics#S3AccessConfig", + "traits": { + "smithy.api#documentation": "

S3 access configuration parameters

" + } } }, "traits": { @@ -2320,6 +2339,27 @@ "traits": { "smithy.api#documentation": "

The algorithm family of the ETag.

" } + }, + "status": { + "target": "com.amazonaws.omics#SequenceStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of the sequence store.

" + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#SequenceStoreStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message of the sequence store.

" + } + }, + "propagatedSetLevelTags": { + "target": "com.amazonaws.omics#PropagatedSetLevelTags", + "traits": { + "smithy.api#documentation": "

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

" + } + }, + "s3Access": { + "target": "com.amazonaws.omics#SequenceStoreS3Access" } }, "traits": { @@ -3242,6 +3282,75 @@ "smithy.api#input": {} } }, + "com.amazonaws.omics#DeleteS3AccessPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#DeleteS3AccessPolicyRequest" + }, + "output": { + "target": "com.amazonaws.omics#DeleteS3AccessPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#NotSupportedOperationException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an access policy on a given store" + }, + "smithy.api#documentation": "

Deletes an access policy for the specified store.

", + "smithy.api#endpoint": { + "hostPrefix": "control-storage-" + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/s3accesspolicy/{s3AccessPointArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.omics#DeleteS3AccessPolicyRequest": { + "type": "structure", + "members": { + "s3AccessPointArn": { + "target": "com.amazonaws.omics#S3AccessPointArn", + "traits": { + "smithy.api#documentation": "

The S3 access point ARN that has the access policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#DeleteS3AccessPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#DeleteSequenceStore": { "type": "operation", "input": { @@ -7173,6 +7282,111 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#GetS3AccessPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#GetS3AccessPolicyRequest" + }, + "output": { + "target": "com.amazonaws.omics#GetS3AccessPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#NotSupportedOperationException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get details about an access policy on a given store" + }, + "smithy.api#documentation": "

Retrieves details about an access policy on a given store.

", + "smithy.api#endpoint": { + "hostPrefix": "control-storage-" + }, + "smithy.api#http": { + "method": "GET", + "uri": "/s3accesspolicy/{s3AccessPointArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.omics#GetS3AccessPolicyRequest": { + "type": "structure", + "members": { + "s3AccessPointArn": { + "target": "com.amazonaws.omics#S3AccessPointArn", + "traits": { + "smithy.api#documentation": "

The S3 access point ARN that has the access policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#GetS3AccessPolicyResponse": { + "type": "structure", + "members": { + "s3AccessPointArn": { + "target": "com.amazonaws.omics#S3AccessPointArn", + "traits": { + "smithy.api#documentation": "

The S3 access point ARN that has the access policy.

" + } + }, + "storeId": { + "target": "com.amazonaws.omics#StoreId", + "traits": { + "smithy.api#documentation": "

The AWS-generated Sequence Store or Reference Store ID.

" + } + }, + "storeType": { + "target": "com.amazonaws.omics#StoreType", + "traits": { + "smithy.api#documentation": "

The type of store associated with the access point.

" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the policy was last updated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "s3AccessPolicy": { + "target": "com.amazonaws.omics#S3AccessPolicy", + "traits": { + "smithy.api#documentation": "

The current resource policy that controls S3 access on the store.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#GetSequenceStore": { "type": "operation", "input": { @@ -7291,6 +7505,31 @@ "traits": { "smithy.api#documentation": "

The algorithm family of the ETag.

" } + }, + "status": { + "target": "com.amazonaws.omics#SequenceStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of the sequence store.

" + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#SequenceStoreStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message of the sequence store.

" + } + }, + "propagatedSetLevelTags": { + "target": "com.amazonaws.omics#PropagatedSetLevelTags", + "traits": { + "smithy.api#documentation": "

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The last-updated time of the sequence store.

", + "smithy.api#timestampFormat": "date-time" + } } }, "traits": { @@ -11058,6 +11297,17 @@ "com.amazonaws.omics#Omics": { "type": "service", "version": "2022-11-28", + "operations": [ + { + "target": "com.amazonaws.omics#DeleteS3AccessPolicy" + }, + { + "target": "com.amazonaws.omics#GetS3AccessPolicy" + }, + { + "target": "com.amazonaws.omics#PutS3AccessPolicy" + } + ], "resources": [ { "target": "com.amazonaws.omics#AnnotationImportJob" @@ -11800,37 +12050,143 @@ } } }, - "com.amazonaws.omics#Quote": { - "type": "string", + "com.amazonaws.omics#PropagatedSetLevelTags": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#TagKey" + }, "traits": { "smithy.api#length": { - "min": 1, - "max": 1 + "min": 0, + "max": 50 } } }, - "com.amazonaws.omics#QuoteAll": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.omics#Range": { - "type": "string", + "com.amazonaws.omics#PutS3AccessPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#PutS3AccessPolicyRequest" + }, + "output": { + "target": "com.amazonaws.omics#PutS3AccessPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#NotSupportedOperationException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 + "aws.iam#iamAction": { + "documentation": "Grants permission to put an access policy on a given store" }, - "smithy.api#pattern": "^[\\p{N}||\\p{P}]+$" + "smithy.api#documentation": "

Adds an access policy to the specified store.

", + "smithy.api#endpoint": { + "hostPrefix": "control-storage-" + }, + "smithy.api#http": { + "method": "PUT", + "uri": "/s3accesspolicy/{s3AccessPointArn}" + } } }, - "com.amazonaws.omics#RangeNotSatisfiableException": { + "com.amazonaws.omics#PutS3AccessPolicyRequest": { "type": "structure", "members": { - "message": { - "target": "smithy.api#String", - "traits": { + "s3AccessPointArn": { + "target": "com.amazonaws.omics#S3AccessPointArn", + "traits": { + "smithy.api#documentation": "

The S3 access point ARN where you want to put the access policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "s3AccessPolicy": { + "target": "com.amazonaws.omics#S3AccessPolicy", + "traits": { + "smithy.api#documentation": "

The resource policy that controls S3 access to the store.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#PutS3AccessPolicyResponse": { + "type": "structure", + "members": { + "s3AccessPointArn": { + "target": "com.amazonaws.omics#S3AccessPointArn", + "traits": { + "smithy.api#documentation": "

The S3 access point ARN that now has the access policy.

" + } + }, + "storeId": { + "target": "com.amazonaws.omics#StoreId", + "traits": { + "smithy.api#documentation": "

The AWS-generated Sequence Store or Reference Store ID.

" + } + }, + "storeType": { + "target": "com.amazonaws.omics#StoreType", + "traits": { + "smithy.api#documentation": "

The type of store associated with the access point.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#Quote": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.omics#QuoteAll": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.omics#Range": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[\\p{N}||\\p{P}]+$" + } + }, + "com.amazonaws.omics#RangeNotSatisfiableException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { "smithy.api#required": {} } } @@ -13939,6 +14295,20 @@ "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" } }, + "com.amazonaws.omics#S3AccessConfig": { + "type": "structure", + "members": { + "accessLogLocation": { + "target": "com.amazonaws.omics#AccessLogLocation", + "traits": { + "smithy.api#documentation": "

Location of the access logs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

S3 access configuration parameters.

" + } + }, "com.amazonaws.omics#S3AccessPointArn": { "type": "string", "traits": { @@ -13949,6 +14319,16 @@ "smithy.api#pattern": "^arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*$" } }, + "com.amazonaws.omics#S3AccessPolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#mediaType": "application/json" + } + }, "com.amazonaws.omics#S3Destination": { "type": "string", "traits": { @@ -14154,6 +14534,25 @@ "traits": { "smithy.api#documentation": "

The algorithm family of the ETag.

" } + }, + "status": { + "target": "com.amazonaws.omics#SequenceStoreStatus", + "traits": { + "smithy.api#documentation": "

Status of the sequence store.

" + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#SequenceStoreStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message of the sequence store.

" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The last-updated time of the Sequence Store.

", + "smithy.api#timestampFormat": "date-time" + } } }, "traits": { @@ -14188,6 +14587,26 @@ "smithy.api#documentation": "

The filter's end date.

", "smithy.api#timestampFormat": "date-time" } + }, + "status": { + "target": "com.amazonaws.omics#SequenceStoreStatus", + "traits": { + "smithy.api#documentation": "

Filter results based on status.

" + } + }, + "updatedAfter": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter results based on stores updated after the specified time.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedBefore": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

Filter results based on stores updated before the specified time.

", + "smithy.api#timestampFormat": "date-time" + } } }, "traits": { @@ -14227,6 +14646,9 @@ "read": { "target": "com.amazonaws.omics#GetSequenceStore" }, + "update": { + "target": "com.amazonaws.omics#UpdateSequenceStore" + }, "delete": { "target": "com.amazonaws.omics#DeleteSequenceStore" }, @@ -14316,12 +14738,55 @@ "traits": { "smithy.api#documentation": "

This is ARN of the access point associated with the S3 bucket storing read sets.

" } + }, + "accessLogLocation": { + "target": "com.amazonaws.omics#AccessLogLocation", + "traits": { + "smithy.api#documentation": "

Location of the access logs.

" + } } }, "traits": { "smithy.api#documentation": "

The S3 access metadata of the sequence store.

" } }, + "com.amazonaws.omics#SequenceStoreStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.omics#SequenceStoreStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, "com.amazonaws.omics#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -15671,6 +16136,16 @@ ] } }, + "com.amazonaws.omics#StoreId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 36 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, "com.amazonaws.omics#StoreName": { "type": "string", "traits": { @@ -15727,6 +16202,23 @@ ] } }, + "com.amazonaws.omics#StoreType": { + "type": "enum", + "members": { + "SEQUENCE_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEQUENCE_STORE" + } + }, + "REFERENCE_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REFERENCE_STORE" + } + } + } + }, "com.amazonaws.omics#SubjectId": { "type": "string", "traits": { @@ -16742,6 +17234,187 @@ "smithy.api#input": {} } }, + "com.amazonaws.omics#UpdateSequenceStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#UpdateSequenceStoreRequest" + }, + "output": { + "target": "com.amazonaws.omics#UpdateSequenceStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update one or more parameters for the sequence store.

", + "smithy.api#endpoint": { + "hostPrefix": "control-storage-" + }, + "smithy.api#http": { + "method": "PATCH", + "uri": "/sequencestore/{id}" + } + } + }, + "com.amazonaws.omics#UpdateSequenceStoreRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.omics#SequenceStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the sequence store.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "sequenceStoreId" + } + }, + "name": { + "target": "com.amazonaws.omics#SequenceStoreName", + "traits": { + "smithy.api#documentation": "

A name for the sequence store.

" + } + }, + "description": { + "target": "com.amazonaws.omics#SequenceStoreDescription", + "traits": { + "smithy.api#documentation": "

A description for the sequence store.

" + } + }, + "clientToken": { + "target": "com.amazonaws.omics#ClientToken", + "traits": { + "smithy.api#documentation": "

To ensure that requests don't run multiple times, specify a unique token for each request.

", + "smithy.api#idempotencyToken": {} + } + }, + "fallbackLocation": { + "target": "com.amazonaws.omics#S3Destination", + "traits": { + "smithy.api#documentation": "

The S3 URI of a bucket and folder to store Read Sets that fail to upload.

" + } + }, + "propagatedSetLevelTags": { + "target": "com.amazonaws.omics#PropagatedSetLevelTags", + "traits": { + "smithy.api#documentation": "

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

" + } + }, + "s3AccessConfig": { + "target": "com.amazonaws.omics#S3AccessConfig", + "traits": { + "smithy.api#documentation": "

S3 access configuration parameters.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#UpdateSequenceStoreResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.omics#SequenceStoreId", + "traits": { + "smithy.api#documentation": "

The ID of the sequence store.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.omics#SequenceStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the sequence store.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.omics#SequenceStoreName", + "traits": { + "smithy.api#documentation": "

The name of the sequence store.

" + } + }, + "description": { + "target": "com.amazonaws.omics#SequenceStoreDescription", + "traits": { + "smithy.api#documentation": "

Description of the sequence store.

" + } + }, + "sseConfig": { + "target": "com.amazonaws.omics#SseConfig" + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the store was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The last-updated time of the Sequence Store.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "propagatedSetLevelTags": { + "target": "com.amazonaws.omics#PropagatedSetLevelTags", + "traits": { + "smithy.api#documentation": "

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

" + } + }, + "status": { + "target": "com.amazonaws.omics#SequenceStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of the sequence store.

" + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#SequenceStoreStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message of the sequence store.

" + } + }, + "fallbackLocation": { + "target": "com.amazonaws.omics#S3Destination", + "traits": { + "smithy.api#documentation": "

The S3 URI of a bucket and folder to store Read Sets that fail to upload.

" + } + }, + "s3Access": { + "target": "com.amazonaws.omics#SequenceStoreS3Access" + }, + "eTagAlgorithmFamily": { + "target": "com.amazonaws.omics#ETagAlgorithmFamily", + "traits": { + "smithy.api#documentation": "

The ETag algorithm family to use on ingested read sets.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#UpdateTime": { "type": "timestamp", "traits": { diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 399ae2f7c39..68bf9976abc 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -720,6 +720,12 @@ }, "QueryExecutionOptions": { "target": "com.amazonaws.quicksight#QueryExecutionOptions" + }, + "StaticFiles": { + "target": "com.amazonaws.quicksight#StaticFileList", + "traits": { + "smithy.api#documentation": "

The static files for the definition.

" + } } }, "traits": { @@ -3442,13 +3448,13 @@ "Body": { "target": "com.amazonaws.quicksight#AssetBundleImportBodyBlob", "traits": { - "smithy.api#documentation": "

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.

\n

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or\n PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using\n an SDK for a different language or receiving related errors, try to base64 encode your data.

" + "smithy.api#documentation": "

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB. If the size of the file that you want to upload is more than 20 MB, add the file to your Amazon S3 bucket and use S3Uri of the file for this operation.

\n

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.

" } }, "S3Uri": { "target": "com.amazonaws.quicksight#S3Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller\n has read access to. The file must be a zip format file and can't exceed 20 MB.

" + "smithy.api#documentation": "

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 1 GB.

" } } }, @@ -4417,6 +4423,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -5278,6 +5290,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -7323,6 +7341,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -11139,6 +11163,12 @@ "traits": { "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags that are assigned to\n the dataset.

" } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

The Folder ARN of the folder that you want the topic to reside in.

" + } } }, "traits": { @@ -11745,6 +11775,12 @@ "smithy.api#documentation": "

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

", "smithy.api#required": {} } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -12584,6 +12620,12 @@ "traits": { "smithy.api#documentation": "

An array of option definitions for a dashboard.

" } + }, + "StaticFiles": { + "target": "com.amazonaws.quicksight#StaticFileList", + "traits": { + "smithy.api#documentation": "

The static files for the definition.

" + } } }, "traits": { @@ -12689,6 +12731,23 @@ "smithy.api#documentation": "

The visual publish options of a visual in a dashboard

" } }, + "com.amazonaws.quicksight#DashboardsQAStatus": { + "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.quicksight#DataAggregation": { "type": "structure", "members": { @@ -20556,149 +20615,20 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#DescribeDataSet": { + "com.amazonaws.quicksight#DescribeDashboardsQAConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetRequest" + "target": "com.amazonaws.quicksight#DescribeDashboardsQAConfigurationRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetResponse" + "target": "com.amazonaws.quicksight#DescribeDashboardsQAConfigurationResponse" }, "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#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse" - }, - "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#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { - "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#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { - "type": "structure", - "members": { - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the dataset.

" - } - }, - "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#DescribeDataSetRefreshProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" + "target": "com.amazonaws.quicksight#ConflictException" }, { "target": "com.amazonaws.quicksight#InternalFailureException" @@ -20706,12 +20636,6 @@ { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, { "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, @@ -20720,81 +20644,21 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the refresh properties of a dataset.

", + "smithy.api#documentation": "

Describes an existing dashboard QA configuration.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "uri": "/accounts/{AwsAccountId}/dashboards-qa-configuration", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { - "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#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { - "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": {} - } - }, - "DataSetRefreshProperties": { - "target": "com.amazonaws.quicksight#DataSetRefreshProperties", - "traits": { - "smithy.api#documentation": "

The dataset refresh properties.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRequest": { + "com.amazonaws.quicksight#DescribeDashboardsQAConfigurationRequest": { "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#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want described.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -20804,13 +20668,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DescribeDataSetResponse": { + "com.amazonaws.quicksight#DescribeDashboardsQAConfigurationResponse": { "type": "structure", "members": { - "DataSet": { - "target": "com.amazonaws.quicksight#DataSet", + "DashboardsQAStatus": { + "target": "com.amazonaws.quicksight#DashboardsQAStatus", "traits": { - "smithy.api#documentation": "

Information on the dataset.

" + "smithy.api#documentation": "

The status of dashboards QA configuration that you want described.

" } }, "RequestId": { @@ -20832,13 +20696,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#DescribeDataSource": { + "com.amazonaws.quicksight#DescribeDataSet": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeDataSourceRequest" + "target": "com.amazonaws.quicksight#DescribeDataSetRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeDataSourceResponse" + "target": "com.amazonaws.quicksight#DescribeDataSetResponse" }, "errors": [ { @@ -20858,21 +20722,21 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a data source.

", + "smithy.api#documentation": "

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeDataSourcePermissions": { + "com.amazonaws.quicksight#DescribeDataSetPermissions": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest" + "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse" + "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse" }, "errors": [ { @@ -20892,15 +20756,15 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the resource permissions for a data source.

", + "smithy.api#documentation": "

Describes the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { + "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { "type": "structure", "members": { "AwsAccountId": { @@ -20911,10 +20775,10 @@ "smithy.api#required": {} } }, - "DataSourceId": { + "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -20924,25 +20788,301 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse": { + "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { "type": "structure", "members": { - "DataSourceArn": { + "DataSetArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" } }, - "DataSourceId": { + "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" } }, "Permissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "

A list of resource permissions on the data source.

" + "smithy.api#documentation": "

A list of resource permissions on the dataset.

" + } + }, + "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#DescribeDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" + }, + "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#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the refresh properties of a dataset.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { + "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#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { + "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": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "

The dataset refresh properties.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRequest": { + "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#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetResponse": { + "type": "structure", + "members": { + "DataSet": { + "target": "com.amazonaws.quicksight#DataSet", + "traits": { + "smithy.api#documentation": "

Information on the dataset.

" + } + }, + "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#DescribeDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSourceResponse" + }, + "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#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a data source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse" + }, + "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#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the resource permissions for a data source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { + "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": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the data source.

" } }, "RequestId": { @@ -24969,6 +25109,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -26129,6 +26275,12 @@ "traits": { "smithy.api#documentation": "

Determines the text display face that is inherited by the given font family.

" } + }, + "FontFamily": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The font family that you want to use.

" + } } }, "traits": { @@ -26172,6 +26324,12 @@ "traits": { "smithy.api#documentation": "

The lexical name for the text size, proportional to its surrounding context.

" } + }, + "Absolute": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The font size that you want to use in px.

" + } } }, "traits": { @@ -26865,6 +27023,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -27118,6 +27282,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -27465,6 +27635,156 @@ } } }, + "com.amazonaws.quicksight#GeospatialCategoricalColor": { + "type": "structure", + "members": { + "CategoryDataColors": { + "target": "com.amazonaws.quicksight#GeospatialCategoricalDataColorList", + "traits": { + "smithy.api#documentation": "

A list of categorical data colors for each category.

", + "smithy.api#required": {} + } + }, + "NullDataVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The state of visibility for null data.

" + } + }, + "NullDataSettings": { + "target": "com.amazonaws.quicksight#GeospatialNullDataSettings", + "traits": { + "smithy.api#documentation": "

The null data visualization settings.

" + } + }, + "DefaultOpacity": { + "target": "com.amazonaws.quicksight#Opacity", + "traits": { + "smithy.api#documentation": "

The default opacity of a categorical color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a categorical color.

" + } + }, + "com.amazonaws.quicksight#GeospatialCategoricalDataColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the category data color.

", + "smithy.api#required": {} + } + }, + "DataValue": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The data value for the category data color.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The categorical data color for a single category.

" + } + }, + "com.amazonaws.quicksight#GeospatialCategoricalDataColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GeospatialCategoricalDataColor" + } + }, + "com.amazonaws.quicksight#GeospatialCircleRadius": { + "type": "structure", + "members": { + "Radius": { + "target": "com.amazonaws.quicksight#GeospatialRadius", + "traits": { + "smithy.api#documentation": "

The positive value for the radius of a circle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The geospatial radius for a circle.

" + } + }, + "com.amazonaws.quicksight#GeospatialCircleSymbolStyle": { + "type": "structure", + "members": { + "FillColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the fill color.

" + } + }, + "StrokeColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the stroke color.

" + } + }, + "StrokeWidth": { + "target": "com.amazonaws.quicksight#GeospatialLineWidth", + "traits": { + "smithy.api#documentation": "

The width of the stroke (border).

" + } + }, + "CircleRadius": { + "target": "com.amazonaws.quicksight#GeospatialCircleRadius", + "traits": { + "smithy.api#documentation": "

The radius of the circle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties for a circle symbol style.

" + } + }, + "com.amazonaws.quicksight#GeospatialColor": { + "type": "structure", + "members": { + "Solid": { + "target": "com.amazonaws.quicksight#GeospatialSolidColor", + "traits": { + "smithy.api#documentation": "

The visualization properties for the solid color.

" + } + }, + "Gradient": { + "target": "com.amazonaws.quicksight#GeospatialGradientColor", + "traits": { + "smithy.api#documentation": "

The visualization properties for the gradient color.

" + } + }, + "Categorical": { + "target": "com.amazonaws.quicksight#GeospatialCategoricalColor", + "traits": { + "smithy.api#documentation": "

The visualization properties for the categorical color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visualization properties for solid, gradient, and categorical colors.

" + } + }, + "com.amazonaws.quicksight#GeospatialColorState": { + "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.quicksight#GeospatialCoordinateBounds": { "type": "structure", "members": { @@ -27501,6 +27821,88 @@ "smithy.api#documentation": "

The bound\n options (north, south, west, east) of the geospatial window options.

" } }, + "com.amazonaws.quicksight#GeospatialDataSourceItem": { + "type": "structure", + "members": { + "StaticFileDataSource": { + "target": "com.amazonaws.quicksight#GeospatialStaticFileSource", + "traits": { + "smithy.api#documentation": "

The static file data source properties for the geospatial data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data source properties for the geospatial data.

" + } + }, + "com.amazonaws.quicksight#GeospatialGradientColor": { + "type": "structure", + "members": { + "StepColors": { + "target": "com.amazonaws.quicksight#GeospatialGradientStepColorList", + "traits": { + "smithy.api#documentation": "

A list of gradient step colors for the gradient.

", + "smithy.api#required": {} + } + }, + "NullDataVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The state of visibility for null data.

" + } + }, + "NullDataSettings": { + "target": "com.amazonaws.quicksight#GeospatialNullDataSettings", + "traits": { + "smithy.api#documentation": "

The null data visualization settings.

" + } + }, + "DefaultOpacity": { + "target": "com.amazonaws.quicksight#Opacity", + "traits": { + "smithy.api#documentation": "

The default opacity for the gradient color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a gradient color.

" + } + }, + "com.amazonaws.quicksight#GeospatialGradientStepColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the gradient step color.

", + "smithy.api#required": {} + } + }, + "DataValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The data value for the gradient step color.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The gradient step color for a single step.

" + } + }, + "com.amazonaws.quicksight#GeospatialGradientStepColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GeospatialGradientStepColor" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + } + } + }, "com.amazonaws.quicksight#GeospatialHeatmapColorScale": { "type": "structure", "members": { @@ -27556,6 +27958,277 @@ } } }, + "com.amazonaws.quicksight#GeospatialLayerColorField": { + "type": "structure", + "members": { + "ColorDimensionsFields": { + "target": "com.amazonaws.quicksight#GeospatialLayerDimensionFieldList", + "traits": { + "smithy.api#documentation": "

A list of color dimension fields.

" + } + }, + "ColorValuesFields": { + "target": "com.amazonaws.quicksight#GeospatialLayerMeasureFieldList", + "traits": { + "smithy.api#documentation": "

A list of color measure fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color field that defines a gradient or categorical style.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerDefinition": { + "type": "structure", + "members": { + "PointLayer": { + "target": "com.amazonaws.quicksight#GeospatialPointLayer", + "traits": { + "smithy.api#documentation": "

The definition for a point layer.

" + } + }, + "LineLayer": { + "target": "com.amazonaws.quicksight#GeospatialLineLayer", + "traits": { + "smithy.api#documentation": "

The definition for a line layer.

" + } + }, + "PolygonLayer": { + "target": "com.amazonaws.quicksight#GeospatialPolygonLayer", + "traits": { + "smithy.api#documentation": "

The definition for a polygon layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition properties for a geospatial layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#GeospatialLayerItem": { + "type": "structure", + "members": { + "LayerId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the layer.

", + "smithy.api#required": {} + } + }, + "LayerType": { + "target": "com.amazonaws.quicksight#GeospatialLayerType", + "traits": { + "smithy.api#documentation": "

The layer type.

" + } + }, + "DataSource": { + "target": "com.amazonaws.quicksight#GeospatialDataSourceItem", + "traits": { + "smithy.api#documentation": "

The data source for the layer.

" + } + }, + "Label": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The label that is displayed for the layer.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The state of visibility for the layer.

" + } + }, + "LayerDefinition": { + "target": "com.amazonaws.quicksight#GeospatialLayerDefinition", + "traits": { + "smithy.api#documentation": "

The definition properties for a layer.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions" + }, + "JoinDefinition": { + "target": "com.amazonaws.quicksight#GeospatialLayerJoinDefinition", + "traits": { + "smithy.api#documentation": "

The join definition properties for a layer.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#LayerCustomActionList", + "traits": { + "smithy.api#documentation": "

A list of custom actions for a layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties for a single geospatial layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerJoinDefinition": { + "type": "structure", + "members": { + "ShapeKeyField": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the field or property in the geospatial data source.

" + } + }, + "DatasetKeyField": { + "target": "com.amazonaws.quicksight#UnaggregatedField" + }, + "ColorField": { + "target": "com.amazonaws.quicksight#GeospatialLayerColorField", + "traits": { + "smithy.api#documentation": "

The geospatial color field for the join definition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom actions for a layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerMapConfiguration": { + "type": "structure", + "members": { + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions" + }, + "MapLayers": { + "target": "com.amazonaws.quicksight#GeospatialMapLayerList", + "traits": { + "smithy.api#documentation": "

The geospatial layers to visualize on the map.

" + } + }, + "MapState": { + "target": "com.amazonaws.quicksight#GeospatialMapState", + "traits": { + "smithy.api#documentation": "

The map state properties for the map.

" + } + }, + "MapStyle": { + "target": "com.amazonaws.quicksight#GeospatialMapStyle", + "traits": { + "smithy.api#documentation": "

The map style properties for the map.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The map definition that defines map state, map style, and geospatial layers.

" + } + }, + "com.amazonaws.quicksight#GeospatialLayerMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#GeospatialLayerType": { + "type": "enum", + "members": { + "POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POINT" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "POLYGON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLYGON" + } + } + } + }, + "com.amazonaws.quicksight#GeospatialLineLayer": { + "type": "structure", + "members": { + "Style": { + "target": "com.amazonaws.quicksight#GeospatialLineStyle", + "traits": { + "smithy.api#documentation": "

The visualization style for a line layer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The geospatial Line layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLineStyle": { + "type": "structure", + "members": { + "LineSymbolStyle": { + "target": "com.amazonaws.quicksight#GeospatialLineSymbolStyle", + "traits": { + "smithy.api#documentation": "

The symbol style for a line style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visualization style for a line layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLineSymbolStyle": { + "type": "structure", + "members": { + "FillColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the fill color.

" + } + }, + "LineWidth": { + "target": "com.amazonaws.quicksight#GeospatialLineWidth", + "traits": { + "smithy.api#documentation": "

The width value for a line.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The symbol style for a line layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialLineWidth": { + "type": "structure", + "members": { + "LineWidth": { + "target": "com.amazonaws.quicksight#GeospatialWidth", + "traits": { + "smithy.api#documentation": "

The positive value for the width of a line.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The width properties for a line.

" + } + }, "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells": { "type": "structure", "members": { @@ -27649,6 +28322,72 @@ "smithy.api#documentation": "

The field wells of a GeospatialMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" } }, + "com.amazonaws.quicksight#GeospatialMapLayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GeospatialLayerItem" + } + }, + "com.amazonaws.quicksight#GeospatialMapNavigation": { + "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.quicksight#GeospatialMapState": { + "type": "structure", + "members": { + "Bounds": { + "target": "com.amazonaws.quicksight#GeospatialCoordinateBounds" + }, + "MapNavigation": { + "target": "com.amazonaws.quicksight#GeospatialMapNavigation", + "traits": { + "smithy.api#documentation": "

Enables or disables map navigation for a map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The map state properties for a map.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapStyle": { + "type": "structure", + "members": { + "BaseMapStyle": { + "target": "com.amazonaws.quicksight#BaseMapStyleType", + "traits": { + "smithy.api#documentation": "

The selected base map style.

" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The background color and opacity values for a map.

" + } + }, + "BaseMapVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The state of visibility for the base map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The map style properties for a map.

" + } + }, "com.amazonaws.quicksight#GeospatialMapStyleOptions": { "type": "structure", "members": { @@ -27702,12 +28441,88 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" } }, + "com.amazonaws.quicksight#GeospatialNullDataSettings": { + "type": "structure", + "members": { + "SymbolStyle": { + "target": "com.amazonaws.quicksight#GeospatialNullSymbolStyle", + "traits": { + "smithy.api#documentation": "

The symbol style for null data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties for the visualization of null data.

" + } + }, + "com.amazonaws.quicksight#GeospatialNullSymbolStyle": { + "type": "structure", + "members": { + "FillColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the fill color.

" + } + }, + "StrokeColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the stroke color.

" + } + }, + "StrokeWidth": { + "target": "com.amazonaws.quicksight#GeospatialWidth", + "traits": { + "smithy.api#documentation": "

The width of the border stroke.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The symbol style for null data.

" + } + }, + "com.amazonaws.quicksight#GeospatialPointLayer": { + "type": "structure", + "members": { + "Style": { + "target": "com.amazonaws.quicksight#GeospatialPointStyle", + "traits": { + "smithy.api#documentation": "

The visualization style for a point layer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The geospatial Point layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialPointStyle": { + "type": "structure", + "members": { + "CircleSymbolStyle": { + "target": "com.amazonaws.quicksight#GeospatialCircleSymbolStyle", + "traits": { + "smithy.api#documentation": "

The circle symbol style for a point layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The point style for a point layer.

" + } + }, "com.amazonaws.quicksight#GeospatialPointStyleOptions": { "type": "structure", "members": { @@ -27734,6 +28549,69 @@ "smithy.api#documentation": "

The point style of the geospatial map.

" } }, + "com.amazonaws.quicksight#GeospatialPolygonLayer": { + "type": "structure", + "members": { + "Style": { + "target": "com.amazonaws.quicksight#GeospatialPolygonStyle", + "traits": { + "smithy.api#documentation": "

The visualization style for a polygon layer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The geospatial polygon layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialPolygonStyle": { + "type": "structure", + "members": { + "PolygonSymbolStyle": { + "target": "com.amazonaws.quicksight#GeospatialPolygonSymbolStyle", + "traits": { + "smithy.api#documentation": "

The polygon symbol style for a polygon layer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The polygon style for a polygon layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialPolygonSymbolStyle": { + "type": "structure", + "members": { + "FillColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the fill color.

" + } + }, + "StrokeColor": { + "target": "com.amazonaws.quicksight#GeospatialColor", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the stroke color.

" + } + }, + "StrokeWidth": { + "target": "com.amazonaws.quicksight#GeospatialLineWidth", + "traits": { + "smithy.api#documentation": "

The width of the border stroke.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The polygon symbol style for a polygon layer.

" + } + }, + "com.amazonaws.quicksight#GeospatialRadius": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.quicksight#GeospatialSelectedPointStyle": { "type": "enum", "members": { @@ -27757,6 +28635,50 @@ } } }, + "com.amazonaws.quicksight#GeospatialSolidColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The color and opacity values for the color.

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.quicksight#GeospatialColorState", + "traits": { + "smithy.api#documentation": "

Enables and disables the view state of the color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a solid color.

" + } + }, + "com.amazonaws.quicksight#GeospatialStaticFileSource": { + "type": "structure", + "members": { + "StaticFileId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the static file.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source properties for a geospatial static file.

" + } + }, + "com.amazonaws.quicksight#GeospatialWidth": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.quicksight#GeospatialWindowOptions": { "type": "structure", "members": { @@ -28741,6 +29663,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -28953,6 +29881,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -29396,6 +30330,143 @@ "smithy.api#documentation": "

The logo image configuration.

" } }, + "com.amazonaws.quicksight#ImageCustomAction": { + "type": "structure", + "members": { + "CustomActionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the custom action.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ImageCustomActionName", + "traits": { + "smithy.api#documentation": "

The name of the custom action.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the custom action.

" + } + }, + "Trigger": { + "target": "com.amazonaws.quicksight#ImageCustomActionTrigger", + "traits": { + "smithy.api#documentation": "

The trigger of the VisualCustomAction.

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + }, + "ActionOperations": { + "target": "com.amazonaws.quicksight#ImageCustomActionOperationList", + "traits": { + "smithy.api#documentation": "

A list of ImageCustomActionOperations.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom action defined on an image.

" + } + }, + "com.amazonaws.quicksight#ImageCustomActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ImageCustomAction" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#ImageCustomActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#ImageCustomActionOperation": { + "type": "structure", + "members": { + "NavigationOperation": { + "target": "com.amazonaws.quicksight#CustomActionNavigationOperation" + }, + "URLOperation": { + "target": "com.amazonaws.quicksight#CustomActionURLOperation" + }, + "SetParametersOperation": { + "target": "com.amazonaws.quicksight#CustomActionSetParametersOperation" + } + }, + "traits": { + "smithy.api#documentation": "

The operation that is defined by the custom action.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ImageCustomActionOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ImageCustomActionOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#ImageCustomActionTrigger": { + "type": "enum", + "members": { + "CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLICK" + } + }, + "MENU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MENU" + } + } + } + }, + "com.amazonaws.quicksight#ImageInteractionOptions": { + "type": "structure", + "members": { + "ImageMenuOption": { + "target": "com.amazonaws.quicksight#ImageMenuOption", + "traits": { + "smithy.api#documentation": "

The menu options for the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The general image interactions setup for image publish options.

" + } + }, + "com.amazonaws.quicksight#ImageMenuOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The availability status of the image menu. If the value of this property is set to ENABLED, dashboard readers can interact with the image menu.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The menu options for the interactions of an image.

" + } + }, "com.amazonaws.quicksight#ImageSet": { "type": "structure", "members": { @@ -29458,6 +30529,27 @@ "smithy.api#documentation": "

The source of the image.

" } }, + "com.amazonaws.quicksight#ImageStaticFile": { + "type": "structure", + "members": { + "StaticFileId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the static file that contains an image.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.quicksight#StaticFileSource", + "traits": { + "smithy.api#documentation": "

The source of the image static file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A static file that contains an image.

" + } + }, "com.amazonaws.quicksight#IncludeFolderMembers": { "type": "enum", "members": { @@ -30146,6 +31238,12 @@ "smithy.api#documentation": "

The dataset that is used in the insight visual.

", "smithy.api#required": {} } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -30984,6 +32082,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -31077,6 +32181,158 @@ } } }, + "com.amazonaws.quicksight#LayerCustomAction": { + "type": "structure", + "members": { + "CustomActionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the custom action.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#LayerCustomActionName", + "traits": { + "smithy.api#documentation": "

The name of the custom action.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the LayerCustomAction.

" + } + }, + "Trigger": { + "target": "com.amazonaws.quicksight#LayerCustomActionTrigger", + "traits": { + "smithy.api#documentation": "

The trigger of the LayerCustomAction.

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + }, + "ActionOperations": { + "target": "com.amazonaws.quicksight#LayerCustomActionOperationList", + "traits": { + "smithy.api#documentation": "

A list of LayerCustomActionOperations.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A layer custom action.

" + } + }, + "com.amazonaws.quicksight#LayerCustomActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#LayerCustomAction" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#LayerCustomActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#LayerCustomActionOperation": { + "type": "structure", + "members": { + "FilterOperation": { + "target": "com.amazonaws.quicksight#CustomActionFilterOperation" + }, + "NavigationOperation": { + "target": "com.amazonaws.quicksight#CustomActionNavigationOperation" + }, + "URLOperation": { + "target": "com.amazonaws.quicksight#CustomActionURLOperation" + }, + "SetParametersOperation": { + "target": "com.amazonaws.quicksight#CustomActionSetParametersOperation" + } + }, + "traits": { + "smithy.api#documentation": "

The operation that is defined by the custom action.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#LayerCustomActionOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#LayerCustomActionOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#LayerCustomActionTrigger": { + "type": "enum", + "members": { + "DATA_POINT_CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_CLICK" + } + }, + "DATA_POINT_MENU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_MENU" + } + } + } + }, + "com.amazonaws.quicksight#LayerMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the visual.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions" + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions" + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#GeospatialLayerMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The dataset that is used to create the layer map visual. You can't create a visual without a dataset.

", + "smithy.api#required": {} + } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A layer map visual.

" + } + }, "com.amazonaws.quicksight#Layout": { "type": "structure", "members": { @@ -31144,6 +32400,12 @@ "traits": { "smithy.api#enumValue": "TEXT_BOX" } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } } } }, @@ -31191,6 +32453,9 @@ "traits": { "smithy.api#documentation": "

The height of the legend. If this value is omitted, a default height is used when\n rendering.

" } + }, + "ValueFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration" } }, "traits": { @@ -31711,6 +32976,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -36716,6 +37987,18 @@ "traits": { "smithy.api#documentation": "

An error that occurred when the namespace was created.

" } + }, + "IamIdentityCenterApplicationArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center application.

" + } + }, + "IamIdentityCenterInstanceArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" + } } }, "traits": { @@ -37643,6 +38926,15 @@ } } }, + "com.amazonaws.quicksight#Opacity": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.quicksight#OperandList": { "type": "list", "member": { @@ -38965,6 +40257,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -39761,6 +41059,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -39829,6 +41133,222 @@ "smithy.api#documentation": "String based length that is composed of value and unit in px" } }, + "com.amazonaws.quicksight#PluginVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the visual that you want to use.

", + "smithy.api#required": {} + } + }, + "PluginArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that reflects the plugin and version.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions" + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions" + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#PluginVisualConfiguration", + "traits": { + "smithy.api#documentation": "

\n A description of the plugin field wells and their persisted properties.\n

" + } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A flexible visualization type that allows engineers \n to create new custom charts in Amazon QuickSight.

" + } + }, + "com.amazonaws.quicksight#PluginVisualAxisName": { + "type": "enum", + "members": { + "GROUP_BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP_BY" + } + }, + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + } + } + }, + "com.amazonaws.quicksight#PluginVisualConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#PluginVisualFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells configuration of the plugin visual.

" + } + }, + "VisualOptions": { + "target": "com.amazonaws.quicksight#PluginVisualOptions", + "traits": { + "smithy.api#documentation": "

The persisted properties of the plugin visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#PluginVisualSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of the plugin visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The plugin visual configuration. This includes the field wells, sorting options, and persisted options of the plugin visual.

" + } + }, + "com.amazonaws.quicksight#PluginVisualFieldWell": { + "type": "structure", + "members": { + "AxisName": { + "target": "com.amazonaws.quicksight#PluginVisualAxisName", + "traits": { + "smithy.api#documentation": "

The semantic axis name for the field well.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

A list of dimensions for the field well.

" + } + }, + "Measures": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

A list of measures that exist in the field well.

" + } + }, + "Unaggregated": { + "target": "com.amazonaws.quicksight#UnaggregatedFieldList", + "traits": { + "smithy.api#documentation": "

A list of unaggregated fields that exist in the field well.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of field wells for a plugin visual.

" + } + }, + "com.amazonaws.quicksight#PluginVisualFieldWells": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PluginVisualFieldWell" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#PluginVisualItemsLimitConfiguration": { + "type": "structure", + "members": { + "ItemsLimit": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines how many values are be fetched at once.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A query limits configuration.

" + } + }, + "com.amazonaws.quicksight#PluginVisualOptions": { + "type": "structure", + "members": { + "VisualProperties": { + "target": "com.amazonaws.quicksight#PluginVisualPropertiesList", + "traits": { + "smithy.api#documentation": "

The persisted properties and their values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options and persisted properties for the plugin visual.

" + } + }, + "com.amazonaws.quicksight#PluginVisualPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PluginVisualProperty" + } + }, + "com.amazonaws.quicksight#PluginVisualProperty": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the plugin visual property.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the plugin visual property.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The key value pair of the persisted property.

" + } + }, + "com.amazonaws.quicksight#PluginVisualSortConfiguration": { + "type": "structure", + "members": { + "PluginVisualTableQuerySort": { + "target": "com.amazonaws.quicksight#PluginVisualTableQuerySort", + "traits": { + "smithy.api#documentation": "

The table query sorting options for the plugin visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines how the plugin visual sorts the data during query.

" + } + }, + "com.amazonaws.quicksight#PluginVisualTableQuerySort": { + "type": "structure", + "members": { + "RowSort": { + "target": "com.amazonaws.quicksight#RowSortList", + "traits": { + "smithy.api#documentation": "

Determines how data is sorted in the response.

" + } + }, + "ItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#PluginVisualItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The maximum amount of data to be returned by a query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The table query sorting options for the plugin visual.

" + } + }, "com.amazonaws.quicksight#Port": { "type": "integer", "traits": { @@ -40544,6 +42064,9 @@ { "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult" }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardsQAConfiguration" + }, { "target": "com.amazonaws.quicksight#DescribeDataSet" }, @@ -40778,6 +42301,9 @@ { "target": "com.amazonaws.quicksight#SearchGroups" }, + { + "target": "com.amazonaws.quicksight#SearchTopics" + }, { "target": "com.amazonaws.quicksight#StartAssetBundleExportJob" }, @@ -40832,6 +42358,9 @@ { "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersion" }, + { + "target": "com.amazonaws.quicksight#UpdateDashboardsQAConfiguration" + }, { "target": "com.amazonaws.quicksight#UpdateDataSet" }, @@ -42084,6 +43613,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -44280,6 +45815,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -44506,6 +46047,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -45246,6 +46793,118 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#SearchTopics": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchTopicsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchTopicsResponse" + }, + "errors": [ + { + "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" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for any Q topic that exists in an Amazon QuickSight account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/topics", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TopicSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchTopicsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to find.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#TopicSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters that you want to use to search for the topic.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchTopicsResponse": { + "type": "structure", + "members": { + "TopicSummaryList": { + "target": "com.amazonaws.quicksight#TopicSummaries", + "traits": { + "smithy.api#documentation": "

A list of topic summaries that is returned by the search topic request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#Seasonality": { "type": "integer", "traits": { @@ -45919,6 +47578,12 @@ "traits": { "smithy.api#documentation": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" } + }, + "Images": { + "target": "com.amazonaws.quicksight#SheetImageList", + "traits": { + "smithy.api#documentation": "

A list of images on a sheet.

" + } } }, "traits": { @@ -46138,6 +47803,12 @@ "smithy.api#documentation": "

The text boxes that are on a sheet.

" } }, + "Images": { + "target": "com.amazonaws.quicksight#SheetImageList", + "traits": { + "smithy.api#documentation": "

A list of images on a sheet.

" + } + }, "Layouts": { "target": "com.amazonaws.quicksight#LayoutList", "traits": { @@ -46230,6 +47901,176 @@ } } }, + "com.amazonaws.quicksight#SheetImage": { + "type": "structure", + "members": { + "SheetImageId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the sheet image.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.quicksight#SheetImageSource", + "traits": { + "smithy.api#documentation": "

The source of the image.

", + "smithy.api#required": {} + } + }, + "Scaling": { + "target": "com.amazonaws.quicksight#SheetImageScalingConfiguration", + "traits": { + "smithy.api#documentation": "

Determines how the image is scaled.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#SheetImageTooltipConfiguration", + "traits": { + "smithy.api#documentation": "

The tooltip to be shown when hovering over the image.

" + } + }, + "ImageContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the image.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#ImageInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general image interactions setup for an image.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#ImageCustomActionList", + "traits": { + "smithy.api#documentation": "

A list of custom actions that are configured for an image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An image that is located on a sheet.

" + } + }, + "com.amazonaws.quicksight#SheetImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetImage" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#SheetImageScalingConfiguration": { + "type": "structure", + "members": { + "ScalingType": { + "target": "com.amazonaws.quicksight#SheetImageScalingType", + "traits": { + "smithy.api#documentation": "

The scaling option to use when fitting the image inside the container.

\n

Valid values are defined as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines how the image is scaled

" + } + }, + "com.amazonaws.quicksight#SheetImageScalingType": { + "type": "enum", + "members": { + "SCALE_TO_WIDTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_TO_WIDTH" + } + }, + "SCALE_TO_HEIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_TO_HEIGHT" + } + }, + "SCALE_TO_CONTAINER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_TO_CONTAINER" + } + }, + "SCALE_NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_NONE" + } + } + } + }, + "com.amazonaws.quicksight#SheetImageSource": { + "type": "structure", + "members": { + "SheetImageStaticFileSource": { + "target": "com.amazonaws.quicksight#SheetImageStaticFileSource", + "traits": { + "smithy.api#documentation": "

The source of the static file that contains the image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the image.

" + } + }, + "com.amazonaws.quicksight#SheetImageStaticFileSource": { + "type": "structure", + "members": { + "StaticFileId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the static file that contains the image.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the static file that contains the image.

" + } + }, + "com.amazonaws.quicksight#SheetImageTooltipConfiguration": { + "type": "structure", + "members": { + "TooltipText": { + "target": "com.amazonaws.quicksight#SheetImageTooltipText", + "traits": { + "smithy.api#documentation": "

The text that appears in the tooltip.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the tooltip.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tooltip configuration for a sheet image.

" + } + }, + "com.amazonaws.quicksight#SheetImageTooltipText": { + "type": "structure", + "members": { + "PlainText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The plain text format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The text that appears in the sheet image tooltip.

" + } + }, "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption": { "type": "structure", "members": { @@ -47340,6 +49181,27 @@ "smithy.api#documentation": "

The parameters for Spark.

" } }, + "com.amazonaws.quicksight#SpatialStaticFile": { + "type": "structure", + "members": { + "StaticFileId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the spatial static file.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.quicksight#StaticFileSource", + "traits": { + "smithy.api#documentation": "

The source of the spatial static file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A static file that contains the geospatial data.

" + } + }, "com.amazonaws.quicksight#SpecialValue": { "type": "enum", "members": { @@ -48021,6 +49883,102 @@ "smithy.api#documentation": "

The state perssitence configuration of an embedded dashboard.

" } }, + "com.amazonaws.quicksight#StaticFile": { + "type": "structure", + "members": { + "ImageStaticFile": { + "target": "com.amazonaws.quicksight#ImageStaticFile", + "traits": { + "smithy.api#documentation": "

The image static file.

" + } + }, + "SpatialStaticFile": { + "target": "com.amazonaws.quicksight#SpatialStaticFile", + "traits": { + "smithy.api#documentation": "

The spacial static file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The static file.

" + } + }, + "com.amazonaws.quicksight#StaticFileList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#StaticFile" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#StaticFileS3SourceOptions": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The identifier of the static file in the Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "Region": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Region of the Amazon S3 account that contains the bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure that contains the Amazon S3 location to download the static file from.

" + } + }, + "com.amazonaws.quicksight#StaticFileSource": { + "type": "structure", + "members": { + "UrlOptions": { + "target": "com.amazonaws.quicksight#StaticFileUrlSourceOptions", + "traits": { + "smithy.api#documentation": "

The structure that contains the URL to download the static file from.

" + } + }, + "S3Options": { + "target": "com.amazonaws.quicksight#StaticFileS3SourceOptions", + "traits": { + "smithy.api#documentation": "

The structure that contains the Amazon S3 location to download the static file from.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the static file.

" + } + }, + "com.amazonaws.quicksight#StaticFileUrlSourceOptions": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL to download the static file from.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure that contains the URL to download the static file from.

" + } + }, "com.amazonaws.quicksight#Status": { "type": "enum", "members": { @@ -49275,6 +51233,12 @@ "traits": { "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -49855,6 +51819,12 @@ }, "QueryExecutionOptions": { "target": "com.amazonaws.quicksight#QueryExecutionOptions" + }, + "StaticFiles": { + "target": "com.amazonaws.quicksight#StaticFileList", + "traits": { + "smithy.api#documentation": "

The static files for the definition.

" + } } }, "traits": { @@ -51596,6 +53566,70 @@ "smithy.api#documentation": "

A structure that represents a filter used to select items for a topic.

" } }, + "com.amazonaws.quicksight#TopicFilterAttribute": { + "type": "enum", + "members": { + "QUICKSIGHT_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_USER" + } + }, + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "TOPIC_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOPIC_NAME" + } + } + } + }, + "com.amazonaws.quicksight#TopicFilterOperator": { + "type": "enum", + "members": { + "StringEquals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringEquals" + } + }, + "StringLike": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringLike" + } + } + } + }, "com.amazonaws.quicksight#TopicFilters": { "type": "list", "member": { @@ -52530,6 +54564,47 @@ } } }, + "com.amazonaws.quicksight#TopicSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#TopicFilterOperator", + "traits": { + "smithy.api#documentation": "

The operator like equals or like.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TopicFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the topic search filter.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the topic search filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter that is used to search for a topic.

" + } + }, + "com.amazonaws.quicksight#TopicSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.quicksight#TopicSingularFilterConstant": { "type": "structure", "members": { @@ -53126,6 +55201,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -54933,6 +57014,94 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateDashboardsQAConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardsQAConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardsQAConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a Dashboard QA configuration.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards-qa-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardsQAConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardsQAStatus": { + "target": "com.amazonaws.quicksight#DashboardsQAStatus", + "traits": { + "smithy.api#documentation": "

The status of dashboards QA configuration that you want to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardsQAConfigurationResponse": { + "type": "structure", + "members": { + "DashboardsQAStatus": { + "target": "com.amazonaws.quicksight#DashboardsQAStatus", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the dashboard QA configuration is enabled or not.

" + } + }, + "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#UpdateDataSet": { "type": "operation", "input": { @@ -58818,6 +60987,12 @@ "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" } }, + "LayerMapVisual": { + "target": "com.amazonaws.quicksight#LayerMapVisual", + "traits": { + "smithy.api#documentation": "

The properties for a layer map visual

" + } + }, "FunnelChartVisual": { "target": "com.amazonaws.quicksight#FunnelChartVisual", "traits": { @@ -58889,6 +61064,12 @@ "traits": { "smithy.api#documentation": "

A radar chart visual.

\n

For more information, see Using radar charts in the Amazon QuickSight User Guide.

" } + }, + "PluginVisual": { + "target": "com.amazonaws.quicksight#PluginVisual", + "traits": { + "smithy.api#documentation": "

The custom plugin visual type.

" + } } }, "traits": { @@ -59501,6 +61682,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { @@ -59802,6 +61989,12 @@ "traits": { "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" } + }, + "VisualContentAltText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

The alt text for the visual.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index c6336b5e817..bca2c2aa11f 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -6889,6 +6889,9 @@ "traits": { "smithy.api#documentation": "

A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.

" } + }, + "OverrideVpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" } }, "traits": { @@ -6971,6 +6974,9 @@ "traits": { "smithy.api#documentation": "

A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.

" } + }, + "OverrideVpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" } }, "traits": { @@ -7538,6 +7544,9 @@ "smithy.api#documentation": "

The LifeCycle configuration applied to the instance.

" } }, + "OverrideVpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, "ThreadsPerCore": { "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", "traits": { @@ -11411,9 +11420,7 @@ "VariantName": { "target": "com.amazonaws.sagemaker#VariantName", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of an existing production variant where you host the inference\n component.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of an existing production variant where you host the inference\n component.

" } }, "Specification": { @@ -11427,9 +11434,7 @@ "RuntimeConfig": { "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Runtime settings for a model that is deployed with an inference component.

" } }, "Tags": { @@ -33161,7 +33166,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$" + "smithy.api#pattern": "^(arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+|None)$" } }, "com.amazonaws.sagemaker#ImageVersionNumber": { @@ -33430,7 +33435,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the compute resources to allocate to run a model that you assign to an inference\n component. These resources include CPU cores, accelerators, and memory.

" + "smithy.api#documentation": "

Defines the compute resources to allocate to run a model, plus any adapter models, that\n you assign to an inference component. These resources include CPU cores, accelerators, and\n memory.

" } }, "com.amazonaws.sagemaker#InferenceComponentContainerSpecification": { @@ -33593,9 +33598,13 @@ "ComputeResourceRequirements": { "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The compute resources allocated to run the model assigned \n to the inference component.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.

\n

Omit this parameter if your request is meant to create an adapter inference component.\n An adapter inference component is loaded by a base inference component, and it uses the\n compute resources of the base inference component.

" + } + }, + "BaseInferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#documentation": "

The name of an existing inference component that is to contain the inference component\n that you're creating with your request.

\n

Specify this parameter only if your request is meant to create an adapter inference\n component. An adapter inference component contains the path to an adapter model. The\n purpose of the adapter model is to tailor the inference output of a base foundation model,\n which is hosted by the base inference component. The adapter inference component uses the\n compute resources that you assigned to the base inference component.

\n

When you create an adapter inference component, use the Container parameter\n to specify the location of the adapter artifacts. In the parameter value, use the\n ArtifactUrl parameter of the\n InferenceComponentContainerSpecification data type.

\n

Before you can create an adapter inference component, you must have an existing\n inference component that contains the foundation model that you want to adapt.

" } } }, @@ -33627,7 +33636,13 @@ "ComputeResourceRequirements": { "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", "traits": { - "smithy.api#documentation": "

The compute resources allocated to run the model assigned \n to the inference component.

" + "smithy.api#documentation": "

The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.

" + } + }, + "BaseInferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#documentation": "

The name of the base inference component that contains this inference component.

" } } }, @@ -44480,7 +44495,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1 + "min": 0 } } }, @@ -47598,6 +47613,26 @@ } } }, + "com.amazonaws.sagemaker#ModelShardingConfig": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

" + } + }, + "OverrideEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

Environment variables that override the default ones in the model container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for the model sharding technique that's applied by a model optimization job.

" + } + }, "com.amazonaws.sagemaker#ModelSortKey": { "type": "enum", "members": { @@ -50127,6 +50162,12 @@ "traits": { "smithy.api#documentation": "

Settings for the model compilation technique that's applied by a model optimization job.

" } + }, + "ModelShardingConfig": { + "target": "com.amazonaws.sagemaker#ModelShardingConfig", + "traits": { + "smithy.api#documentation": "

Settings for the model sharding technique that's applied by a model optimization job.

" + } } }, "traits": { @@ -53709,6 +53750,114 @@ "smithy.api#enumValue": "ml.c6i.32xlarge" } }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, "ML_G5_XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -53805,6 +53954,54 @@ "smithy.api#enumValue": "ml.g6.48xlarge" } }, + "ML_G6E_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.xlarge" + } + }, + "ML_G6E_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.2xlarge" + } + }, + "ML_G6E_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.4xlarge" + } + }, + "ML_G6E_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.8xlarge" + } + }, + "ML_G6E_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.12xlarge" + } + }, + "ML_G6E_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.16xlarge" + } + }, + "ML_G6E_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.24xlarge" + } + }, + "ML_G6E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.48xlarge" + } + }, "ML_P4D_24XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -54171,6 +54368,12 @@ "smithy.api#enumValue": "ml.trn1n.32xlarge" } }, + "ML_TRN2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn2.48xlarge" + } + }, "ML_INF2_XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -54201,6 +54404,12 @@ "smithy.api#enumValue": "ml.p5.48xlarge" } }, + "ML_P5E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5e.48xlarge" + } + }, "ML_M7I_LARGE": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk-codegen/aws-models/ses.json b/codegen/sdk-codegen/aws-models/ses.json index 3ab6e7808ef..c570e34d690 100644 --- a/codegen/sdk-codegen/aws-models/ses.json +++ b/codegen/sdk-codegen/aws-models/ses.json @@ -697,6 +697,34 @@ "target": "com.amazonaws.ses#ConfigurationSet" } }, + "com.amazonaws.ses#ConnectAction": { + "type": "structure", + "members": { + "InstanceARN": { + "target": "com.amazonaws.ses#ConnectInstanceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES integrates with for starting\n email contacts.

\n

For more information about Amazon Connect instances, see the Amazon Connect Administrator Guide\n

", + "smithy.api#required": {} + } + }, + "IAMRoleARN": { + "target": "com.amazonaws.ses#IAMRoleARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple Email Service while starting email contacts\n to the Amazon Connect instance. This role should have permission to invoke connect:StartEmailContact\n for the given Amazon Connect instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

When included in a receipt rule, this action parses the received message and\n starts an email contact in Amazon Connect on your behalf.

\n \n

When you receive emails, the maximum email size (including headers) is 40 MB.\n Additionally, emails may only have up to 10 attachments.\n Emails larger than 40 MB or with more than 10 attachments will be bounced.

\n \n

We recommend that you configure this action via Amazon Connect.

" + } + }, + "com.amazonaws.ses#ConnectInstanceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, "com.amazonaws.ses#Content": { "type": "structure", "members": { @@ -3168,7 +3196,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:[\\w-]+:iam::[0-9]+:role/[\\w-]+$" + "smithy.api#pattern": "^arn:[\\w-]+:iam::[0-9]+:role(\\u002F)([\\u0021-\\u007E]+\\u002F)?([\\w+=,.@-]+)$" } }, "com.amazonaws.ses#Identity": { @@ -4608,6 +4636,12 @@ "traits": { "smithy.api#documentation": "

Publishes the email content within a notification to Amazon SNS.

" } + }, + "ConnectAction": { + "target": "com.amazonaws.ses#ConnectAction", + "traits": { + "smithy.api#documentation": "

Parses the received message and starts an email contact in Amazon Connect on your behalf.

" + } } }, "traits": { @@ -5017,13 +5051,13 @@ "KmsKeyArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The customer managed key that Amazon SES should use to encrypt your emails before saving\n them to the Amazon S3 bucket. You can use the default managed key or a custom managed key that\n you created in Amazon Web Services KMS as follows:

\n \n

For more information about key policies, see the Amazon Web Services KMS Developer Guide. If\n you do not specify a managed key, Amazon SES does not encrypt your emails.

\n \n

Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail\n is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side\n encryption. This means that you must use the Amazon S3 encryption client to decrypt the\n email after retrieving it from Amazon S3, as the service has no access to use your\n Amazon Web Services KMS keys for decryption. This encryption client is currently available with\n the Amazon Web Services SDK for Java and\n Amazon Web Services SDK for Ruby only. For\n more information about client-side encryption using Amazon Web Services KMS managed keys, see the\n Amazon S3 Developer Guide.

\n " + "smithy.api#documentation": "

The customer managed key that Amazon SES should use to encrypt your emails before saving\n them to the Amazon S3 bucket. You can use the Amazon Web Services managed key or a customer managed key\n that you created in Amazon Web Services KMS as follows:

\n \n

For more information about key policies, see the Amazon Web Services KMS Developer Guide. If\n you do not specify an Amazon Web Services KMS key, Amazon SES does not encrypt your emails.

\n \n

Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail\n is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side\n encryption. This means that you must use the Amazon S3 encryption client to decrypt the\n email after retrieving it from Amazon S3, as the service has no access to use your\n Amazon Web Services KMS keys for decryption. This encryption client is currently available with\n the Amazon Web Services SDK for Java and\n Amazon Web Services SDK for Ruby only. For\n more information about client-side encryption using Amazon Web Services KMS managed keys, see the\n Amazon S3 Developer Guide.

\n " } }, "IamRoleArn": { "target": "com.amazonaws.ses#IAMRoleARN", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket,\n optionally encrypting your mail via the provided customer managed key, and publishing to\n the Amazon SNS topic.\n This role should have access to the following APIs:\n

\n \n \n

If an IAM role ARN is provided, the role (and only the role) is used to access all\n the given resources (Amazon S3 bucket, Amazon Web Services KMS customer managed key and Amazon SNS topic).\n Therefore, setting up individual resource access permissions is not required.

\n " + "smithy.api#documentation": "

The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket,\n optionally encrypting your mail via the provided customer managed key, and publishing to\n the Amazon SNS topic. This role should have access to the following APIs:

\n \n \n

If an IAM role ARN is provided, the role (and only the role) is used to access all\n the given resources (Amazon S3 bucket, Amazon Web Services KMS customer managed key and Amazon SNS topic).\n Therefore, setting up individual resource access permissions is not required.

\n " } } }, diff --git a/codegen/sdk-codegen/aws-models/sfn.json b/codegen/sdk-codegen/aws-models/sfn.json index 2e3b68aebe6..c3eeebf8a78 100644 --- a/codegen/sdk-codegen/aws-models/sfn.json +++ b/codegen/sdk-codegen/aws-models/sfn.json @@ -1413,6 +1413,30 @@ } } }, + "com.amazonaws.sfn#AssignedVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.sfn#VariableName" + }, + "value": { + "target": "com.amazonaws.sfn#VariableValue" + } + }, + "com.amazonaws.sfn#AssignedVariablesDetails": { + "type": "structure", + "members": { + "truncated": { + "target": "com.amazonaws.sfn#truncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether assigned variables were truncated in the response. Always false\n for API calls. In CloudWatch logs, the value will be true if the data is truncated due to size limits.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about assigned variables in an execution history event.

" + } + }, "com.amazonaws.sfn#BilledDuration": { "type": "long", "traits": { @@ -2643,6 +2667,12 @@ "traits": { "smithy.api#documentation": "

Settings to configure server-side encryption.

" } + }, + "variableReferences": { + "target": "com.amazonaws.sfn#VariableReferences", + "traits": { + "smithy.api#documentation": "

A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.

" + } } }, "traits": { @@ -2753,6 +2783,12 @@ "traits": { "smithy.api#documentation": "

Settings to configure server-side encryption.

" } + }, + "variableReferences": { + "target": "com.amazonaws.sfn#VariableReferences", + "traits": { + "smithy.api#documentation": "

A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.

" + } } }, "traits": { @@ -2812,6 +2848,49 @@ "com.amazonaws.sfn#ErrorMessage": { "type": "string" }, + "com.amazonaws.sfn#EvaluationFailedEventDetails": { + "type": "structure", + "members": { + "error": { + "target": "com.amazonaws.sfn#SensitiveError", + "traits": { + "smithy.api#documentation": "

The error code of the failure.

" + } + }, + "cause": { + "target": "com.amazonaws.sfn#SensitiveCause", + "traits": { + "smithy.api#documentation": "

A more detailed explanation of the cause of the failure.

" + } + }, + "location": { + "target": "com.amazonaws.sfn#EvaluationFailureLocation", + "traits": { + "smithy.api#documentation": "

The location of the field in the state in which the evaluation error occurred.

" + } + }, + "state": { + "target": "com.amazonaws.sfn#StateName", + "traits": { + "smithy.api#documentation": "

The name of the state in which the evaluation error occurred.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about an evaluation failure that occurred while processing a state, for example, when a JSONata expression throws an error. This event will only be present in state machines that have QueryLanguage set to JSONata, or individual states set to JSONata.

" + } + }, + "com.amazonaws.sfn#EvaluationFailureLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.sfn#EventId": { "type": "long", "traits": { @@ -3561,6 +3640,12 @@ "traits": { "smithy.api#documentation": "

Contains details about the redrive attempt of a Map Run.

" } + }, + "evaluationFailedEventDetails": { + "target": "com.amazonaws.sfn#EvaluationFailedEventDetails", + "traits": { + "smithy.api#documentation": "

Contains details about an evaluation failure that occurred while processing a state.

" + } } }, "traits": { @@ -3574,7 +3659,7 @@ "target": "com.amazonaws.sfn#truncated", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether input or output was truncated in the response. Always false\n for API calls.

" + "smithy.api#documentation": "

Indicates whether input or output was truncated in the response. Always false\n for API calls. In CloudWatch logs, the value will be true if the data is truncated due to size limits.

" } } }, @@ -3959,6 +4044,12 @@ "traits": { "smithy.api#enumValue": "MapRunRedriven" } + }, + "EvaluationFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EvaluationFailed" + } } } }, @@ -4006,16 +4097,22 @@ "smithy.api#documentation": "

The raw state input.

" } }, + "afterArguments": { + "target": "com.amazonaws.sfn#SensitiveData", + "traits": { + "smithy.api#documentation": "

The input after Step Functions applies an Arguments filter. This event will only be present when QueryLanguage for the state machine or individual states is set to JSONata. For more info, see Transforming data with Step Functions.

" + } + }, "afterInputPath": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

The input after Step Functions applies the InputPath filter.

" + "smithy.api#documentation": "

The input after Step Functions applies the InputPath filter. Not populated when QueryLanguage is JSONata.

" } }, "afterParameters": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

The effective input after Step Functions applies the Parameters filter.

" + "smithy.api#documentation": "

The effective input after Step Functions applies the Parameters filter. Not populated when QueryLanguage is JSONata.

" } }, "result": { @@ -4027,13 +4124,13 @@ "afterResultSelector": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

The effective result after Step Functions applies the ResultSelector filter.

" + "smithy.api#documentation": "

The effective result after Step Functions applies the ResultSelector filter. Not populated when QueryLanguage is JSONata.

" } }, "afterResultPath": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

The effective result combined with the raw state input after Step Functions applies the ResultPath filter.

" + "smithy.api#documentation": "

The effective result combined with the raw state input after Step Functions applies the ResultPath filter. Not populated when QueryLanguage is JSONata.

" } }, "request": { @@ -4047,6 +4144,12 @@ "traits": { "smithy.api#documentation": "

The raw HTTP response that is returned when you test an HTTP Task.

" } + }, + "variables": { + "target": "com.amazonaws.sfn#SensitiveData", + "traits": { + "smithy.api#documentation": "

JSON string that contains the set of workflow variables after execution of the state. The set will include variables assigned in the state and variables set up as test state input.

" + } } }, "traits": { @@ -6279,6 +6382,18 @@ "traits": { "smithy.api#documentation": "

Contains details about the output of an execution history event.

" } + }, + "assignedVariables": { + "target": "com.amazonaws.sfn#AssignedVariables", + "traits": { + "smithy.api#documentation": "

Map of variable name and value as a serialized JSON representation.

" + } + }, + "assignedVariablesDetails": { + "target": "com.amazonaws.sfn#AssignedVariablesDetails", + "traits": { + "smithy.api#documentation": "

Provides details about input or output in an execution history event.

" + } } }, "traits": { @@ -7085,8 +7200,7 @@ "roleArn": { "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

" } }, "input": { @@ -7107,6 +7221,12 @@ "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.

\n

If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.

\n

By default, revealSecrets is set to false.

" } + }, + "variables": { + "target": "com.amazonaws.sfn#SensitiveData", + "traits": { + "smithy.api#documentation": "

JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.

" + } } }, "traits": { @@ -7586,11 +7706,14 @@ } ], "traits": { - "smithy.api#documentation": "

Validates the syntax of a state machine definition.

\n

You can validate that a state machine definition is correct without \n creating a state machine resource. Step Functions will implicitly perform the same\n syntax check when you invoke CreateStateMachine and\n UpdateStateMachine. State machine definitions are specified using a\n JSON-based, structured language. For more information on Amazon States Language see Amazon States Language (ASL).

\n

Suggested uses for ValidateStateMachineDefinition:

\n \n \n

Errors found in the state machine definition will be returned in the response as a list of diagnostic elements, rather than raise an exception.

\n " + "smithy.api#documentation": "

Validates the syntax of a state machine definition specified in Amazon States Language (ASL), a\n JSON-based, structured language.

\n

You can validate that a state machine definition is correct without creating a state\n machine resource.

\n

Suggested uses for ValidateStateMachineDefinition:

\n \n

Validation will look for problems in your state machine definition and return a\n result and a list of diagnostic\n elements.

\n

The result value will be OK when your\n workflow definition can be successfully created or updated. Note the result can be\n OK even when diagnostic warnings are present in the response. The\n result value will be FAIL when the\n workflow definition contains errors that would prevent you from creating or updating\n your state machine.

\n

The list of ValidateStateMachineDefinitionDiagnostic data elements can contain zero or more WARNING and/or ERROR elements.

\n \n

The ValidateStateMachineDefinition API might add\n new diagnostics in the future, adjust diagnostic codes, or change the message\n wording. Your automated processes should only rely on the value of the result field value (OK, FAIL). Do not rely on the exact order, count, or\n wording of diagnostic messages.

\n " } }, "com.amazonaws.sfn#ValidateStateMachineDefinitionCode": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, "com.amazonaws.sfn#ValidateStateMachineDefinitionDiagnostic": { "type": "structure", @@ -7598,7 +7721,7 @@ "severity": { "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionSeverity", "traits": { - "smithy.api#documentation": "

A value of ERROR means that you cannot create or update a state machine with this definition.

", + "smithy.api#documentation": "

A value of ERROR means that you cannot create or update a state machine with this definition.

\n

\n WARNING level diagnostics alert you to potential issues, but they will not prevent you from creating or updating your state machine.

", "smithy.api#required": {} } }, @@ -7624,7 +7747,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an error found during validation. Validation errors found in the definition\n return in the response as diagnostic elements, rather\n than raise an exception.

" + "smithy.api#documentation": "

Describes potential issues found during state machine validation. Rather than raise an\n exception, validation will return a list of diagnostic\n elements containing diagnostic information.

\n \n

The ValidateStateMachineDefinitionlAPI might add\n new diagnostics in the future, adjust diagnostic codes, or change the message\n wording. Your automated processes should only rely on the value of the result field value (OK, FAIL). Do not rely on the exact order, count, or\n wording of diagnostic messages.

\n \n

\n List of warning codes\n

\n
\n
NO_DOLLAR
\n
\n

No .$ on a field that appears to be a JSONPath or Intrinsic Function.

\n
\n
NO_PATH
\n
\n

Field value looks like a path, but field name does not end with 'Path'.

\n
\n
PASS_RESULT_IS_STATIC
\n
\n

Attempt to use a path in the result of a pass state.

\n
\n
\n

\n List of error codes\n

\n
\n
INVALID_JSON_DESCRIPTION
\n
\n

JSON syntax problem found.

\n
\n
MISSING_DESCRIPTION
\n
\n

Received a null or empty workflow input.

\n
\n
SCHEMA_VALIDATION_FAILED
\n
\n

Schema validation reported errors.

\n
\n
INVALID_RESOURCE
\n
\n

The value of a Task-state resource field is invalid.

\n
\n
MISSING_END_STATE
\n
\n

The workflow does not have a terminal state.

\n
\n
DUPLICATE_STATE_NAME
\n
\n

The same state name appears more than once.

\n
\n
INVALID_STATE_NAME
\n
\n

The state name does not follow the naming convention.

\n
\n
STATE_MACHINE_NAME_EMPTY
\n
\n

The state machine name has not been specified.

\n
\n
STATE_MACHINE_NAME_INVALID
\n
\n

The state machine name does not follow the naming convention.

\n
\n
STATE_MACHINE_NAME_TOO_LONG
\n
\n

The state name exceeds the allowed length.

\n
\n
STATE_MACHINE_NAME_ALREADY_EXISTS
\n
\n

The state name already exists.

\n
\n
DUPLICATE_LABEL_NAME
\n
\n

A label name appears more than once.

\n
\n
INVALID_LABEL_NAME
\n
\n

You have provided an invalid label name.

\n
\n
MISSING_TRANSITION_TARGET
\n
\n

The value of \"Next\" field doesn't match a known state name.

\n
\n
TOO_DEEPLY_NESTED
\n
\n

The states are too deeply nested.

\n
\n
" } }, "com.amazonaws.sfn#ValidateStateMachineDefinitionDiagnosticList": { @@ -7668,7 +7791,10 @@ } }, "com.amazonaws.sfn#ValidateStateMachineDefinitionLocation": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, "com.amazonaws.sfn#ValidateStateMachineDefinitionMaxResult": { "type": "integer", @@ -7681,7 +7807,10 @@ } }, "com.amazonaws.sfn#ValidateStateMachineDefinitionMessage": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, "com.amazonaws.sfn#ValidateStateMachineDefinitionOutput": { "type": "structure", @@ -7696,7 +7825,7 @@ "diagnostics": { "target": "com.amazonaws.sfn#ValidateStateMachineDefinitionDiagnosticList", "traits": { - "smithy.api#documentation": "

If the result is OK, this field will be empty. When there are errors,\n this field will contain an array of Diagnostic objects\n to help you troubleshoot.

", + "smithy.api#documentation": "

An array of diagnostic errors and warnings found during validation of the state machine definition. Since warnings do not prevent deploying your workflow definition, the result value could be OK even when warning diagnostics are present in the response.

", "smithy.api#required": {} } }, @@ -7796,6 +7925,36 @@ } } }, + "com.amazonaws.sfn#VariableName": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sfn#VariableNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.sfn#VariableName" + } + }, + "com.amazonaws.sfn#VariableReferences": { + "type": "map", + "key": { + "target": "com.amazonaws.sfn#StateName" + }, + "value": { + "target": "com.amazonaws.sfn#VariableNameList" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sfn#VariableValue": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.sfn#VersionDescription": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/sns.json b/codegen/sdk-codegen/aws-models/sns.json index 8d7701b2510..7ee31650084 100644 --- a/codegen/sdk-codegen/aws-models/sns.json +++ b/codegen/sdk-codegen/aws-models/sns.json @@ -1571,7 +1571,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.

\n

\n PlatformPrincipal and PlatformCredential are received from\n the notification service.

\n \n

You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.

" + "smithy.api#documentation": "

Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.

\n

\n PlatformPrincipal and PlatformCredential are received from\n the notification service.

\n \n

You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.

" } }, "com.amazonaws.sns#CreatePlatformApplicationInput": { @@ -1794,7 +1794,7 @@ "Attributes": { "target": "com.amazonaws.sns#TopicAttributesMap", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists names, descriptions, and values of the special request\n parameters that the CreateTopic action uses:

\n \n

The following attribute applies only to server-side\n encryption:

\n \n

The following attributes apply only to FIFO topics:

\n " + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists names, descriptions, and values of the special request parameters\n that the CreateTopic action uses:

\n \n

The following attribute applies only to server-side\n encryption:

\n \n

The following attributes apply only to FIFO topics:

\n " } }, "Tags": { @@ -2480,7 +2480,7 @@ "Attributes": { "target": "com.amazonaws.sns#TopicAttributesMap", "traits": { - "smithy.api#documentation": "

A map of the topic's attributes. Attributes in this map include the following:

\n \n

The following attribute applies only to server-side-encryption:

\n \n

The following attributes apply only to FIFO topics:

\n " + "smithy.api#documentation": "

A map of the topic's attributes. Attributes in this map include the following:

\n \n

The following attribute applies only to server-side-encryption:

\n \n

The following attributes apply only to FIFO topics:

\n " } } }, @@ -4561,7 +4561,7 @@ "AttributeName": { "target": "com.amazonaws.sns#attributeName", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetTopicAttributes action uses:

\n \n \n

The SuccessFeedbackRoleArn and FailureFeedbackRoleArn\n attributes are used to give Amazon SNS write access to use CloudWatch Logs on your\n behalf. The SuccessFeedbackSampleRate attribute is for specifying the\n sample rate percentage (0-100) of successfully delivered messages. After you\n configure the FailureFeedbackRoleArn attribute, then all failed message\n deliveries generate CloudWatch Logs.

\n \n

The following attribute applies only to server-side-encryption:

\n \n

The following attribute applies only to FIFO topics:

\n ", + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetTopicAttributes action uses:

\n \n \n

The SuccessFeedbackRoleArn and FailureFeedbackRoleArn\n attributes are used to give Amazon SNS write access to use CloudWatch Logs on your\n behalf. The SuccessFeedbackSampleRate attribute is for specifying the\n sample rate percentage (0-100) of successfully delivered messages. After you\n configure the FailureFeedbackRoleArn attribute, then all failed message\n deliveries generate CloudWatch Logs.

\n \n

The following attribute applies only to server-side-encryption:

\n \n

The following attribute applies only to FIFO topics:

\n ", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json index f7043d97c0c..bc58c84cf02 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.json +++ b/codegen/sdk-codegen/aws-models/workspaces.json @@ -5996,7 +5996,7 @@ "IngestionProcess": { "target": "com.amazonaws.workspaces#WorkspaceImageIngestionProcess", "traits": { - "smithy.api#documentation": "

The ingestion process to be used when importing the image, depending on which protocol\n you want to use for your BYOL Workspace image, either PCoIP, DCV, or \n bring your own protocol (BYOP). To use WSP, specify a value that ends in \n _DCV. To use PCoIP, specify a value that does not end in _DCV. \n To use BYOP, specify a value that ends in _BYOP.

\n

For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify \n BYOL_REGULAR, BYOL_REGULAR_DCV, or BYOL_REGULAR_BYOP, \n depending on the protocol.

\n \n

The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values\n are only supported by Amazon WorkSpaces Core. Contact your account team to be\n allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

\n ", + "smithy.api#documentation": "

The ingestion process to be used when importing the image, depending on which protocol\n you want to use for your BYOL Workspace image, either PCoIP, WSP, or \n bring your own protocol (BYOP). To use DCV, specify a value that ends in \n _WSP. To use PCoIP, specify a value that does not end in _WSP. \n To use BYOP, specify a value that ends in _BYOP.

\n

For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify \n BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, \n depending on the protocol.

\n \n

The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values\n are only supported by Amazon WorkSpaces Core. Contact your account team to be\n allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

\n ", "smithy.api#required": {} } },